跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/云主机相关接口
PUTVM Instance Operations起始版本 4.6.0同步需要认证

更新分组目录

更新分组目录

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体parameter对象。

    • uuidString必填

      资源UUID。

    • nameString必填

      资源名称。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVmNicInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • groupNameString必填

      所属分组

    • parentUuidString必填

      父级目录UUID

    • rootDirectoryUuidString必填

      根目录UUID

    • zoneUuidString必填

      区域UUID

    • typeString必填

      目录类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

PUT/zstack/v1/update/directory

/zstack/v1/update/directory

操作 ID

UpdateDirectory

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "ce9c80c271df30eba545af5b7efc6b09", "name": "test", "groupName": "admin/first/second", "parentUuid": "5cc7f45b66783385b3f4a9d1ef109a5d", "rootDirectoryUuid": "57290934e96a305fbdad6ccb33bb64b8", "zoneUuid": "b103949274663c19b9675ea6f6505dd5", "type": "default" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史