Queries all the members in a resource directory.

Usage notes

You can use only the management account of a resource directory or a delegated administrator account of a trusted service to 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 ListAccounts

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

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page.

Valid values: 1 to 100. Default value: 10.

Tag.N.Key String No tag_key

A tag key.

Tag.N.Value String No tag_value

A tag value.

IncludeTags Boolean No true

Specifies whether to return the information of tags. Valid values:

  • false (default value)
  • true

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

Response parameters

Parameter Type Example Description
TotalCount Integer 2

The total number of entries returned.

RequestId String 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB

The ID of the request.

PageSize Integer 5

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

Accounts Array of Account

The members returned.

Account
Status String CreateSuccess

The status of the member. Valid values:

  • CreateSuccess: The member is created.
  • PromoteVerifying: The upgrade of the member is being confirmed.
  • PromoteFailed: The upgrade of the member fails.
  • PromoteExpired: The upgrade of the member expires.
  • PromoteCancelled: The upgrade of the member is canceled.
  • PromoteSuccess: The member is upgraded.
  • InviteSuccess: The member accepts the invitation.
Type String ResourceAccount

The type of the member. Valid values:

  • CloudAccount: cloud account
  • ResourceAccount: resource account
DisplayName String test

The display name of the member.

FolderId String fd-QRzuim****

The ID of the folder.

ResourceDirectoryId String rd-3G****

The ID of the resource directory.

JoinTime String 2021-01-18T08:01:50.522Z

The time when the member joined the resource directory. The time is displayed in UTC.

AccountId String 181761095690****

The Alibaba Cloud account ID of the member.

JoinMethod String created

The way in which the member joins the resource directory. Valid values:

  • invited: The member is invited to join the resource directory.
  • created: The member is directly created in the resource directory.
ModifyTime String 2021-01-18T08:04:37.668Z

The time when the member was modified. The time is displayed in UTC.

ResourceDirectoryPath String rd-3G****/r-Wm****/fd-QRzuim****/181761095690****

The path of the member in the resource directory.

Tags Array of Tag

The tags that are added to the member.

Tag
Key String tag_key

A tag key.

Value String tag_value

A tag value.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListAccounts
&PageNumber=1
&PageSize=10
&Tag=[{"Key":"tag_key","Value":"tag_value"}]
&IncludeTags=true
&<Common request parameters>

Sample success responses

XML format

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

<ListAccountsResponse>
    <TotalCount>2</TotalCount>
    <RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>
    <PageSize>1</PageSize>
    <PageNumber>2</PageNumber>
    <Accounts>
        <Status>CreateSuccess</Status>
        <Type>ResourceAccount</Type>
        <DisplayName>test</DisplayName>
        <FolderId>fd-QRzuim****</FolderId>
        <ResourceDirectoryId>rd-3G****</ResourceDirectoryId>
        <JoinTime>2021-01-18T08:01:50.522Z</JoinTime>
        <AccountId>181761095690****</AccountId>
        <JoinMethod>created</JoinMethod>
        <ModifyTime>2021-01-18T08:04:37.668Z</ModifyTime>
        <ResourceDirectoryPath>rd-3G****/r-Wm****/fd-QRzuim****/181761095690****</ResourceDirectoryPath>
        <Tags>
            <Key>tag_key</Key>
            <Value>tag_value</Value>
        </Tags>
    </Accounts>
</ListAccountsResponse>

JSON format

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

{
  "TotalCount" : 2,
  "RequestId" : "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
  "PageSize" : 1,
  "PageNumber" : 2,
  "Accounts" : [ {
    "Status" : "CreateSuccess",
    "Type" : "ResourceAccount",
    "DisplayName" : "test",
    "FolderId" : "fd-QRzuim****",
    "ResourceDirectoryId" : "rd-3G****",
    "JoinTime" : "2021-01-18T08:01:50.522Z",
    "AccountId" : "181761095690****",
    "JoinMethod" : "created",
    "ModifyTime" : "2021-01-18T08:04:37.668Z",
    "ResourceDirectoryPath" : "rd-3G****/r-Wm****/fd-QRzuim****/181761095690****",
    "Tags" : [ {
      "Key" : "tag_key",
      "Value" : "tag_value"
    } ]
  } ]
}

Error codes

HTTP status code Error code Error message Description
404 EntityNotExists.ResourceDirectory The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account. The error message returned because the account has not been used to enable a resource directory. Use the account to enable a resource directory first.

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