更新时间:2024-11-19 GMT+08:00
分享

查询告警模板

功能介绍

查询告警模板

URI

GET /v1/projects/{service_id}/alert-templates

表1 路径参数

参数

是否必选

参数类型

描述

service_id

String

服务id

表2 Query参数

参数

是否必选

参数类型

描述

name

String

模板名称

page_num

Integer

当前页数

page_size

Integer

每页数量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

token

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

end_row

Long

结束行

has_next_page

Boolean

是否有下一页

has_previous_page

Boolean

是否有上一页

is_first_page

Boolean

是否是第一页

is_last_page

Boolean

是否是最后一页

list

Array of AlertTemplateVo objects

当前页面的模板

navigate_first_page

Integer

导航第一页数字

navigate_last_page

Integer

导航最后一页数字

navigate_pages

Integer

导航页数

navigate_page_nums

Array of integers

导航页数

next_page

Integer

下一页

page_num

Integer

多少页

page_size

Integer

每页多少个

pages

Integer

总页数

pre_page

Integer

前面有多少页

size

Integer

当前页告警模板数

start_row

Long

开始行

total

Long

总告警模板数

表5 AlertTemplateVo

参数

参数类型

描述

alert_levels

Array of AlertLevel objects

告警级别列表

create_time

String

创建时间

create_user

String

创建人

id

String

唯一ID,主键

name

String

告警模板名称

remarks

String

备注

test_service_id

String

服务ID

update_time

String

修改时间

update_user

String

更新人

表6 AlertLevel

参数

参数类型

描述

alert_channel

Array of strings

告警渠道列表

alert_groups

Array of AlertGroup objects

告警组列表

alert_template_id

String

告警模板ID

alert_times

Integer

告警次数

表7 AlertGroup

参数

参数类型

描述

ding_talk_hook_url

String

企业钉钉微信群聊机器人地址

group_name

String

告警组名称

id

String

告警组ID

we_chat_work_hook_url

String

企业微信群聊机器人地址

we_link_group_no

String

weLink群号

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

请求示例

响应示例

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档