DescribeAddonMetrics - 查询Addon指标信息-阿里云帮助中心

查询指定Addon的指标详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:DescribeAddonMetrics	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	Addon 名称。	mysql
AddonVersion	string	否	Addon 版本号	0.0.1
AliyunLang	string	否	语言环境，默认为中文 zh \| en。	zh
EnvironmentType	string	否	环境。	CS
RegionId	string	否	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	response
RequestId	string	Id of the request	B6A00968-82A8-4F14-9D1B-B53827DB****
Code	integer	状态码, 200 为正常, 其他为异常。	200
Message	string	提示消息。	success
Success	boolean	业务是否成功。	true
Data	array<object>	指标信息列表。
data	object	指标信息列表。
Group	string	指标组。	Common
Labels	array<object>	指标标签。
labels	object	指标标签。
Description	string	标签说明。	大小为PAGE_SIZE的B树页面被成功压缩的次数。
Key	string	标签的 Key。	page_size
Source	string	标签的 Source。	db
Metrics	array<object>	指标列表。
labels	object	指标列表。
Description	string	指标说明。	大小为PAGE_SIZE的B树页面被成功压缩的次数。
Labels	array<object>	指标标签集合。
labels	object	指标标签集合。
Description	string	标签说明。	PAGE_SIZE
Key	string	标签 Key。	page_size
Source	string	标签源。	db
Type	string	指标类型。	GAUGE
Unit	string	指标单位。	bytes
Metric	string	指标名称。	mysql_exporter_collector_duration_seconds

示例

正常返回示例

JSON格式

{
  "RequestId": "B6A00968-82A8-4F14-9D1B-B53827DB****",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": [
    {
      "Group": "Common",
      "Labels": [
        {
          "Description": "大小为PAGE_SIZE的B树页面被成功压缩的次数。\n",
          "Key": "page_size",
          "Source": "db"
        }
      ],
      "Metrics": [
        {
          "Description": "大小为PAGE_SIZE的B树页面被成功压缩的次数。\n",
          "Labels": [
            {
              "Description": "PAGE_SIZE",
              "Key": "page_size",
              "Source": "db"
            }
          ],
          "Type": "GAUGE",
          "Unit": "bytes",
          "Metric": "mysql_exporter_collector_duration_seconds"
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。