Queries the information of members in a folder.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ParentFolderId | string | No | The ID of the folder. | fd-bVaRIG**** |
QueryKeyword | string | No | The keyword used for the query, such as the display name of a member. Fuzzy match is supported. | admin |
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 |
Tag | object [] | No | The tags. This parameter specifies a filter condition. | |
Key | string | No | The key of the tag. | tag_key |
Value | string | No | The value of the tag. | tag_value |
IncludeTags | boolean | No | Specifies whether to return information about tags. Valid values:
| true |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSON
format
{
"TotalCount": 2,
"RequestId": "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
"PageSize": 5,
"PageNumber": 1,
"Accounts": {
"Account": [
{
"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",
"AccountName": "hdd01429358@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.ParentFolderId | The ParentFolderId is invalid. | The value of the ParentFolderId parameter is invalid. The value must start with r- followed by 6 characters or start 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 account is not 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 specified folder does not exist. Create such a folder 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 | see changesets | ||||||||
|