CreateExperimentGroup

更新时间:
复制 MD 格式

Creates an experiment group in a specified layer. You can use experiment groups to categorize experiments and observe their overall performance.

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

create

*All Resource

*

None None

Request syntax

POST /api/v1/experimentgroups HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

LayerId

string

Yes

The ID of the layer. You can obtain this ID by calling the ListLayers operation.

3

Name

string

Yes

The name of the experiment group.

experiment_group_test

Description

string

No

The description of the experiment group.

This is a test.

DebugUsers

string

No

The UIDs of the debug users. The value must be the UID of an Alibaba Cloud account or a RAM user. Separate multiple UIDs with a comma.

1124512470******,1124512471******,1124512472******

DebugCrowdId

string

No

The ID of the debug crowd. You can obtain this ID by calling the ListCrowds operation.

3

NeedAA

boolean

Yes

Specifies whether to create an A/A experiment group.

true

Filter

string

No

The filter condition for crowd targeting.

gender=male

CrowdId

string

No

The ID of the crowd for crowd targeting. You can obtain this ID by calling the ListCrowds operation.

1

DistributionType

string

No

The distribution type. Valid values: UserId (by user ID) and TimeDuration (by time duration).

UserId

DistributionTimeDuration

integer

No

The time duration for traffic distribution.

3

Config

string

No

The configuration of the experiment group.

{"RankBy": "Score"}

ReservedBuckets

string

No

A comma-separated list of reserved bucket numbers.

1,2,3

InstanceId

string

Yes

The instance ID. You can obtain this ID by calling the ListInstances operation.

pairec-test1

CrowdTargetType

string

No

The crowd targeting type for the experiment group. Valid values:

  • All: All traffic

  • Filter: Traffic that matches the filter condition

  • CrowdId: Traffic from a specific crowd

  • Random: A random percentage of traffic

All

RandomFlow

integer

No

The percentage of traffic to randomly allocate to this experiment group. This parameter is used only when CrowdTargetType is set to Random. Valid values: 0 to 100.

20

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The ID of the request.

A04CB8C0-E74A-5E83-BC61-64D153574EC7

ExperimentGroupId

string

The ID of the experiment group.

3

Examples

Success response

JSON format

{
  "RequestId": "A04CB8C0-E74A-5E83-BC61-64D153574EC7",
  "ExperimentGroupId": "3"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.