CreateCrowd

更新时间:
复制 MD 格式

Creates a crowd that represents a group of users.

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:CreateCrowd

create

*All Resource

*

None None

Request syntax

POST /api/v1/crowds HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

InstanceId

string

Yes

The instance ID. To get this ID, call the ListInstances operation.

pairec-cn-abcdefg1234

Name

string

Yes

The crowd name.

xx人群

Description

string

Yes

The description of the crowd.

This is a test.

Label

string

No

The crowd label.

os=android

Source

string

No

The source of the user data. Valid values: ● ManualInput: Users are provided in the Users parameter. ● UploadFile: Users are provided from an uploaded file.

ManualInput

Users

string

No

The users to include in the crowd. Separate multiple users with commas (,).

user1,user2,user3

Response elements

Element

Type

Description

Example

object

The data returned by the request.

RequestId

string

The request ID.

59CE7EC6-F268-5D71-9215-32922CC50D72

CrowdId

string

The crowd ID.

3

Examples

Success response

JSON format

{
  "RequestId": "59CE7EC6-F268-5D71-9215-32922CC50D72",
  "CrowdId": "3"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.