All Products
Search
Document Center

Resource Management:ListAccounts

Last Updated:Dec 18, 2023

Queries all the members in a resource directory.

Operation description

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return.

Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

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

10
QueryKeywordstringNo

The keyword used for the query, such as the display name of a member.

Fuzzy match is supported.

Advance
Tagobject []No

The tags. This parameter specifies a filter condition.

KeystringNo

The tag key.

tag_key
ValuestringNo

The tag value.

tag_value
IncludeTagsbooleanNo

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

false (default value) true

true

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

TotalCountinteger

The total number of entries returned.

2
RequestIdstring

The ID of the request.

7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
PageSizeinteger

The number of entries returned per page.

5
PageNumberinteger

The page number of the returned page.

1
Accountsobject []

The members returned.

Statusstring

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.
CreateSuccess
Typestring

The type of the member. Valid values:

  • CloudAccount: cloud account
  • ResourceAccount: resource account
ResourceAccount
DisplayNamestring

The display name of the member.

test
FolderIdstring

The ID of the folder.

fd-QRzuim****
ResourceDirectoryIdstring

The ID of the resource directory.

rd-3G****
JoinTimestring

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

2021-01-18T08:01:50.522Z
AccountIdstring

The Alibaba Cloud account ID of the member.

181761095690****
JoinMethodstring

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.
created
ModifyTimestring

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

2021-01-18T08:04:37.668Z
ResourceDirectoryPathstring

The path of the member in the resource directory.

rd-3G****/r-Wm****/fd-QRzuim****/181761095690****
AccountNamestring

The Alibaba Cloud account name of the member.

oxy01414357@alibaba-inc.com
Tagsobject []

The tags that are added to the member.

Keystring

The tag key.

tag_key
Valuestring

The tag value.

tag_value

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
  "PageSize": 5,
  "PageNumber": 1,
  "Accounts": {
    "Account": [
      {
        "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****",
        "AccountName": "oxy01414357@alibaba-inc.com",
        "Tags": {
          "Tag": [
            {
              "Key": "tag_key",
              "Value": "tag_value"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404EntityNotExists.ResourceDirectoryThe resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.The account is not used to enable a resource directory. Use the account to enable a resource directory first.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-18The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404