CreateABMetric-阿里云帮助中心

Creates an AB metric.

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

create

*All Resource

*

None

Request syntax

POST /api/v1/abmetrics HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
Name	string	Yes	The metric name.	pv
Description	string	Yes	The metric description.	pv指标
SceneId	string	Yes	The scene ID. Call the ListScenes operation to obtain this ID.	1
Type	string	Yes	The metric type. Valid values: `Single`: A single metric. `Derived`: A derived metric.	Single
Realtime	boolean	Yes	Specifies whether the metric is a real-time metric. Valid values: `true`: The metric is real-time. `false`: The metric is not real-time.	false
TableMetaId	string	Yes	The data table ID. Call the ListTableMetas operation to obtain this ID.	2
ResultResourceId	string	No	The data source ID to which the results are written back. Call the ListInstanceResources operation to obtain this ID.	3
Definition	string	Yes	The metric definition.	sum(click_cnt)
StatisticsCycle	integer	No	The statistics cycle.	1
LeftMetricId	string	No	The ID of the left metric used to calculate the derived metric.	2
RightMetricId	string	No	The ID of the right metric used to calculate the derived metric.	3
Operator	string	No	The operator used to calculate the derived metric. Valid values: `Plus`: Addition `Minus`: Subtraction `Multiplication`: Multiplication `Division`: Division	Division
InstanceId	string	Yes	The instance ID. Call the ListInstances operation to obtain this ID.	pairec-cn-test1
NeedSignificance	boolean	No
AggregationByUser	boolean	No
Numerator	string	No		click
Denominator	string	No		pv
IsBinomialDistribution	boolean	No

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID.	F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA
ABMetricId	string	The AB metric ID.	1

Examples

Success response

JSON format

{
  "RequestId": "F7AC05FF-EDE7-5C2B-B9AE-33D6DF4178BA",
  "ABMetricId": "1"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.