一类节点--数据传输服务dts-查询所有的告警项
接口功能介绍
查询告警配置的所有告警项。
接口约束
无
URI
GET /dts/v1/open-api/alarm/list-item
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 | 0 | |
| error | String | 错误码 | DTS_9999 | |
| message | String | 返回消息 | 成功 | |
| returnObj | Array of Objects | 返回数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | id | 1 | |
| name | String | 告警项名称。 | ||
| 使用规则约定：SYNC开头的用于同步任务，MIG开头的用于迁移任务，SUBSCRIBE开头的用于订阅任务 | SYNC_DELAY_TIME | |||
| desc | String | 告警项具体说明 | 同步时延过大 | |
| type | String | 告警项类型 | THRESHOLD | |
| dimension | String | 告警项维度 | ALL | |
| uint | String | 单位 | s |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":0,
"message":"成功",
"returnObj":[
{
"id":5,
"name":"SYNC_DELAY_TIME",
"desc":"同步时延过大",
"type":"THRESHOLD",
"dimension":"ALL",
"unit":"h"
},
{
"id":4,
"name":"SUBSCRIBE_STATUS_ERROR",
"desc":"订阅任务状态异常",
"type":"EVENT",
"dimension":"ALL",
"unit":""
},
{
"id":3,
"name":"SYNC_STATUS_ERROR",
"desc":"同步任务状态异常",
"type":"EVENT",
"dimension":"ALL",
"unit":""
},
{
"id":2,
"name":"MIG_STATUS_ERROR",
"desc":"迁移任务状态异常",
"type":"EVENT",
"dimension":"ALL",
"unit":""
}
],
"error":""
}
