一类节点--数据传输服务dts-创建告警规则
接口功能介绍
创建DTS任务的告警规则。
接口约束
无
URI
POST /dts/v1/open-api/alarm/create
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| alarmItemId | 是 | Integer | 告警项ID。调用【查询所有的告警项】接口获取可用的告警项 | 1 | |
| type | 是 | String | 告警项类型，可选值：EVENT, THRESHOLD | THRESHOLD | |
| ruleName | 是 | String | 名称 | DTS迁移任务状态异常 | |
| dimension | 是 | String | 告警维度，可选值：USER, INSTANCE | INSTANCE | |
| prodInstId | 否 | String | 实例id，当告警维度为INSTANCE时为必填。注意实例必须已经配置 | instance1 | |
| jobId | 否 | Integer | 任务id，当告警维度为INSTANCE时为必填。注意实例必须已经配置 | 1 | |
| level | 是 | String | 告警级别，可选值：INFO, WARN, CRITICAL | CRITICAL | |
| interval | 否 | Integer | 告警间隔，告警类型为THRESHOLD时必填 | 3 | |
| valueType | 否 | String | 阈值比较类型，告警类型为THRESHOLD时必填，可选值：INSTANT | INSTANT | |
| operator | 否 | String | 阈值比较运算符，告警类型为THRESHOLD时必填，可选值：>, >=, <, <= | >= | |
| threshold | 否 | String | 阈值，告警类型为THRESHOLD时必填，为数值类型的字符串且大于0 | 10 | |
| unit | 否 | String | 阈值单位，告警类型为THRESHOLD时必填，unit可选值为：s，m，h | s | |
| emailAddress | 否 | String | 接收邮件地址，当emailOn为true时必填 | 'example@mail.com' | |
| maxSendTimes | 是 | Integer | 最大告警次数 | 10 | |
| smsOn | 是 | Boolean | 短信告警开关，可选值：true, false | true | |
| emailOn | 是 | Boolean | 邮件告警开关，可选值：true, false | true | |
| enable | 是 | Boolean | 开关启用，可选值：true,false | true | |
| projectId | 否 | String | 企业项目id，告警维度为USER时，如果不传递该参数，则默认为0对应企业项目default；告警维度为INSTANCE时，如果不传递该参数，则默认为当前实例对应的企业项目。 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 | 0 | |
| error | String | 错误码 | DTS_9999 | |
| message | String | 返回消息 | 成功 | |
| returnObj | Object | 返回数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleId | Integer | 告警规则id | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"alarmItemId":2,
"type":"THRESHOLD",
"ruleName":"DTS迁移任务状态异常",
"dimension":"INSTANCE",
"jobId":1,
"prodInstId":"1",
"level":"WARN",
"interval":3,
"valueType":"INSTANT",
"operator":">=",
"threshold":10,
"unit":"s",
"emailAddress":"example@mail.com",
"maxSendTimes":3,
"smsOn":true,
"emailOn":true,
"enable":true
}
响应示例
{
"statusCode":0,
"message":"成功",
"returnObj":{
"ruleId":1
},
"error":""
}
