巡检订阅：查询
更新时间 2026-09-07 16:07:31
最近更新时间: 2026-09-07 16:07:31
接口功能介绍
调用此接口可查询巡检订阅列表。
接口约束
参见请求参数说明。
URI
POST /v4/monitor/cloud-inspection/query-subscriptions
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 否 | String | 巡检订阅名称，支持模糊搜索 | 云主机 | |
| status | 否 | Boolean | 本参数表示巡检订阅状态。取值范围： true：启用。 false：停用。 根据以上范围取值。 | true | |
| pageNo | 否 | Integer | 页码，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，默认10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| subscriptions | Array of Objects | 巡检订阅列表 | subscriptionObj | |
| totalCount | Integer | 总记录数 | 20 | |
| currentCount | Integer | 当前页记录数 | 5 | |
| totalPage | Integer | 总页数 | 3 | |
| subscriptionQuota | Integer | 巡检订阅配额剩余数量 | 5 |
表 subscriptionObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| subscriptionID | String | 巡检订阅ID | 491db3f4-1d80-aef0-a1c4-4b11386b6890 | |
| name | String | 方案名称 | test | |
| status | Boolean | 本参数表示巡检订阅状态。取值范围： true：启用。 false：停用。 根据以上范围取值。 | true | |
| updateTime | Long | 更新时间，秒级 | 1775524611 | |
| contactGroupList | Array of Strings | 告警联系组ID列表 | ["c3ff19a4-83b9-4bc6-a4b0-8486cd3bd959"] | |
| notice | Object | 通知配置对象 | noticeObj |
表 noticeObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| noticeContactGroup | Object | 通知联系组 | noticeContactGroupObj | |
| noticeFrequency | String | 通知频率：day（每天）、week（每周） | day | |
| day | Integer | 每周的星期，0-6（仅周频使用） | 1 | |
| hour | Integer | 每天的小时，0-23 | 17 | |
| isNotice | Boolean | 是否发送通知 | true | |
| noticePolicy | Object | 通知策略 | noticePolicyObj |
表 noticeContactGroupObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| defaultContact | Integer | 是否使用默认联系人，0否1是 | 0 | |
| contactGroupList | Array of Strings | 告警联系组 | ["c3ff19a4-83b9-4bc6-a4b0-8486cd3bd959"] | |
| notifyType | Array of Strings | 通知接收策略（email/sms/voice） | ["sms", "voice"] | |
| voiceCallType | Integer | 语音通知拨打方式，0同时拨打，1按顺序拨打 | 0 | |
| answerPrompt | Integer | 语音通知接听提示，0关闭，1开启 | 0 |
表 noticePolicyObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| score | Integer | 巡检得分阈值 | 80 | |
| logicalOperator | String | 策略逻辑关系（or/and） | and | |
| highRiskCount | Integer | 高风险数量阈值 | 5 |
枚举参数
无
请求示例
请求url
/v4/monitor/cloud-inspection/query-subscriptions
请求头header
无
请求体body
{
"status": true
}
响应示例
{
"statusCode": 800,
"returnObj": {
"subscriptions": [
{
"subscriptionID": "491db3f4-1d80-aef0-a1c4-4b11386b6890",
"name": "test",
"status": true,
"updateTime": 1775524611,
"contactGroupList": [
"c3ff19a4-83b9-4bc6-a4b0-8486cd3bd959",
"abbed7c8-1343-4c70-97a3-d09e2fe71af3"
],
"notice": {
"noticeContactGroup": {
"defaultContact": 0,
"contactGroupList": [
"c3ff19a4-83b9-4bc6-a4b0-8486cd3bd959",
"abbed7c8-1343-4c70-97a3-d09e2fe71af3"
],
"notifyType": [
"sms",
"voice"
],
"voiceCallType": 0,
"answerPrompt": 0
},
"noticeFrequency": "day",
"day": 0,
"hour": 17,
"isNotice": true,
"noticePolicy": {
"score": 80,
"logicalOperator": "and",
"highRiskCount": 5
}
}
}
],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1,
"subscriptionQuota": 9
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码
