跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口
POSTVM Related Interfaces起始版本 4.6.0同步需要认证

创建资源分组目录

创建资源分组目录

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • parentUuidString

      父级目录UUID

    • zoneUuidString必填

      数据中心UUID

    • typeString必填

      类型。

    • resourceUuidString

      资源UUID

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVmInstanceInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • groupNameString必填

      所属分组

    • parentUuidString必填

      父级目录UUID

    • rootDirectoryUuidString必填

      根目录UUID

    • zoneUuidString必填

      数据中心UUID

    • typeString必填

      目录类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/create/directory

/zstack/v1/create/directory

操作 ID

CreateDirectory

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/create/directory' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","parentUuid":"<parentUuid>","zoneUuid":"<zoneUuid>","type":"<type>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "ac818da023833bcd83728b6374c2a4f0", "name": "test", "groupName": "admin/first/second", "parentUuid": "d6e5792bd4ef374ba99948ae83d3a7c3", "rootDirectoryUuid": "cf6a11447d5f38dd95a91cc392105b16", "zoneUuid": "3714f0cd0f3233dc96dc5fec67886c29", "type": "default" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史