Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/VM Instance Operations
GETVM Instance OperationsSince 5.3.20SynchronousAuth Required

QueryDirectory

QueryDirectory

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • successBooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoriesListRequired

    Seeinventories.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • groupNameStringRequired

      The group name.

    • parentUuidStringRequired

      The parent directory UUID.

    • rootDirectoryUuidStringRequired

      The root directory UUID.

    • zoneUuidStringRequired

      The zone UUID.

    • typeStringRequired

      The directory type.

    • createDateTimestampRequired

      The creation time.

    • lastOpDateTimestampRequired

      The last operation time.

Endpoint

GET/zstack/v1/directories

/zstack/v1/directories

Operation ID

QueryDirectory

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history