跳转到主要内容
API Explorer|API Explorer
计算管理/集群相关接口
PUTCluster Related Interfaces起始版本 0.6同步需要认证

更新集群

更新集群

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • uuidString必填

    资源的UUID，唯一标示该资源

请求体字段

  • updateclusterObject必填

    updatecluster 请求体结构

    • nameString

      资源名称

    • descriptionString

      资源的详细描述

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryClusterInventory必填

    详情参考inventory

    • nameString必填

      资源名称

    • uuidString必填

      资源的UUID，唯一标示该资源

    • descriptionString必填

      资源的详细描述

    • stateString必填

      集群状态

    • hypervisorTypeString必填

      虚拟机管理程序类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • zoneUuidString必填

      数据中心UUID

    • typeString必填

      保留域

请求地址

PUT/zstack/v1/clusters/{uuid}/actions

/zstack/v1/clusters/{uuid}/actions

操作 ID

UpdateCluster

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/clusters/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updatecluster":{"name":"<name>","description":"<description>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "name": "cluster1", "uuid": "9dd0fbecb0e04260ad161c66d1da9f96", "description": "test", "state": "Enabled", "hypervisorType": "KVM", "createDate": "Jun 7, 2017 9:20:29 PM", "lastOpDate": "Jun 7, 2017 9:20:29 PM", "zoneUuid": "25b7ddce968f4cbbb58aa5a205e116ee", "type": "zstack" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史