文档首页/ 云监控服务 CES/ API参考/ API V2/ 告警资源/ 查询告警规则资源列表 - ListAlarmRuleResources
更新时间：2025-10-29 GMT+08:00
查看PDF
分享

查询告警规则资源列表 - ListAlarmRuleResources

功能介绍

根据告警规则ID查询告警规则资源列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:alarms:getResources

    Read

    alarm *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId
    • ces:alarms:list

    -

URI

GET /v2/{project_id}/alarms/{alarm_id}/resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

alarm_id

是

String

参数解释：

告警规则ID。

约束限制：

不涉及。

取值范围：

以al开头，后跟22位的字母或数字。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数描述：

分页偏移量。

约束限制：

不涉及。

取值范围：

最小值为0，最大值为10000。

默认取值：

0

limit

否

Integer

参数描述：

分页大小。

约束限制：

不涉及。

取值范围：

最小值为1，最大值为100。

默认取值：

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为16384。

默认取值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

resources

Array<Array<DimensionResp>>

参数解释：

资源信息。

count

Integer

参数解释：

资源总数。

取值范围：

[0,2147483647]
表5 DimensionResp

参数

参数类型

描述

name

String

参数解释：

资源维度，如：弹性云服务器，则维度为instance_id。各服务资源的指标维度名称可查看：“服务维度名称”。

取值范围：

以字母开头，只能包含字母、数字、“_”、“-”。

value

String

参数解释：

资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。

取值范围：

长度为[1,256]个字符。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

查询Alarm实例ID为alCzk8o9dtSQHtiDgb44Eepw，且分页大小为10的告警规则资源列表。

/v2/{project_id}/alarms/alCzk8o9dtSQHtiDgb44Eepw/resources?offset=0&limit=10

响应示例

状态码：200

查询成功

{
  "resources" : [ [ {
    "name" : "disk_name"
  } ] ],
  "count" : 10
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码。

父主题： 告警资源