DescribeAddonMetrics - Application Real-Time Monitoring Service

Queries the metric details of a component.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:DescribeAddonMetrics	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the component.	mysql
AddonVersion	string	No	The version of the component.	0.0.1
AliyunLang	string	No	The language. Valid values: zh and en. Default value: zh.	zh
EnvironmentType	string	No	The environment.	CS
RegionId	string	No	The ID of the region.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	response
RequestId	string	Id of the request	B6A00968-82A8-4F14-9D1B-B53827DB****
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	success
Success	boolean	Indicates whether the request was successful.	true
Data	array<object>	The metric details.
data	object	The metric details.
Group	string	The metric group.	Common
Labels	array<object>	The tags.
labels	object	The tags.
Description	string	The description of the tag.	The number of times a B-tree page of size PAGE_SIZE was successfully compressed.
Key	string	The tag key.	page_size
Source	string	The source of the tag.	db
Metrics	array<object>	The metrics.
labels	object	The metrics.
Description	string	The description of the metric.	The number of times a B-tree page of size PAGE_SIZE was successfully compressed.
Labels	array<object>	The tags.
labels	object	The tags.
Description	string	The description of the tag.	PAGE_SIZE
Key	string	The tag key.	page_size
Source	string	The source of the tag.	db
Type	string	The type of the metric.	GAUGE
Unit	string	The unit of the metric.	bytes
Metric	string	The metric name.	mysql_exporter_collector_duration_seconds

Examples

Sample success responses

JSONformat

{
  "RequestId": "B6A00968-82A8-4F14-9D1B-B53827DB****",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": [
    {
      "Group": "Common",
      "Labels": [
        {
          "Description": "The number of times a B-tree page of size PAGE_SIZE was successfully compressed.",
          "Key": "page_size",
          "Source": "db"
        }
      ],
      "Metrics": [
        {
          "Description": "The number of times a B-tree page of size PAGE_SIZE was successfully compressed.",
          "Labels": [
            {
              "Description": "PAGE_SIZE",
              "Key": "page_size",
              "Source": "db"
            }
          ],
          "Type": "GAUGE",
          "Unit": "bytes",
          "Metric": "mysql_exporter_collector_duration_seconds"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.