ListCrowds-阿里云帮助中心

Lists the Crowds in a specified instance.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pairec:ListCrowds

list

*All Resource

*

None

Request syntax

GET /api/v1/crowds HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. Call the `ListInstances` operation to obtain this ID.	pairec-cn-abcdefg1234

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	9763624B-5FBB-5E3A-9193-B1ADB554CEAE
TotalCount	integer	The total number of Crowds.	10
Crowds	array<object>	The list of Crowds.
	object
CrowdId	string	The Crowd ID.	3
Name	string	The Crowd name.	crowd1
Description	string	The Crowd description.	This is a test.
Label	string	The label of the Crowd.	os=android
Source	string	The source of the Crowd. Valid values: `ManualInput`: The Crowd is created from a manual entry of users. `UploadFile`: The Crowd is created from an uploaded file.	ManualInput
Quantity	string	The number of users in the Crowd.	10
Users	string	The user IDs in the Crowd, separated by commas.	user1,user2
GmtCreateTime	string	The time when the Crowd was created.	2021-12-15T23:24:33.132+08:00

Examples

Success response

JSON format

{
  "RequestId": "9763624B-5FBB-5E3A-9193-B1ADB554CEAE",
  "TotalCount": 10,
  "Crowds": [
    {
      "CrowdId": "3",
      "Name": "crowd1",
      "Description": "This is a test.",
      "Label": "os=android",
      "Source": "ManualInput",
      "Quantity": "10",
      "Users": "user1,user2",
      "GmtCreateTime": "2021-12-15T23:24:33.132+08:00"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.