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

查询分组目录

查询分组目录

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • successBoolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • nameString必填

      资源名称

    • groupNameString必填

      所属分组

    • parentUuidString必填

      父级目录UUID

    • rootDirectoryUuidString必填

      根目录UUID

    • zoneUuidString必填

      区域UUID

    • typeString必填

      目录类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

GET/zstack/v1/directories

/zstack/v1/directories

操作 ID

QueryDirectory

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/directories' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "b3c48edddae03e05b328a5b0926ae353", "name": "test", "groupName": "admin/test", "parentUuid": "d0dc05fcf5753c6888d0b082bc0f9caf", "rootDirectoryUuid": "3830935ca3823d05b9010f242139fad4", "zoneUuid": "0f7266aa26f339cb8f0b47a73d0ddc30", "type": "vminstance" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史