响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 taskID String 站点监控任务ID 64ea16644347558e9bc6651341c2fa15 请求示例 请求url /v4/monitor/modifysitemonitor 请求头header 无 请求体body json { "taskID":"64ea16644347558e9bc6651341c2fa15", "taskName":"siteMonitor1修改", "protocol":"http", "address":" "evalInterval":60, "probePoint":[ "1" ] } 响应示例 json { "statusCode":800, "returnObj":{ "taskID":"64ea16644347558e9bc6651341c2fa15" }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.SiteMonitor.SitemMonitorIDNotFound 站点ID不存在 Monitor.SiteMonitor.ProbePointNotAvailable 探测点不可用 其他 参见公共错误码说明

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj

告警联系人/组 告警联系人：发送激活验证码 接口功能介绍 调用此接口可对告警联系人发送手机短息激活验证码或邮箱激活验证码。 接口约束 1. 告警联系人ID存在。 2. 激活验证码10分钟内有效，在一个请求周期内不支持重复请求。 3. 对同一个签名的手机号：1分钟内发送短信条数不超过2条； 1小时内发送短信条数不超过10条； 1个自然日内发送短信条数不超过50。 URI POST /v4/monitor/contactactivationcode 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactID 是 String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 media 是 String 本参数表示媒介。取值范围：sms：手机短信。email：邮箱。根据以上范围取值。 sms 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b startTime 否 Integer 查询起始时间戳，默认7天前 1667815639 endTime 否 Integer 查询截止时间戳，默认当前时间 1667817639 pageNo 否 Integer 页码，默认为1 1 pageSize 否 Integer 页大小，默认为20 2

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj

请求示例 请求url /v4.1/monitor/changealarmrulesstatus 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "status":1, "alarmRuleIDList": [ "f79fe6a8284f5cd89031812b06821b9c", "eec4a76a35ba57b891c6c4fd923351d6" ] } 响应示例 json { "statusCode": 800, "returnObj": { "success": true }, "errorCode": "", "message": "Success", "msgDesc": "成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmType 是 String 本参数表示告警类型。 取值范围：series：时序指标。event：事件。 根据以上范围取值。 series service 是 String 本参数表示产品名称。取值范围：ecs：云主机。evs：云硬盘。...详见“[一键告警：产品列表]”接口返回。 ecs repeatTimes 否 Integer 重复告警通知次数，默认为0 0 silenceTime 否 Integer 告警接收策略静默时间，多久重复通知一次，单位为秒。默认值：300 300 recoverNotify 否 Integer 本参数表示恢复是否通知。默认值0。取值范围：0：否。1：是。根据以上范围取值。 0 notifyType 否 Array of Strings 本参数表示告警接收策略。取值范围：email：邮件告警。sms：短信告警。根据以上范围取值。 ['email'] contactGroupList 否 Array of Strings 告警联系人组 ['000f03221f4d8cc8bb2e1c30fb751ccc'] notifyWeekdays 否 Array of Integers 本参数表示通知周期。默认值[0,1,2,3,4,5,6]。取值范围：0：周日。1：周一。2：周二。3：周三。4：周四。5：周五。6：周六。根据以上范围取值。 [0,1,2,3,4,5,6] notifyStart 否 String 通知起始时段，默认为00:00:00 00:00:00 notifyEnd 否 String 通知结束时段，默认为23:59:59 23:59:59 webhookUrl 否 Array of Strings 告警状态变更webhook推送地址 ['

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b name 是 String 告警黑名单名称 告警黑名单123 service 是 String 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“ ecs dimension 是 String 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“ ecs desc 否 String 描述 test devices 是 Array of Strings 本参数表示设备列表。 ['xxxaadasd', 'asdasdasgfasd'] contactGroupList 是 Array of Strings 联系组列表 ['234bee0616f65b0aadb8c0903d480a58'] metrics 否 Array of Strings 指标列表 ['cpuutil', 'memutil'] startTime 否 Integer 开始时间 1687337384 endTime 否 Integer 结束时间，结束时间必须要大于开始时间 1687338884

参数 是否必填 参数类型 说明 示例 下级对象 contactGroupIDList 是 Array of Strings 告警联系人组ID列表 ['dab749c9f6b7504fac99f5a18be1de61']

响应示例 json { "statusCode": 800, "returnObj": { "success":true }, "errorCode": "", "message": "Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.AlarmBlacklist.NotFound 告警黑名单不存在 其他 参见公共错误码说明

请求示例 请求url /v4/monitor/describecontactgroup?contactGroupIDfe7f0cdc469255168d3ab06355482090 请求头header 无 请求体body 无 响应示例 json { "statusCode":800, "returnObj":{ "contactGroupID":"fe7f0cdc469255168d3ab06355482090", "name":"hEtmm", "desc":"", "contactList":[ { "contactID":"6412da6e787051c0ac93b8e5635be437", "name":"iDChG", "phone":"13309310049", "email":"123323@qq.com", "phoneActivation":0, "emailActivation":0 } ], "updateTime":1690359376000, "createTime":1690359376000 }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.ContactGroup.ContactGroupNotExist 告警联系组不存在 其他 参见公共错误码说明

errorCode 描述 其他 参见

状态码 描述 200 请求成功

参数 参数类型 说明 示例 下级对象 pointID String 拨测点ID 728662dd11ec810800155d307d52 name String 拨测点名称 northChina description String 拨测点描述 华北 status Boolean 当前是否可用 true

请求示例 请求url /v4/monitor/alertonekey/changealertconfigstatus 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "alarmRuleIDList": ["4gtd23b274e253f8869c6fe6b07b9fac"], "status": 1 } 响应示例 json { "statusCode":800, "returnObj":{ "success":true }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.AlertOnekey.AlarmRulesNotExist 部分告警规则不存在 其他 参见公共错误码说明

状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.AlarmBlacklist.NotFound 告警黑名单不存在 Monitor.AlarmBlacklist.ContactGroupNotFound 告警黑名单联系人组不存在 其他 参见公共错误码说明

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 alarmRuleID 是 String 告警规则ID 2c2472dff6335b4bbe459609fc9f8154 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b name 是 String 规则名 自定义告警规则测试 desc 否 String 描述 test evaluationCount 否 Integer 持续周期数，默认5次 2 customItemID 是 String 自定义监控指标 ITEM63cb8954325480a3202307071801 fun 是 String 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 avg operator 是 String 本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 eq value 是 String 告警阈值，可以是整数、小数或百分数格式字符串 0 period 是 String 本参数表示算法统计周期。参数fun为last时可不传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 5m dimensions 否 Array of Objects 自定义监控项维度 dimValue webhookUrl 否 Array of Strings 告警状态变更webhook推送地址 [' repeatTimes 否 Integer 重复告警通知次数，默认为0 0 silenceTime 否 Integer 告警接收策略静默时间，多久重复通知一次，单位为秒 300 recoverNotify 否 Integer 本参数表示恢复是否通知。默认值0。取值范围：0：否。1：是。根据以上范围取值。 0 notifyType 否 Array of Strings 本参数表示告警接收策略。取值范围：email：邮件告警。sms：短信告警。根据以上范围取值。 ['email','sms'] contactGroupList 否 Array of Strings 告警联系人组 ['test'] notifyWeekdays 否 Array of Integers 本参数表示通知周期。默认值[0,1,2,3,4,5,6]。取值范围：0：周日。1：周一。2：周二。3：周三。4：周四。5：周五。6：周六。根据以上范围取值。 [0,1,2,3,4,5,6] notifyStart 否 String 通知起始时段，默认为00:00:00 00:00:00 notifyEnd 否 String 通知结束时段，默认为23:59:59 23:59:59

告警规则 告警规则：停用&启用 接口功能介绍 调用此接口可批量停用/启用多个自定义监控/事件告警规则。 接口约束 告警规则存在。 URI POST /v4/monitor/changecustomalarmrulesstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleIDList 是 Array of Strings 告警规则ID列表 ['f79fe6a8284f5cd89031812b06821b9c','eec4a76a35ba57b891c6c4fd923351d6'] status 是 Integer 本参数表示规则状态。取值范围：0：启用。1：停用。根据以上范围取值。 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

告警联系人/组 告警联系人：变更所属告警联系人组列表 接口功能介绍 调用此接口可变更告警联系人所属的告警联系人组列表。 接口约束 告警联系人及告警联系人组存在。 URI POST /v4.1/monitor/updatecontactgroups 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactIDList 是 Array of Strings 告警联系人ID列表 ['a6fb570f22995bde989cdf0819c687d0'] contactGroupIDList 是 Array of Strings 告警联系人组ID列表 ['fe7f0cdc469255168d3ab06355482090'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 contactIDList String 告警联系人ID列表 ["a6fb570f22995bde989cdf0819c687d0"]

告警联系人/组 告警联系人：激活 接口功能介绍 调用此接口可激活告警联系人的手机短息或邮箱，激活后的媒介可接收平台告警信息。 接口约束 告警联系人ID存在。 URI POST /v4/monitor/activatecontact 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactID 是 String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 media 是 String 本参数表示媒介。取值范围：sms：手机短信。email：邮箱。根据以上范围取值。 sms code 是 Integer 验证码 123456 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Array of Objects 返回参数 returnObj

请求示例 请求url /v4/monitor/describenoticetemplate?noticeTemplateID315c7f8c3e4311ed8ef2005056898fe0 请求头header 无 请求体body 无 响应示例 json { "statusCode": 800, "returnObj": { "name": "test4", "service": "ecs", "dimension": "ecs", "isDefault": false, "contents": [ { "notifyType": "email", "content": "this is a content test" } ], "noticeTemplateID": "9d3b38e17bba50dd9a7e8435446028fd", "createTime": 1718180979, "updateTime": 1718180979 }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.NoticeTemplate.TemplateIDNotFound 通知模板ID不存在 其他 参见公共错误码说明

请求示例 请求url /v4/monitor/updatenoticetemplate 请求头header 无 请求体body json { "noticeTemplateID": "312b56b43e4311ed8ef2005056898fe0", "name": "xsZSu", "contents": [ { "notifyType": "email", "content": "this is a test" } ] } 响应示例 json { "statusCode": 800, "returnObj": { "success": true }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.NoticeTemplate.TemplateIDNotFound 通知模板ID不存在 Monitor.NoticeTemplate.NameAlreadyExist 通知模板名称已存在 其他 参见公共错误码说明

响应示例 json { "statusCode":800, "returnObj":{ "success":true }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.NoticeTemplate.SomeNoticeTemplatesNotFound 部分通知模板不存在 其他 参见公共错误码说明

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 alarmRuleID 是 String 告警规则ID 2c2472dff6335b4bbe459609fc9f8154 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b name 是 String 规则名 自定义告警规则测试 desc 否 String 描述 test repeatTimes 否 Integer 重复告警通知次数，默认为0 0 silenceTime 否 Integer 告警接收策略静默时间，多久重复通知一次，单位为秒 300 recoverNotify 否 Integer 本参数表示恢复是否通知。默认值0。取值范围：0：否。1：是。根据以上范围取值。 0 notifyType 否 Array of Strings 本参数表示告警接收策略。取值范围：email：邮件告警。sms：短信告警。根据以上范围取值。 ['email','sms'] contactGroupList 否 Array of Strings 告警联系人组 ['test'] notifyWeekdays 否 Array of Integers 本参数表示通知周期。默认值[0,1,2,3,4,5,6]。取值范围：0：周日。1：周一。2：周二。3：周三。4：周四。5：周五。6：周六。根据以上范围取值。 [0,1,2,3,4,5,6] notifyStart 否 String 通知起始时段，默认为00:00:00 00:00:00 notifyEnd 否 String 通知结束时段，默认为23:59:59 23:59:59 webhookUrl 否 Array of Strings 告警状态变更webhook推送地址 [' customEventID 是 String 自定义事件ID EVENT63cb8954325480a320230707180 value 是 String 出现次数，告警阈值，整数格式字符串 1 period 是 String 本参数表示算法统计周期。参数fun为last时可不传。本参数格式为“数字+单位”。最大周期为24小时。单位取值范围：m：分钟。h：小时。根据以上范围取值。 5m