Queries information about a directory.

Usage notes

This topic provides an example on how to query information about the directory whose ID is d-00fc2p61****.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetDirectory

The operation that you want to perform. Set the value to GetDirectory.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String AA6A9E4B-8A61-59E1-AA87-F61CA18258A3

The ID of the request.

Directory Object

The information about the directory.

DirectoryId String d-00fc2p61****

The ID of the directory.

CreateTime String 2021-06-30T08:35:26Z

The time when the directory was created.

UpdateTime String 2021-10-25T07:18:46Z

The time when the directory was modified.

Region String cn-shanghai

The region ID of the directory.

DirectoryName String example

The name of the directory.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetDirectory
&DirectoryId=d-00fc2p61****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetDirectoryResponse>
    <RequestId>AA6A9E4B-8A61-59E1-AA87-F61CA18258A3</RequestId>
    <Directory>
        <DirectoryId>d-00fc2p61****</DirectoryId>
        <CreateTime>2021-06-30T08:35:26Z</CreateTime>
        <UpdateTime>2021-10-25T07:18:46Z</UpdateTime>
        <Region>cn-shanghai</Region>
        <DirectoryName>example</DirectoryName>
    </Directory>
</GetDirectoryResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "AA6A9E4B-8A61-59E1-AA87-F61CA18258A3",
  "Directory" : {
    "DirectoryId" : "d-00fc2p61****",
    "CreateTime" : "2021-06-30T08:35:26Z",
    "UpdateTime" : "2021-10-25T07:18:46Z",
    "Region" : "cn-shanghai",
    "DirectoryName" : "example"
  }
}

Error codes

For a list of error codes, visit the API Error Center.