1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
列出所有集群
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListRayClusters。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| StartTime | 否 | Integer | 起始时间(毫秒时间戳) 示例值:1780300625405 |
| EndTime | 否 | Integer | 截止时间(毫秒时间戳) 示例值:1780300625405 |
| Page | 否 | Integer | 当前页码(从1开始) 示例值:1 |
| PageSize | 否 | Integer | 每页数量 示例值:100 |
| Filters.N | 否 | Array of Filter | 过滤条件列表 |
| SortFields.N | 否 | Array of SortField | 排序字段列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总记录数 示例值:61 |
| Page | Integer | 当前页码(从1开始) 示例值:1 |
| PageSize | Integer | 每页数量 示例值:200 |
| TotalPages | Integer | 总页数 示例值:1 |
| Items | Array of RayClusterEntity | Ray cluster列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRayClusters
<公共请求参数>
{}
输出示例
{
"Response": {
"Items": [
{
"AppId": 260200065,
"Catalog": "{\"CFSVolumes\":[],\"CFSTurboVolumes\":[],\"COSVolumes\":[],\"GooseFSVolumes\":null,\"autoscalerEnabled\":false,\"autoscalerOptions\":{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"medium\",\"resources\":{\"cpu\":\"1\",\"memory\":\"2Gi\"}},\"VolumeMounts\":[]}",
"CreateTime": 1780408225483,
"GroupId": "rayclustergroup-tfsceo-s2fb",
"GroupName": "qzzhu_group",
"HistoryUrl": "https://test-tcray-historyserver-guangzhou.cloud.tencent.com/history/dlc-p-bleurqnv/raycluster-20260602215025-qnq9/",
"Id": "raycluster-20260602215025-qnq9",
"ImagePullPolicy": "Always",
"Name": "aidanyxu",
"Priority": 5,
"Queue": "default",
"ResourceConfig": "{\"Head\":{\"Name\":\"default-head\",\"PodCpu\":1,\"PodMem\":2,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourcesLabels\":[],\"Tolerations\":null,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null,\"BillingItem\":null,\"VideoMemory\":null,\"PodNum\":1,\"HighAvailability\":null},\"Worker\":[{\"Name\":\"default-worker\",\"PodCpu\":1,\"PodMem\":2,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourcesLabels\":[],\"Tolerations\":null,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null,\"BillingItem\":null,\"VideoMemory\":null,\"MinPodNum\":1,\"MaxPodNum\":1}]}",
"ResourcePartitionId": "dlc-p-bleurqnv",
"StartTime": 1780408233001,
"Status": "FAILED",
"StatusMessage": "K8s CR not found: Cluster not found in K8s",
"SubAccountUin": "700002655693",
"Tags": [
{
"TagKey": "dlc_test",
"TagValue": "pro"
}
],
"Type": "RAY_CLUSTER",
"Uin": "700002655693"
}
],
"Page": 1,
"PageSize": 200,
"Total": 61,
"TotalPages": 1,
"RequestId": "76c5c43c-143a-4a2b-a31c-93058d990993"
}
}
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.ExternalService | 外部服务异常 |