UpdateExperiment

更新时间:
复制 MD 格式

Updates the properties of a specified experiment, such as its name.

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

update

*All Resource

*

None None

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example

ExperimentId

string

Yes

The ID of the experiment. To obtain this ID, call the ListExperiments operation.

3

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

InstanceId

string

Yes

The ID of the instance. To obtain this ID, call the ListInstances operation.

pairec-cn-abcdefg1234

Name

string

Yes

The name of the experiment.

experiment_test

Description

string

Yes

The description of the experiment.

This is a test.

Type

string

Yes

The type of the experiment. Valid values: ● Baseline: A baseline experiment. ● Normal: A normal experiment.

Baseline

FlowPercent

integer

No

The percentage of traffic to allocate to the experiment.

100

DebugUsers

string

No

The UIDs for debug users, specified as a comma-separated string. Each UID must belong to an Alibaba Cloud account or RAM user.

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

DebugCrowdId

string

No

The ID of the debug crowd. To obtain this ID, call the ListCrowds operation.

3

Config

string

No

The experiment configuration, specified as a JSON string.

{"RankBy": "Score"}

Response elements

Element

Type

Description

Example

object

The data returned for the request.

RequestId

string

The request ID.

A760D972-1475-58C0-BBB3-92B5FB08904F

Examples

Success response

JSON format

{
  "RequestId": "A760D972-1475-58C0-BBB3-92B5FB08904F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.