All Products
Search
Document Center

Resource Management:ListAccounts

Last Updated:Jun 05, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
resourcemanager:ListAccountsList
  • Account
    acs:resourcemanager:*:{#accountId}:account/*
    none
none

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
Tagobject []No

The tag key and value.

KeystringNo

A tag key.

tag_key
ValuestringNo

A tag value.

tag_value
IncludeTagsbooleanNo

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

  • false (default value)
  • true
true

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

Response parameters

ParameterTypeDescriptionExample
object
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****
Tagsobject []

The tags that are added to the member.

Keystring

A tag key.

tag_key
Valuestring

A 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****",
        "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 resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.

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

Change history

Change timeSummary of changesOperation
No change history