Retrieves all users within a specified crowd, including those in its sub-crowds.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
pairec:ListCrowdUsers |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v1/crowds/{CrowdId}/users HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CrowdId |
string |
Yes |
The ID of the crowd. You can call the ListCrowds operation to obtain this ID. |
1 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the instance. You can call the ListInstances operation to obtain this ID. |
pairec-cn-abcdefg1234 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| RequestId |
string |
The ID of the request. |
F0AB6527-093F-5C44-B3BD-42C8C210C619 |
| TotalCount |
integer |
The total number of entries. |
3 |
| Users |
array |
The list of users. |
|
|
string |
The user ID. |
user1 |
Examples
Success response
JSON format
{
"RequestId": "F0AB6527-093F-5C44-B3BD-42C8C210C619",
"TotalCount": 3,
"Users": [
"user1"
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.