GetExperimentGroup-阿里云帮助中心

Retrieves details for a specified experiment group.

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

get

*All Resource

*

None

Request syntax

GET /api/v1/experimentgroups/{ExperimentGroupId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ExperimentGroupId	string	Yes	The ID of the experiment group. You can call the `ListExperimentGroups` operation to obtain this ID.	3

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 data returned.
RequestId	string	The request ID.	BDB621CB-A81E-5D39-8793-39A365CBCC74
LayerId	string	The ID of the layer.	3
LaboratoryId	string	The ID of the laboratory.	4
SceneId	string	The ID of the scene.	1
Name	string	The name of the experiment group.	experiment_group1
Description	string	The description of the experiment group.	This is a test.
DebugUsers	string	The user IDs for debugging, separated by commas.	1124512470****,1124512471**,1124512472****
DebugCrowdId	string	The ID of the debug crowd.	4
Owner	string	The owner of the experiment group.	1124512470******
NeedAA	boolean	Indicates whether an A/B test is required.	true
Filter	string	The filter.	gender=female
DistributionType	string	The traffic distribution method. ● `UserId`: Distributes traffic by user ID. ● `TimeDuration`: Distributes traffic by time period.	UserId
DistributionTimeDuration	integer	The distribution duration.	5
CrowdId	string	The ID of the crowd.	3
Config	string	The configuration of the experiment group.	{"RankBy": "Score"}
ReservedBuckets	string	The reserved bucket IDs.	1,2,3,4
Status	string	The status of the experiment group. Valid values: ● `Offline`: The experiment group is not launched. ● `Online`: The experiment group is launched. ● `Pushed`: The experiment group is fully launched.	Offline
CrowdTargetType	string	The method for targeting traffic to the experiment group. Valid values: `All`: all traffic `Filter`: traffic that matches the filter `CrowdId`: traffic from the specified crowd `Random`: a random percentage of traffic	All
RandomFlow	integer	The percentage of traffic from 0 to 100 that is randomly allocated to this experiment group. This parameter is returned only when `CrowdTargetType` is set to `Random`.	20
HoldingBuckets	string	The bucket IDs that correspond to the `RandomFlow` percentage. This parameter is returned only when `CrowdTargetType` is set to `Random`.	1,2,3,4

Examples

Success response

JSON format

{
  "RequestId": "BDB621CB-A81E-5D39-8793-39A365CBCC74",
  "LayerId": "3",
  "LaboratoryId": "4",
  "SceneId": "1",
  "Name": "experiment_group1",
  "Description": "This is a test.",
  "DebugUsers": "1124512470******,1124512471******,1124512472******",
  "DebugCrowdId": "4",
  "Owner": "1124512470******",
  "NeedAA": true,
  "Filter": "gender=female",
  "DistributionType": "UserId",
  "DistributionTimeDuration": 5,
  "CrowdId": "3",
  "Config": "{\"RankBy\": \"Score\"}",
  "ReservedBuckets": "1,2,3,4",
  "Status": "Offline",
  "CrowdTargetType": "All",
  "RandomFlow": 20,
  "HoldingBuckets": "1,2,3,4"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.