All Products
Search
Document Center

Application Real-Time Monitoring Service:DescribeAddonMetrics

Last Updated:Nov 05, 2024

Example Query metric details about an Addon.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:DescribeAddonMetricsnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringYes

Name fo Addon.

mysql
AddonVersionstringNo

Version of Addon.

0.0.1
AliyunLangstringNo

The language. Valid values: zh and en. Default value: zh.

zh
EnvironmentTypestringNo

The environment type. Valid values: CS, ECS, and Cloud.

CS
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

response

RequestIdstring

Id of the request

B6A00968-82A8-4F14-9D1B-B53827DB****
Codeinteger

The HTTP status code. The status code 200 indicates that the request was successful.

200
Messagestring

The error message.

success
Successboolean

Indicates whether the request was successful. Valid values: true and false.

true
Dataarray<object>

Metric information list.

dataobject

Metric information list.

Groupstring

Metric Group.

Common
Labelsarray<object>

Metric Labels.

labelsobject

The label details.

Descriptionstring

Metric label description.

The number of times a B-tree page of size PAGE_SIZE was successfully compressed.
Keystring

Metric label key.

page_size
Sourcestring

Metric label value.

db
Metricsarray<object>

Metric list.

labelsobject

Metric list.

Descriptionstring

Metric description.

The number of times a B-tree page of size PAGE_SIZE was successfully compressed.
Labelsarray<object>

Metric label collection.

labelsobject

Metric label collection.

Descriptionstring

Label description.

PAGE_SIZE
Keystring

Label key.

page_size
Sourcestring

Metric source.

db
Typestring

Metric type.

GAUGE
Unitstring

Metric unit.

bytes
Metricstring

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.