1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
案例列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListExamples。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Category | 否 | String | 分类 示例值:data-processing |
| Keyword | 否 | String | 关键词 示例值:批量 |
| Tags.N | 否 | Array of String | 标签数组,多个标签 AND 关系;与 Category/Keyword 之间也是 AND 示例值:["ETL"] |
| OrderBy | 否 | String | DEFAULT(sort_order ASC, create_time DESC)/ POPULARITY(按热度降序),非法值降级为 DEFAULT 示例值:Popularity |
| Page | 否 | Integer | 当前页码(从1开始) 示例值:1 |
| PageSize | 否 | Integer | 页数 示例值:2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总记录数 示例值:1 |
| Page | Integer | 当前页码(从1开始) 示例值:1 |
| PageSize | Integer | 页数 示例值:2 |
| TotalPages | Integer | 总页数 示例值:1 |
| Items | Array of ExampleEntity | 案例管理列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 ListExamples
分页查询案例列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListExamples
<公共请求参数>
{
"Category": "data-processing",
"Keyword": "批量",
"Tags": [
"ETL"
],
"OrderBy": "Popularity",
"Page": 1,
"PageSize": 2
}
输出示例
{
"Response": {
"Items": [
{
"Category": "data-processing",
"CodeArchiveUrl": "https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/models/examples/example-005-raydp-raydata.zip",
"CreateTime": 1779764566348,
"Deleted": 0,
"Description": "使用 RayDP (Spark on Ray) 进行分布式数据预处理,再通过 Ray Data 进行分布式批量推理,构建端到端 ML 流水线",
"Difficulty": "advanced",
"EstimatedTime": 25,
"ExampleId": "example-005-raydp-raydata",
"Id": 9,
"Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-extra",
"IsEnabled": true,
"LabImage": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-extra-lab",
"Popularity": 3,
"ResourceConfig": "{\"Head\":{\"Name\":\"default-head\",\"PodCpu\":2,\"PodMem\":4,\"PodNum\":1},\"Worker\":[{\"Name\":\"default-worker\",\"PodCpu\":2,\"PodMem\":4,\"MinPodNum\":1,\"MaxPodNum\":1}]}",
"SortOrder": 5,
"Tags": [
"RayDP"
],
"Title": "RayDP + Ray Data: Spark ETL 到分布式批量推理",
"UpdateTime": 1779764566348
}
],
"Page": 1,
"PageSize": 2,
"Total": 1,
"TotalPages": 1,
"RequestId": "d5e4e25a-7505-42a5-85dc-a8d9b2f30e40"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.Example | 案例服务请求失败 |