调用DescribeMetricList接口查询指定云产品的指定监控项的监控数据。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cms:QueryMetricList | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Namespace | string | 是 | 云产品的数据命名空间。命名方式:acs_云产品名称。 关于云产品的数据命名空间,请参见云产品监控项。 | acs_ecs_dashboard |
MetricName | string | 是 | 监控项名称。 关于监控项名称,请参见云产品监控项。 | cpu_idle |
Period | string | 否 | 时间间隔。 取值:60、300、900。 单位:秒。 说明
请根据您的实际需求设置该参数。
| 60 |
StartTime | string | 否 | 开始时间。支持的格式:
说明
| 2019-01-30 00:00:00 |
EndTime | string | 否 | 结束时间。支持的格式:
说明
StartTime和EndTime之间的间隔小于等于31天。
| 2019-01-30 00:10:00 |
Dimensions | string | 否 | 维度Map,用于查询指定资源的监控数据。 格式:key-value键值对形式的集合,常用的key-value集合为 说明
单次请求最多支持批量查询50个实例。
| [{"instanceId": "i-abcdefgh12****"}] |
NextToken | string | 否 | 分页游标标识。 说明
如果不设置该参数,则表示获取第一页的数据。当该参数有返回值时,说明还有下一页,您可以将返回的NextToken作为参数再次请求获得下一页的数据,直到返回为Null为止,表示获取到了所有的数据。
| 15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8**** |
Length | string | 否 | 每页显示的记录条数,用于分页查询。 说明
单次请求Length的最大值为1440。
| 1000 |
Express | string | 否 | 查询出的现有结果进行实时计算的表达式。 说明
目前仅支持groupby,类似数据库的groupby语句。
| {"groupby":["userId","instanceId"]} |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****",
"RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
"Success": true,
"Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"120886317861****\",\"instanceId\":\"i-abc\",\"Minimum\":9.92,\"Average\":9.92,\"Maximum\":9.92}]",
"Code": "200",
"Message": "The specified resource is not found.",
"Period": "60"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | %s | %s | - |
404 | ResourceNotFound | The specified resource is not found. | 未找到指定资源。 |
500 | InternalError | The request processing has failed due to some unknown error. | - |
500 | InternalError | %s | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-03-10 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|