ListExperiments-阿里云帮助中心

Lists the experiments in the 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:ListExperiments

list

*All Resource

*

None

Request syntax

GET /api/v1/experiments HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ExperimentGroupId	string	No	The ID of the experiment group.	3
Status	string	No	The status of the experiment. Valid values: Offline Online	Offline
InstanceId	string	Yes	The instance ID. You can call the ListInstances operation to obtain the ID.	pairec-cn-abcdefg1234
Query	string	No	The filter parameter for quick search. All experiments that match the names or tags are returned.	experiment_test1

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	68075085-1A7D-55C2-B51D-7AD9B02A6DD6
TotalCount	integer	The total number of experiments returned.	10
Experiments	array<object>	The list of experiments.
	object
ExperimentId	string	The ID of the experiment.	3
AliasExperimentId	string	The alias for the experiment ID.	L1#EG1#E1
ExperimentGroupId	string	The ID of the experiment group.	3
LayerId	string	The ID of the layer.	3
LaboratoryId	string	The ID of the laboratory.	3
SceneId	string	The ID of the scene.	3
Name	string	The name of the experiment.	experiment_test1
Description	string	The description of the experiment.	This is a test.
Type	string	The type of the experiment. Valid values: `Baseline`: The control experiment. `Normal`: A variant experiment.	Baseline
FlowPercent	integer	The percentage of flow allocated to the experiment.	100
Buckets	string	The allocated bucket numbers.	1,2,3
DebugUsers	string	A comma-separated list of user IDs for debugging.	uid1,uid2,uid3
DebugCrowdId	string	The ID of the debug crowd.	3
Config	string	The configuration of the experiment.	{}
Status	string	The status of the experiment. Valid values: `Offline`: The experiment is inactive and does not receive flow. `Online`: The experiment is active and can receive flow.	Offline
GmtCreateTime	string	The timestamp indicating when the experiment was created.	2021-12-15T23:24:33.132+08:00
GmtModifiedTime	string	The timestamp indicating when the experiment was last modified.	2021-12-15T23:24:33.132+08:00

Examples

Success response

JSON format

{
  "RequestId": "68075085-1A7D-55C2-B51D-7AD9B02A6DD6",
  "TotalCount": 10,
  "Experiments": [
    {
      "ExperimentId": "3",
      "AliasExperimentId": "L1#EG1#E1",
      "ExperimentGroupId": "3",
      "LayerId": "3",
      "LaboratoryId": "3",
      "SceneId": "3",
      "Name": "experiment_test1",
      "Description": "This is a test.",
      "Type": "Baseline",
      "FlowPercent": 100,
      "Buckets": "1,2,3",
      "DebugUsers": "uid1,uid2,uid3",
      "DebugCrowdId": "3",
      "Config": "{}",
      "Status": "Offline",
      "GmtCreateTime": "2021-12-15T23:24:33.132+08:00",
      "GmtModifiedTime": "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.