查询告警规则资源列表
功能介绍
根据告警规则ID查询告警规则资源列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/alarms/{alarm_id}/resources
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见“获取项目ID”。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。 |
alarm_id |
是 |
String |
参数解释: 告警规则ID。 约束限制: 不涉及。 取值范围: 以al开头,后跟22位的字母或数字。 默认取值: 不涉及。 正则匹配:al([a-z]|[A-Z]|[0-9]){22}$ |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数描述: 分页偏移量。 约束限制: 不涉及。 取值范围: 最小值为0,最大值为10000。 默认取值: 0 取值范围: 0-10000 默认取值: 0 正则匹配:^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$ |
limit |
否 |
Integer |
参数描述: 分页大小。 约束限制: 不涉及。 取值范围: 最小值为1,最大值为100。 默认取值: 10 取值范围: 1-100 默认取值: 10 正则匹配:^([1-9]|[1-9][0-9]|100)$ |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
否 |
String |
参数解释: 发送的实体的MIME类型。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为64。 默认取值: 默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 |
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为16384。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
resources |
Array<Array<DimensionResp>> |
参数解释: 资源信息。 |
count |
Integer |
参数解释: 资源总数。 取值范围: [0,2147483647] 取值范围: 0-2147483647 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 资源维度,如:弹性云服务器,则维度为instance_id。各服务资源的指标维度名称可查看:“服务维度名称”。 取值范围: 以字母开头,只能包含字母、数字、“_”、“-”。 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-)*$ |
value |
String |
参数解释: 资源维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。 取值范围: 长度为[1,256]个字符。 正则匹配:^((([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|\*|/|#|\(|\))*))$ |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
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 |
系统内部错误 |
错误码
请参见错误码。