ListExperimentGroups-阿里云帮助中心

Returns a list of experiment groups.

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

list

*All Resource

*

None

Request syntax

GET /api/v1/experimentgroups HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
LayerId	string	No	The layer ID. You can get this ID by calling the ListLayers operation.	3
Status	string	No	The status of the experiment group. Valid values: Offline, Online, and Pushed.	Online
InstanceId	string	Yes	The instance ID. You can get this ID by calling the ListInstances operation.	pairec-cn-abcdefg1234
TimeRangeStart	string	No	The start time for filtering experiment groups.	2024-08-30 12:00:00
TimeRangeEnd	string	No	The end time for filtering experiment groups.	2024-08-31 12:00:00

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	59CE7EC6-F268-5D71-9215-32922CC50D72
TotalCount	integer	The total number of entries.	10
ExperimentGroups	array<object>	The list of experiment groups.
	object
ExperimentGroupId	string	The experiment group ID.	3
LayerId	string	The layer ID.	3
LaboratoryId	string	The laboratory ID.	4
SceneId	string	The scene ID.	1
Name	string	The experiment group name.	experiment_group1
Description	string	The experiment group description.	This is a test.
DebugUsers	string	The IDs of debug users, separated by commas.	1124512470****,1124512471**,1124512472****
DebugCrowdId	string	The debug crowd ID.	4
Owner	string	The owner of the experiment group.	1124512470******
NeedAA	boolean	Specifies whether to enable A/B testing for the experiment group.	true
Filter	string	The filter condition.	gender=female
DistributionType	string	The traffic distribution method. ● `UserId`: by user ID ● `TimeDuration`: by time duration	UserId
DistributionTimeDuration	integer	The distribution duration. This parameter is required only when `DistributionType` is `TimeDuration`.	5
CrowdId	string	The crowd ID.	3
Config	string	The configuration for the experiment group, in JSON format.	{}
ReservedBuckets	string	The IDs of reserved buckets, separated by commas.	1,2,3,4
Status	string	The status of the experiment group. Valid values: ● `Offline`: The experiment group is inactive. ● `Online`: The experiment group is active. ● `Pushed`: The experiment group is fully rolled out.	Offline
CrowdTargetType	string	The traffic targeting method for the experiment group. Valid values: `All`: All traffic. `Filter`: Traffic that matches the filter. `CrowdId`: Traffic from a specified crowd. `Random`: A random percentage of traffic.	All
RandomFlow	integer	If `CrowdTargetType` is set to `Random`, this parameter specifies the percentage of traffic (an integer from 0 to 100) randomly allocated to the experiment group.	20
HoldingBuckets	string	If `CrowdTargetType` is set to `Random`, this parameter returns the comma-separated IDs of buckets allocated based on the `RandomFlow` value.	1,2,3,4

Examples

Success response

JSON format

{
  "RequestId": "59CE7EC6-F268-5D71-9215-32922CC50D72",
  "TotalCount": 10,
  "ExperimentGroups": [
    {
      "ExperimentGroupId": "3",
      "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": "{}",
      "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.