GetExperiment-阿里云帮助中心

Retrieves the details of a specified experiment.

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

get

*All Resource

*

None

Request syntax

GET /api/v1/experiments/{ExperimentId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ExperimentId	string	Yes	The experiment ID. You can obtain this ID by calling the ListExperiments operation.	3

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can obtain this ID by calling the ListInstances operation.	pairec-cn-abcdefg1234

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	74D958EF-3598-56FA-8296-FF1575CE43DF
AliasExperimentId	string	The alias of the experiment.	L1#EG1#E1
ExperimentGroupId	string	The experiment group ID.	3
LayerId	string	The layer ID.	3
LaboratoryId	string	The laboratory ID.	3
SceneId	string	The scene ID.	3
Name	string	The experiment name.	experiment_test1
Description	string	The experiment description.	This is a test.
Type	string	The type of the experiment. Valid values: ● Baseline: a baseline experiment. ● Normal: a normal experiment.	Baseline
FlowPercent	integer	The traffic percentage.	100
Buckets	string	A comma-separated list of bucket numbers.	1,2,3
DebugUsers	string	The UIDs of debug users, which can be the UIDs of an Alibaba Cloud main account or a RAM user. Separate multiple UIDs with a comma (,).	1124512470****,1124512471**,1124512472****
DebugCrowdId	string	The debug crowd ID.	3
Config	string	The experiment configuration, in JSON format.	{"RankBy": "Score"}
Status	string	The status of the experiment. Valid values: ● Offline ● Online	Offline
GmtCreateTime	string	The creation time, in ISO 8601 format.	2021-12-15T23:24:33.132+08:00
GmtModifiedTime	string	The modification time, in ISO 8601 format.	2021-12-15T23:24:33.132+08:00

Examples

Success response

JSON format

{
  "RequestId": "74D958EF-3598-56FA-8296-FF1575CE43DF",
  "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": "1124512470******,1124512471******,1124512472******",
  "DebugCrowdId": "3",
  "Config": "{\"RankBy\": \"Score\"}",
  "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.