1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
修改边缘计算集群名称等属性
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateTKEEdgeCluster。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore 。 |
ClusterId | 是 | String | 边缘计算集群ID 示例值:cls-abcd1234 |
ClusterName | 否 | String | 边缘计算集群名称 示例值:test_cluster1 |
ClusterDesc | 否 | String | 边缘计算集群描述信息 示例值:my_test_cluster888 |
PodCIDR | 否 | String | 边缘计算集群的pod cidr 示例值:1.2.3.4 |
ServiceCIDR | 否 | String | 边缘计算集群的service cidr 示例值:1.2.3.4 |
PublicLB | 否 | EdgeClusterPublicLB | 边缘计算集群公网访问LB信息 |
InternalLB | 否 | EdgeClusterInternalLB | 边缘计算集群内网访问LB信息 |
CoreDns | 否 | String | 边缘计算集群的CoreDns部署信息 示例值:yes |
HealthRegion | 否 | String | 边缘计算集群的健康检查多地域部署信息 示例值:yes |
Health | 否 | String | 边缘计算集群的健康检查部署信息 示例值:yes |
GridDaemon | 否 | String | 边缘计算集群的GridDaemon部署信息 示例值:yes |
AutoUpgradeClusterLevel | 否 | Boolean | 边缘集群开启自动升配 示例值:false |
ClusterLevel | 否 | String | 边缘集群的集群规模 示例值:L5 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改边缘计算集群
修改边缘计算集群
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateTKEEdgeCluster
<公共请求参数>
{
"ClusterName": "test_cluster1",
"ClusterDesc": "my_test_cluster888",
"ClusterId": "cls-xxxxxx"
}
输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.CamNoAuth | 没有权限。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |