告警联系人/组 告警联系人：激活 接口功能介绍 调用此接口可激活告警联系人的手机短息或邮箱，激活后的媒介可接收平台告警信息。 接口约束 告警联系人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

事件监控 事件监控：查询列表 接口功能介绍 根据指定时间段查询事件发生情况。 接口约束 regionID、startTime、endTime、eventNameList、dimension、service存在。 URI POST /v4/monitor/events/querylist 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID 81f7728662dd11ec810800155d307d5b eventNameList 否 Array of Strings 本参数表示事件指标列表，事件指标见查询事件接口返回。不传，默认全部事件指标 ['migrationeventcomplete','migrationeventstart'] service 是 String 服务，见事件监控：查询服务维度接口返回。 ecs dimension 是 String 维度，见事件监控：查询服务维度接口返回。 ecs startTime 是 Integer 查询起始时间戳 1647424660 endTime 是 Integer 查询截止时间戳 1647424660 pageNo 否 Integer 页码，默认为1 1 pageSize 否 Integer 页大小，默认为20 2 resGroupID 否 String 资源分组ID，在资源分组事件时传入 9cb2b3301dd85ec49c6db07fe65a9aca 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount Integer 获取对象数据条数 14 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 eventList Array of Objects 事件列表 eventObj 表 eventObj 参数 参数类型 说明 示例 下级对象 eventName String 事件指标 migrationeventstart description String 事件中文描述 云主机迁移发生 eventTime Integer 事件最后发生事件时间,秒级时间戳 1647424660 eventCount Integer 事件数量 5

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

请求示例 请求url /v4/monitor/copyalramtemplate 请求头header 无 请求体body json { "templateID":"312b56b43e4311ed8ef2005056898fe0", "regionID": "81f7728662dd11ec810800155d307d5b", "name":"xsZSu", "desc":"test" } 响应示例 json { "statusCode":800, "returnObj":{ "templateID":"03c07784540711ed8268005056897257" }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.AlarmTemplate.TemplateIDNotFound 告警模板ID不存在 Monitor.AlarmTemplate.NameAlreadyExist 告警模板名称已存在 Monitor.AlarmTemplate.QuotaLimit 告警模板配额已达上限 其他 参见公共错误码说明

参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

参数 参数类型 说明 示例 下级对象 token String token 1411668ec8c13f57472576d5d1603226

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b queryContent 否 String 名称模糊搜索 temp services 否 Array of Strings 本参数表示展示出来的服务。默认返回所有服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警模板：获取告警模板服务维度关系”接口返回中的服务。 ['ecs'] templateType 否 String 本参数表示模板类型。默认all。取值范围：system：系统默认。custom：自定义。all：所有。根据以上范围取值。 all pageNo 否 Integer 页码，默认为1 1 page 否 Integer 页码，默认为1，建议使用pageNo，该参数后续会下线 1 pageSize 否 Integer 页大小，默认为10 2

参数 是否必填 参数类型 说明 示例 下级对象 contactGroupID 是 String 告警联系人组ID cf21ea17e31d5f47bf106c489a86f67d

监控看板 监控看板：更新视图 接口功能介绍 更新已有监控视图。 接口约束 参见请求参数说明。 URI POST /v4/monitor/monitorboard/updateview 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b viewID 是 String 监控视图ID 58631437d4897105d9ac9bc044d7b6ab view 是 Object 监控视图更新内容 view 表 view 参数 是否必填 参数类型 说明 示例 下级对象 name 是 String 监控视图名称 名称 service 是 String 云监控服务 ecs dimension 是 String 云监控维度 ecs viewType 是 String 视图类型。取值范围:timeSeries：折线图。gauge：仪表盘。barChart：柱状图。table：表格。pieChart：饼状图。根据以上范围取值。 timeSeries orderIndex 否 Integer 视图排序次数。默认值为0。 0 itemNameList 是 Array of Strings 监控指标，指标项最多支持20个，当viewType为gauge和pieChart时，仅支持单监控指标 ['cpuutil'] compares 否 Array of Strings 同比环比比较时间配置，格式为“数字+单位”，单位为空时默认为秒。当前只支持1d和7d。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 ['1d'] resources 是 Array of Objects 监控资源实例，监控资源实例最多支持20个，当viewType为gauge时，仅支持单资源实例 resource gaugePattern 否 Object 仪表盘配置，仅当viewType为gauge时生效 gaugePattern 表 resource 参数 是否必填 参数类型 说明 示例 下级对象 resource 是 Array of Objects 资源 obj 表 obj 参数 是否必填 参数类型 说明 示例 下级对象 key 是 String 资源键 uuid value 是 String 资源键对应的值 xxxx 表 gaugePattern 参数 是否必填 参数类型 说明 示例 下级对象 minVal 否 Integer 仪表盘最小值。默认值为0 0 maxVal 否 Integer 仪表盘最大值。默认值为100 100 threshold 否 Array of Integers 仪表盘中间分段取值，长度必须为2。默认值为[30,80] [30,80]

请求示例 请求url /v4/monitor/marknoticetemplateisdefault 请求头header 无 请求体body json { "noticeTemplateID": "312b56b43e4311ed8ef2005056898fe0", "isDefault": false } 响应示例 json { "statusCode": 800, "returnObj": { "success": true }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.NoticeTemplate.TemplateIDNotFound 通知模板ID不存在 Monitor.NoticeTemplate.DefaultNoticeTemplateAlreadyExist 自定义默认通知模板已存在 其他 参见公共错误码说明

参数 是否必填 参数类型 说明 示例 下级对象 startTime 否 Integer 创建通知起始时间，精确到毫秒 1690428579920 endTime 否 Integer 创建通知截止时间，精确到毫秒（截止时间与起始时间间隔不超过30天） 1690855839000

请求示例 请求url /v4/monitor/querymessagerecords 请求头header 无 请求体body 无 响应示例 json { "statusCode": 800, "returnObj": { "MessageRecords": [ { "recordID": "653226259d6c887fdafa8c61", "receiver": "test@chinatelecom.cn", "recordType": 0, "method": "email", "recordStatus": 0, "subject": "【一键报警】cpu使用率告警通知规则ID（6520c2528d4ae066080a34f0）", "content": "[完成处理]尊敬的天翼云用户，云监控告警提醒：告警状态已恢复"正常"n告警名称：【一键报警】cpu使用率n监控指标：cpuutil 【CPU使用率】n告警描述：无描述n资源池名称：内蒙azn监控对象：【监控对象：ALL】n首次触发时间：20231008 10:12:00nnsystem 完成处理n问题 5 分钟无更新，系统自动关闭n", "errMessage": "", "createTime": 1697785381111 } ], "totalCount": 1, "currentCount": 1, "totalPage": 1 }, "errorCode": "", "message": "Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

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

状态码 描述 200 请求成功

参数 是否必填 参数类型 说明 示例 下级对象 contactGroupID 是 String 告警联系人组ID a6fb570f22995bde989cdf0819c687d0

参数 是否必填 参数类型 说明 示例 下级对象 taskIDList 是 Array of Strings 站点监控任务ID列表 ['64ea16644347558e9bc6651341c2fa15']

通知模板 通知模板：查询列表 接口功能介绍 调用此接口可查询通知模板列表。 接口约束 参见请求参数说明。 URI GET /v4/monitor/querynoticetemplates 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 service 否 String 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 ecs dimension 否 String 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 ecs name 否 String 名称模糊搜索 template pageNo 否 Integer 页码，默认为1 1 pageSize 否 Integer 页大小，默认为10 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 noticeTemplateList Array of Objects 通知模板 noticeTemplate totalCount Integer 总记录数 20 currentCount Integer 当前页记录数 10 totalPage Integer 总页数 2 pageNo Integer 页码 1 pageSize Integer 页大小 10 表 noticeTemplate 参数 参数类型 说明 示例 下级对象 noticeTemplateID String 通知模板ID 315c7f8c3e4311ed8ef2005056898fe0 name String 通知模板名称 bzmcV service String 服务 ecs dimension String 维度 ecs contents Array of Objects 通知模板 content isDefault Boolean 是否为自定义默认通知模板 false createTime Integer 创建时间，时间戳，精确到秒 1667459789 updateTime Integer 最近更新时间，时间戳，精确到秒 1667459789 表 content 参数 参数类型 说明 示例 下级对象 content String 通知模板内容 this is content notifyType String 本参数表示通知方式。取值范围：sms：短信。email：邮件。 根据以上范围取值。 sms

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b name 是 String 监控项名称，必须420个字符，支持中英文、数字、下划线，且不能以数字开头。同一用户在同一资源池下不能重复 我的CPU使用率 unit 是 String 自定义监控项的单位 % interval 是 Integer 数据上报间隔，单位秒 60 dimensions 否 Array of Objects 用于查询监控数据的维度，目前最多支持三个维度 dimensions

错误码 errorCode 描述 其他 请参考 错误码

参数 参数类型 说明 示例 下级对象 service String 产品服务 ecs dimension String 产品维度 ecs serviceDesc String 产品服务描述 云主机 dimensionDesc String 产品维度描述 云主机 count Integer 告警次数 10

请求示例 请求url /v4/monitor/queryalerthistoryinfo?issueID65b08a5848091836a6f2afd8 请求头header 无 请求体body 无 响应示例 json { "statusCode":800, "returnObj":[ { "resource":[ { "name":"vpngatewayid", "value":"13f47d3b8e1856dba8d775be184964f5" } ], "infoID":"65b08a5848091836a6f2afd9", "service":"ipsecvpn", "dimension":"ipsecvpngwstats", "condition":{ "metric":"vpngwinbps", "metricCnName":"VPN网关入方向流量速率", "period":"5m", "fun":"avg", "operator":"eq", "threshold":"0", "unit":"" }, "createTime":1706068568, "updateTime":1706079352, "value":0, "status":0, "alarmType": "series", "count":0 } ], "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.AlertHistory.ExportError 告警历史导出失败 其他 参见公共错误码说明

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID 81f7728662dd11ec810800155d307d5b startTime 是 Integer 查询起始时间戳 1647424660 endTime 是 Integer 查询截止时间戳 1647424660 eventName 是 String 本参数表示事件指标，事件指标见查询事件接口返回。 migrationeventstart service 是 String 服务，见事件监控：查询服务维度接口返回。 ecs dimension 是 String 维度，见事件监控：查询服务维度接口返回。 ecs pageNo 否 Integer 页码，默认为1 1 pageSize 否 Integer 页大小，默认为20 2 resGroupID 否 String 资源分组ID，在资源分组事件时传入 9cb2b3301dd85ec49c6db07fe65a9aca

参数 是否必填 参数类型 说明 示例 下级对象 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 告警联系人组 ['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推送地址 [' 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均需填此参数。本参数格式为“数字+单位”。最大周期为24小时。单位取值范围：m：分钟。h：小时。根据以上范围取值。 5m dimensions 否 Array of Objects 自定义监控项维度 dimValue

资源分组 资源分组：删除 接口功能介绍 调用此接口可删除指定资源分组。 接口约束 参见请求参数说明。 URI POST /v4.1/monitor/deleteresourcegroups 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b resGroupIDList 是 Array of Strings 资源分组ID列表 ['95f7f0cbb5d7547e86673fceeab177d5'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true

请求示例 请求url /v4.1/monitor/describeresourcegroup?resGroupID95f7f0cbb5d7547e86673fceeab177d5 请求头header 无 请求体body 无 响应示例 json { "statusCode": 800, "returnObj": { "regionID": "81f7728662dd11ec810800155d307d5b", "resGroupID": "c8c4df5bd25050298047673ede4da229", "name": "vmresgroup", "desc": "this is a desc", "createType": "instance", "resourceList": [ { "resources": [ { "resource": [ { "name": "instancename", "value": "ecm2" }, { "name": "uuid", "value": "2e8ad1263f0811ed95a4acde48001122" } ], "status": 0 } ], "service": "ecs", "dimension": "ecs", "resourcesTotal": 1, "alarmNum": 0 } ], "alarmStatus": 0, "totalAlarm": 0, "totalRule": 0, "totalResource": 1, "totalResourceType": 1, "createTime": 1723172129, "updateTime": 1723195098 }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.ResourceGroup.ResourceGroupNotExist 资源分组不存在 其他 参见公共错误码说明