巡检订阅：修改
更新时间 2026-09-07 16:08:10
最近更新时间: 2026-09-07 16:08:10
接口功能介绍
调用此接口可修改巡检订阅。
接口约束
参见请求参数说明。
URI
POST /v4/monitor/cloud-inspection/update-subscription
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| subscriptionID | 是 | String | 订阅ID | 191db3f4-1d80-aef0-a1c4-4b11386b6892 | |
| name | 是 | String | 订阅名称，2-40个字符 | test | |
| planID | 是 | String | 巡检方案ID | 191db3f4-1d80-aef0-a1c4-4b11386b6890 | |
| notice | 是 | Object | 通知配置 | noticeObj |
表 noticeObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| noticeContactGroup | 否 | Object | 通知联系组 | noticeContactGroupObj | |
| noticeFrequency | 是 | String | 本参数表示通知频率。取值范围： day：每天。 week：每周。 根据以上范围取值。 | day | |
| day | 否 | Integer | 本参数表示每周的具体星期。默认0。取值范围： 0：周日。 1：周一。 2：周二。 3：周三。 4：周四。 5：周五。 6：周六。 根据以上范围取值。 | 0 | |
| hour | 否 | Integer | 本参数表示每天的具体小时。默认0。取值范围0-23 | 0 | |
| isNotice | 是 | Boolean | 本参数表示是否通知。取值范围： true：是。 false：否。 根据以上范围取值。 | true | |
| noticePolicy | 是 | Object | 通知策略，当通知时必填 | noticePolicyObj |
表 noticeContactGroupObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| defaultContact | 否 | Integer | 是否使用天翼云默认联系人接收通知，默认值0，取值范围： 0：否。 1：是。 根据以上范围取值。 | 0 | |
| contactGroupList | 否 | Array of Strings | 告警联系组 | ||
| notifyType | 否 | Array of Strings | 本参数表示通知接收策略。取值范围： email：邮件。 sms：短信。 voice：语音。 根据以上范围取值。 | ||
| voiceCallType | 否 | Integer | 本参数表示语音通知时拨打方式，默认值：0。取值范围： 0：联系组内联系人同时拨打。 1：联系组内联系人按顺序依次拨打，任意用户拨通即终止。 根据以上范围取值。 | 0 | |
| answerPrompt | 否 | Integer | 本参数表示语音通知时是否开启接听提示，默认值：0。 注意：当语音通知拨打方式voiceCallType等于0时，answerPrompt不可为1。 取值范围： 0：不开启。 1：开启。 根据以上范围取值。 | 0 |
表 noticePolicyObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| score | 是 | Integer | 巡检得分 | 80 | |
| logicalOperator | 是 | String | 本参数表示策略的逻辑关系。取值范围： or：或。 and：与。 根据以上范围取值。 | and | |
| highRiskCount | 是 | Integer | 高风险数量 | 5 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 启用成功标识 | true |
枚举参数
无
请求示例
请求url
/v4/monitor/cloud-inspection/create-subscription
请求头header
无
请求体body
{
"subscriptionID": "191db3f4-1d80-aef0-a1c4-4b11386b6892",
"name": "每日巡检提醒",
"planID": "191db3f4-1d80-aef0-a1c4-4b11386b6890",
"notice": {
"noticeContactGroup": {
"defaultContact": 0,
"contactGroupList": [],
"notifyType": ["email"]
},
"isNotice": false,
"noticeFrequency": "day",
"hour": 18
}
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
请参考 状态码
错误码
请参考 错误码
