文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ 告警/ 通过规则名称获取告警行动规则
更新时间：2024-08-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

通过规则名称获取告警行动规则

功能介绍

通过规则名称获取告警行动规则。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/alert/action-rules/{rule_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

最小长度：32

最大长度：32

rule_name

是

String

告警规则名称

最小长度：1

最大长度：100

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

最小长度：1

最大长度：40960

Content-Type

是

String

指定类型为application/json。

枚举值：

  • application/json

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

rule_name

String

规则名称 只含有汉字数字、字母、下划线，不能以下划线等特殊符号开头和结尾，长度为 1 - 100

最小长度：1

最大长度：100

project_id

String

项目ID

最小长度：32

最大长度：32

user_name

String

子账号名称

最小长度：1

最大长度：100

desc

String

规则描述。规则描述长度为0到1024个字符，并且只能是数字、字母、特殊字符（_*）、空格和中文组成，不能以下划线开头和结尾。

最小长度：0

最大长度：1024

type

String

规则类型。"1"：通知，"2"：用户

最小长度：1

最大长度：1

枚举值：

  • 1

  • 2

notification_template

String

消息模板

最小长度：1

最大长度：100

create_time

Long

创建时间

最小值：0

最大值：9999999999999

update_time

Long

修改时间

最小值：0

最大值：9999999999999

time_zone

String

时区

最小长度：1

最大长度：100

smn_topics

Array of SmnTopics objects

SMN主题信息，不能大于5

数组长度：1 - 5
表4 SmnTopics

参数

参数类型

描述

display_name

String

Topic的显示名，推送邮件消息时，作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。

最小长度：1

最大长度：64

name

String

创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_，且必须由大写字母、小写字母或数字开头，长度为1到255个字符。

最小长度：1

最大长度：255

push_policy

Integer

SMN消息推送策略。取值为0或1

最小值：0

最大值：1

status

Integer

topic中订阅者的状态。0:主题已删除或主题下订阅列表为空。1:主题下的订阅列表存在状态为“已订阅”的订阅信息。2:主题下的订阅信息状态处于“未订阅”或“已取消”。

枚举值：

  • 0

  • 1

  • 2

topic_urn

String

Topic的唯一的资源标识。

最小长度：1

最大长度：100

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

响应码。

最小长度：13

最大长度：13

error_msg

String

响应信息描述。

最小长度：1

最大长度：100

trace_id

String

响应id。

最小长度：12

最大长度：12

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：0

最大长度：1024

error_type

String

错误类型

最小长度：0

最大长度：128

trace_id

String

请求id

最小长度：32

最大长度：32

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：0

最大长度：1024

error_type

String

错误类型

最小长度：0

最大长度：128

trace_id

String

请求id

最小长度：32

最大长度：32

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码。

最小长度：13

最大长度：13

error_msg

String

响应信息描述。

最小长度：1

最大长度：100

trace_id

String

响应id。

最小长度：12

最大长度：12

请求示例

查询名称为1112222告警行动规则的具体内容

https://{Endpoint}/v2/{project_id}/alert/action-rules/1112222

响应示例

状态码： 200

OK 请求响应成功。

{
  "create_time" : 1665991889597,
  "notification_template" : "aom.built-in.template.zh",
  "project_id" : "2xxxxxxxxxxxxxxxxxxxxxxf",
  "rule_name" : "1112222",
  "smn_topics" : [ {
    "display_name" : "",
    "name" : "gxxxxxt",
    "push_policy" : 0,
    "status" : 0,
    "topic_urn" : "urn:smn:xxx:2xxxxxxxxxxxxxxxxxxxxxxf:gxxxxxt"
  } ],
  "time_zone" : "xxx",
  "type" : "1",
  "update_time" : 1665991889597,
  "user_name" : "kxxxxxxxt"
}

状态码： 400

BadRequest 非法请求。建议直接修改该请求，不要重试该请求。

{
  "error_code": "AOM.08001001",
  "error_msg": "bad request",
  “trace_id”:""
}

状态码： 401

Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

{
  "error_code" : "AOM.0403",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED",
  "trace_id" : null
}

状态码： 403

Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

{
  "error_code" : "AOM.0403",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED",
  "trace_id" : null
}

状态码： 500

InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。

{
  "error_code" : "APM.00000500",
  "error_msg" : "Internal Server Error",
  "trace_id" : ""
}

状态码

状态码

描述

200

OK 请求响应成功。

400

BadRequest 非法请求。建议直接修改该请求，不要重试该请求。

401

Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

500

InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。

错误码

请参见错误码。

父主题： 告警