PutCustomMetric-阿里云帮助中心

Calls the PutCustomMetric operation to report custom monitoring data.

Operation description

Note

We recommend that you use the PutHybridMonitorMetricData operation in Enterprise CloudMonitor.

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

cms:PutCustomMetric

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MetricList	array<object>	Yes	The list of monitoring data.
	object	No
Type	string	Yes	The type of the reported value. Valid values of N: 1 to 21. Valid values: 0: raw data. 1: aggregate data. Note When you report aggregate data, we recommend that you report both data with a period of 60 seconds and data with a period of 300 seconds. Otherwise, monitoring data cannot be queried for a time span of more than 7 days.	0
MetricName	string	Yes	The name of the metric. Valid values of N: 1 to 21. For more information, see Metrics of cloud services.	cpu_total
Time	string	No	The time when the metric occurred. Valid values of N: 1 to 21. The following two types of values are supported: UTC time. Format: YYYY-MM-DDThh:mm:ssZ. For example: 20171012T132456.888+0800. A Long-type timestamp. For example: 1508136760000.	1508136760000
GroupId	string	Yes	The ID of the application group. Valid values of N: 1 to 21. Note If the metric does not belong to any application group, enter 0.	12345
Values	string	Yes	The collection of metric values. Valid values of N: 1 to 21. Note If the type of the reported value is 0, the raw values are reported. CloudMonitor aggregates raw values into multiple values, such as maximum, count, and sum, by period.	{"value":10.5}
Dimensions	string	Yes	The dimension map, which is used to query monitoring data of a specified resource. Valid values of N: 1 to 21. Format: a collection of key-value pairs. A commonly used key-value pair collection is: `{"Key":"Value"}`. The length of Key and Value is 1 to 64 characters. Characters beyond the first 64 are truncated. The values of Key and Value can contain letters, digits, periods (.), hyphens (-), underscores (_), forward slashes (/), and backslashes (). Note Dimensions must be passed in as a JSON string that represents the map object, and must be passed in order.	{"sampleName1":"value1","sampleName2":"value2"}
Period	string	No	The aggregation period. Valid values of N: 1 to 21. Unit: seconds. Valid values: 60 and 300. Note If the type of the reported value is 1, you must set this parameter.	60

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note 200 indicates success.	200
Message	string	The error message.	The request has failed due to a temporary failure of the server.
RequestId	string	The request ID.	05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The request has failed due to a temporary failure of the server.",
  "RequestId": "05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0"
}

Error codes

HTTP status code	Error code	Error message
400	%s	%s
500	%s	%s
500	InternalError	%s
403	%s	%s
404	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.