Query members in a resource directory by calling ListAccounts - Resource Management - Alibaba Cloud - Resource Management

Queries the members in a resource directory.

Operation description

Only the management account of a resource directory or a delegated administrator account of a trusted service can call this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
QueryKeyword	string	No	The keyword for the query, such as the display name of a member. Fuzzy match is supported.	Advance
Tag	array<object>	No	The tags to filter by.
	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 tag information. Valid values: false (default value) true	true
MaxResults	integer	No	The number of entries per page. When this parameter is specified, token-based pagination is preferentially used. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The pagination token for the next request. Leave this parameter empty to start from the beginning.	TGlzdFJlc291cm****

Response elements

Element	Type	Description	Example
	object	The response object.
TotalCount	integer	The total number of entries.	2
RequestId	string	The request ID.	7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
PageSize	integer	The number of entries per page.	5
PageNumber	integer	The page number.	1
NextToken	string	The pagination token for the next request. If this parameter is empty, no more pages exist.	TGlzdFJlc291cm****
Accounts	object
Account	array<object>	The member details.
	array<object>	The details of a member.
Status	string	The member status. 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 member type. Valid values: CloudAccount: cloud account ResourceAccount: resource account	ResourceAccount
DisplayName	string	The display name of the member.	test
FolderId	string	The folder ID.	fd-QRzuim****
ResourceDirectoryId	string	The resource directory ID.	rd-3G****
JoinTime	string	The time when the member joined the resource directory, in UTC.	2021-01-18T08:01:50.522Z
AccountId	string	The Alibaba Cloud account ID of the member.	181761095690****
JoinMethod	string	The method by which the member joined 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 last modified, 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 This parameter is empty if no deletion has been performed for the member.	Checking
Tags	object
Tag	array<object>	The tags added to the member.
	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

Success response

JSON format

{
  "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
400	InvalidParameter.MaxResults	The MaxResults is invalid.
400	InvalidParameter.NextToken	The NextToken is invalid.
400	InvalidParameter.NextToken.Length	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.