- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
- 场景代码示例
-
常见问题
-
主机监控
- 如何配置DNS和安全组?
- 如何配置委托?
- CES Agent如何通过授权获取临时AK/SK?
- Agent支持的系统有哪些?
- Agent插件资源占用和熔断说明
- 主机监控Agent对主机的性能会有影响吗?
- Agent不同插件状态说明及处理方式
- Agent支持的指标列表
- 支持GPU监控的环境约束
- BMS硬件监控指标采集说明
- 什么是插件修复配置?
- 怎样让新购ECS实例中带有操作系统监控功能?
- Agent各种状态说明及异常状态处理方法
- 基础监控与操作系统监控数据出现不一致的问题
- 云监控服务统计的弹性云服务器网络流量与云主机系统内工具检测不一致的问题
- 未安装UVP VMTools对弹性云服务器监控指标有什么影响?
- 为什么云服务器看不到内存使用率、磁盘使用率、带内网络流入速率和带内网络流出速率四个监控指标?
- 操作系统监控GPU页面显示无记录该如何处理?
- 执行命令安装Agent报错该如何处理?
- 云服务监控
- 告警
- 站点监控
- 网络性能监控
-
主机监控
- 故障排除
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询告警模板列表
功能介绍
查询告警模板列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/alarm-templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户ID 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
分页查询时查询的起始位置,表示从第几条数据开始,默认为0 最小值:0 最大值:10000 |
limit |
否 |
Integer |
查询结果条数的限制值,取值范围为[1,100],默认值为100 最小值:1 最大值:100 |
namespace |
否 |
String |
查询服务的命名空间,各服务命名空间请参考“服务命名空间” 最小长度:3 最大长度:32 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ |
dim_name |
否 |
String |
资源维度,必须以字母开头,多维度用","分割,只能包含0-9/a-z/A-Z/_/-,每个维度的最大长度为32 最小长度:1 最大长度:131 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$ |
template_type |
否 |
String |
模板类型(system代表默认指标模板,custom代表自定义指标模板,system_event代表默认事件模板,custom_event代表自定义事件模板,system_custom_event代表全部事件模板),不传返回全部指标模板 枚举值:
|
template_name |
否 |
String |
告警模板的名称,以字母或汉字开头,可包含字母、数字、汉字、_、-,长度范围[1,128],支持模糊匹配 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$ |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
租户Token 最小长度:1 最大长度:16384 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
alarm_templates |
Array of AlarmTemplates objects |
告警模板列表 数组长度:0 - 100 |
count |
Integer |
告警模板记录总数 最小值:0 最大值:9999999 |
参数 |
参数类型 |
描述 |
---|---|---|
template_id |
String |
告警模板的ID,以at开头,后跟字母、数字,长度最长为64 |
template_name |
String |
告警模板的名称,以字母或汉字开头,可包含字母、数字、汉字、_、-,长度范围[1,128] |
template_type |
String |
模板类型(custom代表默认自定义模板,system代表系统模板) 枚举值:
|
create_time |
String |
告警模板的创建时间 |
template_description |
String |
告警模板的描述,长度范围[0,256],该字段默认值为空字符串 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
请求示例
查询告警模板列表
/v2/{project_id}/alarm-templates?offset=0&limit=100
响应示例
状态码: 200
OK
{ "alarm_templates" : [ { "template_id" : "at1628592157541dB1klWgY6", "template_name" : "my_template", "template_type" : "custom", "create_time" : "2006-01-02T15:04:05.000Z", "template_description" : "hello world" } ], "count" : 100 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
参数校验失败 |
401 |
未认证 |
403 |
认证鉴权失败 |
500 |
系统内部错误 |
错误码
请参见错误码。