Queries the information of members in a folder.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListAccountsForParent |
The operation that you want to perform. Set the value to ListAccountsForParent. |
ParentFolderId | String | No | fd-bVaRIG**** |
The ID of the folder. |
QueryKeyword | String | No | admin |
The keyword used for the query, such as the display name of a member. Fuzzy match is supported. |
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 information of the members. |
|
Account | |||
Status | String | CreateSuccess |
The status of the member. Valid values:
|
Type | String | ResourceAccount |
The type of the member.
|
DisplayName | String | admin |
The display name of the member. |
FolderId | String | fd-bVaRIG**** |
The ID of the folder. |
ResourceDirectoryId | String | rd-k4**** |
The ID of the resource directory. |
JoinTime | String | 2015-01-23T12:33:18Z |
The time when the member joined the resource directory. The time is displayed in UTC. |
AccountId | String | 184311716100**** |
The Alibaba Cloud account ID of the member. |
JoinMethod | String | created |
The way in which the member joins the resource directory.
|
ModifyTime | String | 2015-01-23T12:33:18Z |
The time when the member was modified. The time is displayed in UTC. |
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=ListAccountsForParent
&ParentFolderId=fd-bVaRIG****
&QueryKeyword=admin
&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
<ListAccountsForParentResponse>
<TotalCount>2</TotalCount>
<RequestId>7B8A4E7D-6CFF-471D-84DF-195A7A241ECB</RequestId>
<PageSize>1</PageSize>
<PageNumber>2</PageNumber>
<Accounts>
<Status>CreateSuccess</Status>
<Type>ResourceAccount</Type>
<DisplayName>admin</DisplayName>
<FolderId>fd-bVaRIG****</FolderId>
<ResourceDirectoryId>rd-k4****</ResourceDirectoryId>
<JoinTime>2015-01-23T12:33:18Z</JoinTime>
<AccountId>184311716100****</AccountId>
<JoinMethod>created</JoinMethod>
<ModifyTime>2015-01-23T12:33:18Z</ModifyTime>
<Tags>
<Key>tag_key</Key>
<Value>tag_value</Value>
</Tags>
</Accounts>
</ListAccountsForParentResponse>
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" : "admin",
"FolderId" : "fd-bVaRIG****",
"ResourceDirectoryId" : "rd-k4****",
"JoinTime" : "2015-01-23T12:33:18Z",
"AccountId" : "184311716100****",
"JoinMethod" : "created",
"ModifyTime" : "2015-01-23T12:33:18Z",
"Tags" : [ {
"Key" : "tag_key",
"Value" : "tag_value"
} ]
} ]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter.ParentFolderId | The ParentFolderId is invalid. | The error message returned because the value of the ParentFolderId parameter is invalid. Specify a value that starts with r- followed by 6 characters or starts with fd- followed by 10 characters. Valid characters include letters and digits. |
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. |
404 | EntityNotExists.Folder | The resource directory folder does not exist. | The error message returned because the folder does not exist. Create such a folder first. |
For a list of error codes, visit the API Error Center.