参数 参数类型 说明 示例 下级对象 instanceID String 共享带宽实例ID bandwidthxadwzslpkw instanceName String 共享带宽实例名称 bandwidth78a4 deviceUUID String 唯一标识ID bandwidthxadwzslpkw

接口功能介绍 调用此接口可查询更新资源分组名称和备注。 接口约束 资源分组存在。 URI POST /v4/monitor/updateresourcegroupnamedescribe 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID resGroupID String 是 95f7f0cbb5d7547e86673fceeab177d5 资源分组ID name String 否 资源分组1 资源分组名称 desc String 否 描述 资源分组描述 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 resGroupID String 分组ID "0134af8f44bf50dfbb0c9ad642612830"

请求示例 GET /v4/monitor/querysitemonitor?regionID81f7728662dd11ec810800155d307d5b 响应示例 json { "statusCode":800, "returnObj":{ "pointList":[ { "mongoID":"635a4a3869bdc841ab0495dd", "ID":"1", "name":"NeiMeng", "hermesRegion":"neimengaz03", "position":"内蒙", "status":true } ], "totalCount":1 }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

接口功能介绍 调用此接口可清空资源分组中某些类型资源。 接口约束 资源分组已存在。 URI POST /v4/monitor/trancateresourcegroup 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID resGroupID String 是 95f7f0cbb5d7547e86673fceeab177d5 资源分组ID deviceTypeList Array of String 是 ["vm"] 要清空的设备类型列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 请求示例 POST /v4/monitor/trancateresourcegroup 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "resGroupID": "5ce993cb71c65ef0a386879b6f183979", "deviceTypeList": ["vm"] ] }

请求示例 GET /v4/monitor/queryitemtotal?regionID81f7728662dd11ec810800155d307d5b 响应示例 json { "statusCode":800, "returnObj":{ "ecs":33, "evs":37, "pms":0, "scaling":1, "ippool":16, "elb":7, "totalCunt":94 }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

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

请求示例 GET /v4/monitor/queryresourcegroup 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "resGroupID": "7d8cb36aa96552fab1dabcbae776bb16" } 响应示例 json { "statusCode":800, "returnObj": { "result": [{ "resGroupID": "7d8cb36aa96552fab1dabcbae776bb16", "name": "testupdate", "desc": "xxxx", "regionID": "81f7728662dd11ec810800155d307d5b", "status": 0, "ruleTotal":0, "lastChange": "20230411T12:32:17Z" }], "totalCount": 1, "currentCount": 1, "totalPage": 1 }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为10

errorCode 描述 其他 参见

参数 参数类型 说明 示例 下级对象 page Integer 页码 1 pageSize Integer 页大小 6 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 totalCount Integer 弹性伸缩组总记录数 1 list Array of Objects 弹性伸缩组资源列表 scaling

参数 参数类型 说明 示例 下级对象 ecs Integer 云主机告警数量 0 evs Integer 云硬盘告警数量 0 scaling Integer 弹性伸缩告警数量 0 pms Integer 物理机告警数量 0 ippool Integer 弹性ip和共享带宽的告警数量 0 elb Integer 负载均衡告警数量 0 totalCount Integer 总告警数量 0

请求示例 GET /v4/monitor/queryecslist?regionID81f7728662dd11ec810800155d307d5b&page1&pageSize3 响应示例 json { "statusCode": 800, "returnObj": { "page": 1, "pageSize": 3, "totalPage":10, "currentCount":3, "totalCount": 30, "list": [ { "deviceUUID": "478349bf557626d23612d47d72aa4d85", "instanceID": "478349bf557626d23612d47d72aa4d85", "instanceName": "ecm120fxstset" }, { "deviceUUID": "6bad8880c9dc6f862494725351eab69a", "instanceID": "6bad8880c9dc6f862494725351eab69a", "instanceName": "ecm7626" }, { "deviceUUID": "8603be6c57d7bc22a5e0bb42cbe69281", "instanceID": "8603be6c57d7bc22a5e0bb42cbe69281", "instanceName": "ecm7626" } ] }, "errorCode": "", "message": "Success", "msgDesc": "成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

状态码 描述 200 请求成功

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

errorCode 描述 其他 参见

参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为10

参数 参数类型 说明 示例 下级对象 listenerList Array of Objects 监听器资源列表 listener totalCount Integer 获取对象数据条数 138 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10

参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为10

接口功能介绍 调用此接口可根据筛选条件查询资源池下对象存储存储桶的列表。 接口约束 regionID（资源池）存在。 URI GET /v4/monitor/queryzosbucketlist 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID pageNo Integer 否 1 页码，默认为1 pageSize Integer 否 5 每页大小，默认为10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 zosBucketList Array of Objects 对象存储存储桶资源列表 zosBucket totalCount Integer 总数 15 currentCount Integer 当前页记录数 5 totalPage Integer 总页数 3 表 zosBucket 参数 参数类型 说明 示例 下级对象 instanceID String 对象存储存储桶实例ID bucket536f instanceName String 对象存储存储桶实例名称 bucket536f deviceUUID String 唯一标识ID bucket536f

请求示例 GET /v4/monitor/queryzosuserlist?regionID81f7728662dd11ec810800155d307d5b&pageNo1&pageSize5 响应示例 json { "statusCode":800, "returnObj":{ "zosUserList":[ { "instanceID":"866a2a5d71044e239c47bf8c17c00686", "instanceName":"test@163.com", "deviceUUID":"8080412d0c765867b9f96dbd86f5cdd2" } ], "totalCount":1, "currentCount":1, "totalPage":1 }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 其他 参见公共错误码说明

参数 是否必填 参数类型 说明 示例 下级对象 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

请求示例 请求url /v4/monitor/modifycustomevent 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "customEventID": "Event793d5923652be6ce202306291409", "name": "新的主机异常事件", "description": "这是一条对主机异常关机事件的新描述" } 响应示例 json { "statusCode":800, "returnObj":{ "customEventID":"Event793d5923652be6ce202306291409" }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功 错误码 errorCode 描述 Monitor.CustomEvent.NameAlreadyExist 事件名称已存在，不能重复 Monitor.CustomEvent.EventIDNotFound 事件ID不存在 其他 参见公共错误码说明

告警规则 自定义事件告警规则：查看详情 接口功能介绍 查看自定义事件告警规则的详情信息。 接口约束 regionID（资源池）和alarmRuleID（告警规则）存在。 URI GET /v4/monitor/describecustomeventalarmrule 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID 是 String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 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 告警联系人组 ['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推送地址 [' customEventID String 自定义事件ID EVENT63cb8954325480a320230707180 value String 出现次数，告警阈值，整数格式字符串 1 period String 本参数表示算法统计周期。默认值5m。本参数格式为“数字+单位”。最大周期为24小时。单位取值范围：m：分钟。h：小时。根据以上范围取值。 5m status Integer 本参数表示告警规则启用状态。取值范围：0：启用。1：停用。根据以上范围取值。 0 alarmStatus Integer 本参数表示告警规则告警状态。取值范围：0：正常。1：正在告警。根据以上范围取值。 0 createTime Integer 创建时间 1689580180000 updateTime Integer 更新时间 1689580180000

自定义事件 自定义事件：查询 接口功能介绍 调用此接口可查询自定义事件。 接口约束 资源池ID不能为空。 URI GET /v4/monitor/querycustomevents 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b customEventID 否 String 自定义事件ID ITEM793d5923652be6ce202306291409 name 否 String 事件名称，支持模糊搜索 我的CPU使用率 pageNo 否 Integer 页码，不传默认为1 1 pageSize 否 Integer 每页大小，不传默认为20 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 customEventList Array of Objects 自定义事件列表 customEvent totalCount Integer 总记录数 2 totalPage Integer 总页数 1 currentCount Integer 当前记录数 2 表 customEvent 参数 参数类型 说明 示例 下级对象 regionID String 资源池ID 81f7728662dd11ec810800155d307d5b customEventID String 自定义事件ID ITEM793d5923652be6ce202306291409 name String 事件名称 异常 description String 事件描述 用于描述主机在异常情况下被关闭的事件 createTime Integer 创建时间戳，精确到毫秒 1667815639000 updateTime Integer 修改时间戳，精确到毫秒 1667815659000

自定义事件 自定义事件：创建 接口功能介绍 调用此接口可创建自定义事件。 接口约束 资源池ID，事件名称不能为空。 URI POST /v4/monitor/createcustomevent 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b name 是 String 事件名称，必须420个字符，支持中英文、数字、下划线，且不能以数字开头。同一用户在同一资源池下不能重复 主机异常事件 description 否 String 事件描述，最多50个字符 用于描述主机在异常情况下被关闭的事件 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 customEventID String 自定义事件ID EVENTacd8b6b4610b97d202306301808

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

参数 是否必填 参数类型 说明 示例 下级对象 taskID 是 String 任务ID acd8b6b4610b97d202306301808 type 是 String 本参数表示拨测任务类型。取值范围：http：http探测。ping：ping探测。mtr：mtr探测。traceroute：traceroute探测。根据以上范围取值。 http

介绍日志存储的操作步骤。 适用场景 媒体存储提供日志存储功能，可以通过日志存储功能，将操作日志按照固定的命名规则，以5分钟为单位写入指定的Bucket。 前提条件 已注册天翼云账号。 已开通媒体存储的对象存储能力。 登录媒体存储控制台。 适用区域 本功能目前仅部分资源池支持，具体可参考：资源池与区域节点。 如需使用，可联系客户经理或提交工单申请。 使用说明 目前日志存储为内测功能，如需使用，可联系您的客户经理或媒体存储技术团队。 日志文件记录的是通过API或SDK方式进行的S3操作。 生成的日志文件会保存在指定的存储桶，占用存储空间，因此会产生存储费用。如需定时清理，可通过生命周期相关配置实现，具体可参考：生命周期。 日志文件生成规则： 日志文件存储路径：日志存储位置 /日志文件前缀（如无设置则省略）/YYYY MM DD HHmmssUniqueStiring 。 生成周期：启用规则后开始生成，并且以5分钟为单位保存至日志存储位置中。 操作步骤 1. 登录媒体存储控制台，进入【对象存储Bucket列表】菜单。 2. 选择需要配置日志存储的存储桶，并点击【基础配置】页签。 3. 在【日志存储】模块，点击【编辑】。 4. 根据页面指引对相应桶进行日志存储设置，具体可参考：[配置参数说明](

本章节为媒体存储事件通知概述。 使用场景 媒体存储支持事件通知能力，当对象存储资源发生变动（如新对象上传、删除对象）时，用户可通过事件通知配置及时收到通知消息。 适用区域 本功能目前仅部分资源池支持，具体可参考：资源池与区域节点。 如需使用，可联系客户经理或提交工单申请。 使用说明 事件类型：支持多选，匹配一个事件类型触发一条通知。 资源描述 前缀、后缀：前后缀各支持配置一个。 资源描述 元数据：支持配置10个元数据，对象必须包含所配置的元数据才视为匹配。 当资源描述包含多个条件时，对象必须匹配所有条件才视为匹配。 目前事件通知回调暂不支持鉴权，用户需提供无需鉴权的回调地址。 当事件回调失败时，服务会重试回调，直至回调成功。 事件类型 事件通知目前支持以下事件类型： 事件类型 说明 ObjectCreated: 所有上传对象的操作 ObjectCreated:Put 通过PutOject接口上传对象的操作 ObjectCreated:Post 通过PostObject接口上传对象的操作 ObjectCreated:Copy 通过Copy接口上传对象的操作 ObjectCreated:CompleteMultipartUpload 通过分片上传接口上传对象的操作 ObjectRemoved: 所有删除对象的操作 ObjectRemoved:Delete 通过DeleteObject接口删除对象的操作 ObjectRemoved:DeleteMarkerCreated 开启多版本的存储桶，在不指定versionId删除对象时会插入一个DeleteMarker的操作

参数 说明 gdoss.xstore.ctyun.cn 资源池域名，用来标记资源池。 $serveraddr 当前服务器地址，一般是内网IP。 $remoteaddr 连接的对端服务器地址。 $timelocal 日志时间。 $requestmethod HTTP Method，如PUT、GET、DELETE、POST、HEAD等。 $host HTTP请求里面的header字段：host。 $requesturi HTTP请求里面的URI。 $status HTTP状态码。如200、204、206、403、404等。 $bodybytessent 服务端发送给客户端的消息body长度。 $contentlength 服务端收到的消息的请求的长度。 $httpreferer HTTP请求里面的referer字段。 $requesttime 请求持续时间。包含从服务端建立连接完成到完成响应这段时间。 $httpuseragent HTTP请求里面的useragent字段。 $httpxforwardedfor HTTP请求里面的xforwardedfor字段。 $scheme 区分HTTP还是HTTPS请求。 $opname API接口名称。如GetObject、ListBuckets等等。 $httptransferencoding HTTP请求里面的transferencoding。 $httpctyunnetworktype 表示请求来源的网络类型:public（公网）、private(内网）。 $varUser 用户标记，表示这个请求对应的用户。 $upstreamresponsetime 请求在资源池内部的处理时间。

操作步骤 1. 登录媒体存储控制台，进入【对象存储Bucket列表】菜单。 2. 选择需要配置事件通知的存储桶，并点击【基础配置】页签。 3. 在【事件通知】模块，点击【添加规则】，一个Bucket可创建10条规则。 4. 在弹窗配置规则内容，具体说明可参考：配置参数说明。配置完成后，点击【确定】完成操作。 配置参数说明 参数 参数说明 规则名称 必填，规则的唯一标识，同一存储区域下不可重复；字符必须是英文、数字、短横线（），长度不超过50个字符。 事件类型 选择需要触发通知的事件类型，支持多选。 资源描述 支持按前缀、后缀或元数据过滤需要触发通知的资源范围。 接收终端 填写接收事件通知的地址，支持http或https。

本章节为媒体存储用量统计概述。 使用场景 用户可以在控制台上数据统计菜单页面查看使用情况，并可指定查询的时间范围。目前支持对象存储与文件存储的使用情况查询。 对象存储可查看所有已开通的区域汇总情况、指定区域情况或单个Bucket使用情况，统计项包括： 存储空间：存储空间变化曲线/列表。 流量：公网下行流量、公网上行流量、内网下行流量、内网上行流量、CDN回源上行流量、CDN回源下行流量的变化曲线。 请求状态详情：总请求次数、有效请求次数、2XX、4XX、5XX请求次数以及占比情况。 请求次数：PUT、POST、GET、DELETED以及其他请求次数变化曲线/列表。此处请求次数仅统计返回状态码为2XX的请求。 文件存储可查看指定区域情况，统计项包括： 存储空间：存储空间变化曲线/列表。 使用说明 其中所有的列表数据均可导出。 按照时间段搜索时，起始时间与结束时间间隔时间最多支持31天。 请注意受采集时间及图表精度限制，所列数据仅供参考，不作为账目依据。 使用方式 操作途径 使用方法 控制台 可参考：用量统计。