ListAccounts - Resource Management - Alibaba Cloud Documentation Center

Queries a list of 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
resourcemanager:ListAccounts	list	Account `acs:resourcemanager::{#accountId}:account/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
QueryKeyword	string	No	The keyword used for the query, such as the display name of a member. Fuzzy match is supported.	Advance
Tag	array<object>	No	The tags. This parameter specifies a filter condition.
	object	No	The information of a tag.
Key	string	No	The tag key.	tag_key
Value	string	No	The tag value.	tag_value
IncludeTags	boolean	No	Specifies whether to return information about tags. Valid values: false (default value) true	true
MaxResults	integer	No	The number of entries per page. After you configure this parameter, token-based paging is preferentially used. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If you leave this parameter empty, the query starts from the beginning.	TGlzdFJlc291cm****

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
TotalCount	integer	The total number of entries returned.	2
RequestId	string	The ID of the request.	7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
PageSize	integer	The number of entries returned per page.	5
PageNumber	integer	The page number of the returned page.	1
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	TGlzdFJlc291cm****
Accounts	array<object>	The information about the members.
Account	object	The information of a member.
Status	string	The status of the member. Valid values: CreateSuccess: The member is created. PromoteVerifying: The upgrade of the member is under confirmation. 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
Type	string	The type of the member. Valid values: CloudAccount: cloud account ResourceAccount: resource account	ResourceAccount
DisplayName	string	The display name of the member.	test
FolderId	string	The ID of the folder.	fd-QRzuim****
ResourceDirectoryId	string	The ID of the resource directory.	rd-3G****
JoinTime	string	The time when the member joined the resource directory. The time is displayed in UTC.	2021-01-18T08:01:50.522Z
AccountId	string	The Alibaba Cloud account ID of the member.	181761095690****
JoinMethod	string	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
ModifyTime	string	The time when the member was modified. The time is displayed in UTC.	2021-01-18T08:04:37.668Z
ResourceDirectoryPath	string	The RDPath of the member.	rd-3G**/r-Wm/fd-QRzuim/181761095690**
AccountName	string	The Alibaba Cloud account name of the member.	oxy01414357@alibaba-inc.com
DeletionStatus	string	The deletion status of the member. Valid values: Checking: A deletion check is being performed for the member. Deleting: The member is being deleted. CheckFailed: The deletion check for the member fails. DeleteFailed: The member fails to be deleted. Note If deletion is not performed for the member, the value of this parameter is empty.	Checking
Tags	array<object>	The tags that are added to the member.
Tag	object	The information of a tag.
Key	string	The key of the tag.	tag_key
Value	string	The value of the tag.	tag_value

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
  "PageSize": 5,
  "PageNumber": 1,
  "NextToken": "TGlzdFJlc291cm****",
  "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",
        "DeletionStatus": "Checking",
        "Tags": {
          "Tag": [
            {
              "Key": "tag_key",
              "Value": "tag_value"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.MaxResults	The MaxResults is invalid.	The MaxResults is invalid.
400	InvalidParameter.NextToken	The NextToken is invalid.	The NextToken is invalid.
400	InvalidParameter.NextToken.Length	The maximum length of NextToken (256 characters) is exceeded.	The maximum length of NextToken (256 characters) is exceeded.
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 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 time	Summary of changes	Operation
2024-03-14	The Error code has changed. The response structure of the API has changed	View Change Details
2023-12-18	The Error code has changed	View Change Details