PutHybridMonitorMetricData-阿里云帮助中心

Reports the specified monitoring data to a specified metric namespace of Enterprise CloudMonitor by calling the PutHybridMonitorMetricData operation.

Operation description

Prerequisites

Make sure that you have activated Enterprise CloudMonitor. For more information, see Activate Enterprise CloudMonitor.

Limits

The size of the monitoring data that you can report at a time cannot exceed 1 MB.

Usage notes

This topic provides an example to show how to report the monitoring data of the CPU_Usage metric to the default-aliyun metric namespace of 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:PutHybridMonitorMetricData

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The name of the metric namespace. For information about how to obtain the name of a metric namespace, see DescribeHybridMonitorNamespaceList.	default-aliyun
MetricList	array<object>	Yes	The list of monitoring data. Valid values of N: 1 to 100.
	array<object>	Yes	None.
Name	string	Yes	The name of the metric. Valid values of N: 1 to 100. Format: The name can contain uppercase letters, lowercase letters, digits, and underscores (_). The name must start with an uppercase letter or a lowercase letter.	CPU_Usage
Labels	array<object>	No	The list of labels of the metric. Valid values of N: 1 to 100.	[{"Key":"app","Value":"testApp"},{"Key":"ip","Value":"192.168.XX.XX"},{"Key":"hostName","Value":"host01"}]
	object	No	None.
Key	string	No	The key of the label of the metric. Valid values of N: 1 to 100. Format: The key can contain uppercase letters, lowercase letters, digits, and underscores (). The key must start with an uppercase letter, a lowercase letter, or an underscore (). Note Key and Value must be set at the same time.	IP
Value	string	No	The value of the label of the metric. Valid values of N: 1 to 100. Note Key and Value must be set at the same time.	192.168.XX.XX
Value	string	Yes	The value of the metric. Valid values of N: 1 to 100. Format: an integer or a floating-point number.	90
TS	integer	No	The timestamp when the monitoring data was reported. Valid values of N: 1 to 100. Unit: milliseconds. Default value: the current time.	1640776119473

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	None.
Code	string	The status code. Note The value 200 indicates that the request was successful.	200
RequestId	string	The request ID.	5DB1CBCA-D14A-55FA-814F-B4DBD9735F68
ErrorDetail	array<object>	The details of the invalid parameters. If the request parameters that you specify do not meet the requirements, the details of the invalid parameters are displayed.
	object	None.
Index	integer	The position of the error information in the array.	0
ErrorMessage	string	The error message that is returned for the invalid parameter.	label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*

Examples

Success response

JSON format

{
  "Code": "200",
  "RequestId": "5DB1CBCA-D14A-55FA-814F-B4DBD9735F68",
  "ErrorDetail": [
    {
      "Index": 0,
      "ErrorMessage": "label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	%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.