文档首页/ 华为云UCS/ API参考/ API/ UCS集群/ 更新集群 - UpdateCluster
更新时间:2025-12-22 GMT+08:00
分享

更新集群 - UpdateCluster

功能介绍

更新集群。当前仅允许更新附着集群和本地集群的国家/城市。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

PUT /v1/clusters/{clusterid}

表1 路径参数

参数

是否必选

参数类型

描述

clusterid

String

集群ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

身份认证信息,调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值

Content-Type

String

消息体的类型(格式)

表3 请求Body参数

参数

是否必选

参数类型

描述

kind

String

API类型,固定值“Cluster”,该值不可修改。

apiVersion

String

API版本,固定值“v1”,该值不可修改。

metadata

UpdateObjectMeta object

集群的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。

spec

UpdateClusterSpec object

spec是集合类的元素类型,您对需要管理的集群对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。

表4 UpdateObjectMeta

参数

是否必选

参数类型

描述

annotations

Object

集群标注

表5 UpdateClusterSpec

参数

是否必选

参数类型

描述

country

String

集群所在国家信息

city

String

集群所在城市信息

响应参数

状态码:200

集群信息更新成功

状态码:400

表6 响应Body参数

参数

参数类型

描述

-

String

-

状态码:403

表7 响应Body参数

参数

参数类型

描述

-

String

-

状态码:500

表8 响应Body参数

参数

参数类型

描述

-

String

-

请求示例

更新集群区域

PUT https://ucs.myhuaweicloud.com/v1/clusters/{clusterid}

{
  "kind" : "Cluster",
  "apiVersion" : "v1",
  "metadata" : {
    "annotations" : {
      "kubeconfig" : "{\"kind\":\"Config\",\"apiVersion\":\"v1\",\"preferences\":{},\"clusters\":[{\"name\":\"internalCluster\",\"cluster\":{\"server\":\"https://ip:5443\",\"insecure-skip-tls-verify\":true}}],\"users\":[{\"name\":\"user\",\"user\":{\"client-certificate-data\":\"\",\"client-key-data\":\"\"}}],\"contexts\":[{\"name\":\"internal\",\"context\":{\"cluster\":\"internalCluster\",\"user\":\"user\"}}],\"current-context\":\"internal\"}"
    }
  },
  "spec" : {
    "country" : "AL",
    "city" : "AL"
  }
}

响应示例

状态码:200

集群信息更新成功

{ }

状态码

状态码

描述

200

集群信息更新成功

400

客户端请求错误,服务器无法执行请求

403

服务器拒绝执行请求

500

服务器内部错误

错误码

请参见错误码

相关文档