1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
修改弹性集群名称等属性
默认接口请求频率限制:50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateEKSCluster。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 弹性集群Id 示例值:cls-xxxxxxxx |
ClusterName | 否 | String | 弹性集群名称 示例值:xxxx |
ClusterDesc | 否 | String | 弹性集群描述信息 示例值:xxxx |
SubnetIds.N | 否 | Array of String | 子网Id 列表 示例值:[subnet-xxxx] |
PublicLB | 否 | ClusterPublicLB | 弹性容器集群公网访问LB信息 示例值:{} |
InternalLB | 否 | ClusterInternalLB | 弹性容器集群内网访问LB信息 示例值:{} |
ServiceSubnetId | 否 | String | Service 子网Id 示例值:subnet-xxxx |
DnsServers.N | 否 | Array of DnsServerConf | 集群自定义的dns 服务器信息 示例值:{} |
ClearDnsServer | 否 | String | 是否清空自定义dns 服务器设置。为1 表示 是。其他表示 否。 示例值:1 |
NeedDeleteCbs | 否 | Boolean | 将来删除集群时是否要删除cbs。默认为 FALSE 示例值:false |
ProxyLB | 否 | Boolean | 标记是否是新的内外网。默认为false 示例值:false |
ExtraParam | 否 | String | 扩展参数。须是map[string]string 的json 格式。 示例值:{aa} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改弹性集群
修改弹性集群
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateEKSCluster
<公共请求参数>
{
"ServiceSubnetId": "subnet-xxxx",
"ClusterName": "test_cluster1",
"SubnetIds": [
"subnet-xxxx"
],
"ClusterId": "cls-xxxxxx",
"DnsServers": [
{
"Domain": "exam.com",
"DnsServers": [
"10.2.2.88:53"
]
}
],
"ClusterDesc": "my_test_cluster888"
}
输出示例
{
"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 | 未授权操作。 |
UnauthorizedOperation.CamNoAuth | 无该接口CAM权限。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |