1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
更新集群组
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateClusterGroup。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Id | 是 | String | 集群组 ID(定位要更新的集群组) 示例值:rayclustergroup-h5l7xk-cw8w |
| Name | 否 | String | 集群组名称(可选,为空则保持原名) 示例值:生产环境集群组 |
| Description | 否 | String | 集群组描述 示例值:用于生产环境的集群组 |
| Config | 否 | String | 集群组配置 示例值:config-content |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 集群组 ID 示例值:rayclustergroup-h5l7xk-cw8w |
| Name | String | 集群组名称 示例值:生产环境集群组 |
| Description | String | 集群组描述 示例值:用于生产环境的集群组 |
| Config | String | 集群组配置 示例值:config-content |
| AppId | Integer | 应用 ID(多租户) 示例值:260090589 |
| Uin | String | 创建者主账号 UIN 示例值:700002467852 |
| SubAccountUin | String | 创建者子账号 UIN 示例值:700002467852 |
| CreateTime | Integer | 创建时间 示例值:1774256065032 |
| UpdateTime | Integer | 更新时间 示例值:1774256065032 |
| Deleted | Boolean | 是否已软删除 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
| DeleteTime | Integer | 删除时间(软删时写入,活跃记录为 null) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新集群组
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateClusterGroup
<公共请求参数>
{
"Id": "rayclustergroup-h5l7xk-cw8w",
"Description": "更新后的描述",
"Config": "config-content"
}
输出示例
{
"Response": {
"Id": "rayclustergroup-h5l7xk-cw8w",
"Name": "生产环境集群组",
"Description": "更新后的描述",
"Config": "config-content",
"AppId": 260090589,
"Uin": "700002467852",
"SubAccountUin": "700002467852",
"CreateTime": 1774256065032,
"UpdateTime": 1774256065032,
"Deleted": false,
"RequestId": "dffa8e31-2df1-4f61-9e88-df82ec7d7ae8"
}
}
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.OtherException | 其他异常:服务遇到未知问题,请稍后再试。 |