一类节点--数据传输服务dts-查询告警规则列表
接口功能介绍
查询告警规则列表
接口约束
无
URI
GET /dts/v1/open-api/alarm/query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 否 | Integer | 页码，默认值为0 | 0 | |
| pageSize | 否 | Integer | 每页数据条数，默认值为20 | 20 | |
| projectId | 否 | String | 企业项目id，默认为0对应企业项目default | 0 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 | 0 | |
| error | String | 错误码 | DTS_9999 | |
| message | String | 返回消息 | 成功 | |
| returnObj | Object | 返回数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| list | Array of Objects | 数量列表 | list | |
| pagination | Object | 分页信息 | pagination |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleId | Integer | 告警规则id | 1 | |
| ruleName | String | 告警名称 | DTS任务同步时延过大 | |
| alarmItemId | Long | 告警项id | 1 | |
| type | String | 告警项类型，可选值：THRESHOLD/EVENT | THRESHOLD | |
| dimension | String | 告警维度，可选值：INSTANCE/USER | INSTANCE | |
| prodInstId | String | 实例id | instance1 | |
| jobId | Integer | 任务id | 1 | |
| interval | Integer | 告警间隔 | 3 | |
| valueType | String | 阈值比较类型，可选值：INSTANT | INSTANT | |
| operator | String | 阈值比较运算符 | >= | |
| threshold | String | 阈值 | 10.0 | |
| unit | String | 阈值单位 | s | |
| emailAddress | String | 接收邮件地址 | example@mail.com | |
| maxSendTimes | Integer | 最大告警次数 | 5 | |
| smsOn | Boolean | 短信告警开关 | true | |
| emailOn | Boolean | 邮件告警开关 | true | |
| enable | Boolean | 禁用或启用告警规则 | true |
表 pagination
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageNo | Integer | 当前页码 | 0 | |
| pageSize | Integer | 当前页面数据条数 | 20 | |
| totalCount | Integer | 数据总条数 | 2 | |
| totalPageCount | Integer | 总页数 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":0,
"message":"成功",
"returnObj":{
"list":[
{
"prodInstId":null,
"jobId":null,
"ruleId":1,
"ruleName":"DTS任务同步时延过大",
"alarmItemId":3,
"type":"THRESHOLD",
"dimension":"USER",
"level":"WARN",
"interval":3,
"valueType":"INSTANT",
"operator":">=",
"threshold":"10.0",
"unit":"s",
"emailAddress":"example2@mail.com",
"maxSendTimes":5,
"smsOn":false,
"emailOn":true,
"switch":"OFF"
},
{
"prodInstId":null,
"jobId":1,
"ruleId":2,
"ruleName":"DTS迁移任务状态异常",
"alarmItemId":2,
"type":"THRESHOLD",
"dimension":"INSTANCE",
"level":"WARN",
"interval":3,
"valueType":"INSTANT",
"operator":">=",
"threshold":"10.0",
"unit":"s",
"emailAddress":"example@mail.com",
"maxSendTimes":3,
"smsOn":true,
"emailOn":true,
"switch":"ON"
}
],
"pagination":{
"pageNo":0,
"pageSize":20,
"totalCount":2,
"totalPageCount":1
}
},
"error":""
}
