最近更新时间:2024.02.26 20:17:36
首次发布时间:2022.06.27 21:21:32
更新指定容器服务集群的配置信息。
此接口为异步接口,当此接口返回成功时,此时集群实例将进入{Updating, [Progressing]}
状态。待所有更新执行成功,最终进入{Running, [Ok]}
。请调用 ListClusters 接口获取该集群当前的状态及其说明。
调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateClusterConfig | 公共参数,本接口值:UpdateClusterConfig。 |
Version | String | 是 | 2022-05-12 | 公共参数,本接口值:2022-05-12。 |
ClientToken | String | 否 | BC028527-33B9-4990-A633-84E9F9****** | 用于保证请求幂等性的字符串。该字符串由调用方传入,需保证不同请求之间唯一。ClientToken 对大小写敏感,且最大值不超过 64 个 ASCII 字符。 |
Id | String | 是 | cc8oo0ivqtofnisb7**** | 待更新集群的 ID。 可以调用 ListClusters 接口,获取集群 ID。 注意 待更新的集群必须处于 |
Name | String | 否 | cluster | 集群名称。
|
Description | String | 否 | A Kubernetes Cluster Managed by VKE | 集群描述,长度限制为 300 个字符以内。 |
DeleteProtectionEnabled | Boolean | 否 | false | 集群删除保护,取值:
|
ClusterConfig | Object ClusterConfigUpdateRequest | 否 | 集群控制面及节点的网络配置。 | |
PodsConfig | Object PodsConfigRequest | 是 | 集群的容器(Pod)网络配置。 | |
LoggingConfig | Object ClusterLoggingConfigRequet | 否 | 集群的日志配置信息。 |
参数名 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
SubnetIds | Array of String | 是 | ["subnet-5g39dwxvppo******"] | 集群控制面在私有网络(VPC)内通信的子网 ID。 注意
|
ApiServerPublicAccessEnabled | Boolean | 否 | true | 集群 API Server 公网访问配置,取值:
|
ApiServerPublicAccessConfig | Object PublicAccessConfigRequest | 否 | 集群 API Server 公网访问配置信息。 |
参数名 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
VpcCniConfig | Object VpcCniConfigUpdateRequest | 否 | VPC-CNI 网络配置。 |
参数名 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
SubnetIds | Array of String | 否 | ["subnet-5g39dwxvp******","subnet-5g39dwxvp******"] | VPC-CNI 容器网络模型对应的 Pod 子网 ID 列表。 注意 更新集群时,仅支持在当前集群原有 Pod 子网基础上增加 Pod 子网。 |
POST /?Action=UpdateClusterConfig&Version=2022-05-12 HTTP/1.1 Content-Type:application/json { "Id": "cc8oo0ivqtofnisb7****", "DeleteProtectionEnabled": true, "PodsConfig": { "VpcCniConfig": { "SubnetIds": ["subnet-****1", "subnet-****2"] } }, "LoggingConfig": { "LogSetups": [ { "LogType": "Audit", "LogTtl": 30, "Enabled": true } ] } }
本接口无专有返回参数,公共返回参数请参见 返回结果。
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "021635330810134****", "Action": "UpdateClusterConfig", "Version": "2022-05-12", "Service": "vke", "Region": "cn-beijing" }, "Result": {} }
本接口错误码如下表所示,公共错误码请参见 公共错误码。
HTTP状态码 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationDenied.ClusterStatus | The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}]. | 指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。 |
400 | VpcMismatch.{{parameter}} | The specified {{resourceType}} {{resourceId}} is not in the same VPC. | 指定的资源不属于同一个 VPC,例如 SubnetIds。请更新参数值后重试。 |
400 | UpdateNotAllowed.{{Parameter}} | The update to the specified parameter {{parameter}} is not allowed due to {{reason}}. | 指定的参数不允许更新,例如 vpc-cni 组件状态异常或版本较低时不支持更新 SubnetIds。可调用 ListAddons 接口,查看组件状态。 |
400 | NotSupported.{{parameter}} | The specified {{resourceType}} {{resourceContent}} is not supported. | 不支持指定的资源,例如容器服务不支持 SubnetIds 指定的子网所在可用区。请更新参数值后重试。 |
400 | QuotaExceeded.{{ResourceType}} | The quota of {{ResourceType}} has reached the limit. | 指定资源的配额达到上限,如 EIP、LogProject、LogTopic 等。请提升相关资源配额,或删除无用资源,预留出配额后重试。 |
400 | Insufficient.SubnetIp | The IP of subnet {{subnetId}} is insufficient. | 指定的子网可用 IP 数量不足。请指定符合要求的子网后重试。 |
400 | LimitExceeded.ClusterSubnetZones | You have reached the limit of the number of cluster subnet zones that you can add. | 集群子网可用区个数超过限制。请确保子网可用区不超过 3 个。 |
400 | LimitExceeded.ClusterSubnetsOfZone | LimitExceeded.ClusterSubnetsOfZone | 单个可用区下已指定的子网个数超过限制。请确保每个可用区下已指定的子网数不超过 2 个。 |
409 | Conflict.Name | The specified name conflicts with existing {{resourceType}}. | 指定地域存在同名集群,请更换集群名称再尝试。 |