接口功能介绍 提供更新黑名单或白名单接口 接口约束 无 URI POST /vfw/v2blackwhitepolicyupdate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 addressDirection 是 String 地址方向；src；dst； dst blackWhiteDesc 否 String 黑白名单描述 黑白名单描述 blackWhiteType 是 String 黑白类型；black；white； firewallId 是 String 防火墙ID a6449feab4db11e9a6b40242ac110007 ip 是 String 127.0.0.1/32 ipProto 是 String IP协议；v4；v6； v4 mask 是 Integer 32 32 regionId 是 String 资源池ID ruleId 是 Long 规则ID 1099 ruleName 是 String 规则名称 uid 是 String 租户ID

Broker信息 展示该集群具体broker信息，包括该broker的详细指标，如下图： 其中关键指标为： commitLogMaxOffset为当前brokercommitLog最大的物理偏移。通过commitLogMaxOffset，RocketMQ可以追踪和管理消息的存储位置。当有新的消息写入时，RocketMQ会将消息追加到Commit Log文件的末尾，并更新commitLogMaxOffset的值。消费者在消费消息时，可以根据commitLogMaxOffset来确定从哪个偏移量开始消费消息。 consumeQueueDiskRatio为消费队列存储的文件占用的磁盘空间比例。通过配置consumeQueueDiskRatio，可以在保证消费队列的性能的同时，控制磁盘空间的占用。较小的consumeQueueDiskRatio值可以提高消费队列的读写性能，但会增加内存的使用。较大的consumeQueueDiskRatio值可以降低内存的使用，但可能会降低消费队列的读写性能。根据实际需求，可以根据系统的内存和磁盘资源情况来调整consumeQueueDiskRatio的值，以获得更好的性能和资源利用率。 putMessageDistributeTime为消息写入commitLog的耗时分布。通过配置putMessageDistributeTime，可以了解消息从发送到最终被消费的整体时间。这对于监控和优化消息传递的性能和延迟非常有用。注意，putMessageDistributeTime是一个估计值，实际的消息传递时间可能会受到网络状况、消费者处理能力等多种因素的影响。因此，在配置putMessageDistributeTime时，需要根据实际情况进行调整，并结合其他指标进行综合分析。

本文为您介绍多活容灾服务的定义。 定义 天翼云多活容灾服务（Multiactive Disaster Recovery Service Platform）衍生于用户对数据、应用和业务的多活、高可用需求。通过预案编排、资源同步、智能调度、故障切换等能力组合确保故障场景下用户业务的连续性，实现业务恢复与故障恢复的相互解耦，满足用户对容灾能力的建设要求。产品通过纳管在不同地理位置的云上云下资源，实现数据的分布式存储和处理，从而提高系统的容错能力和抗灾能力，其主要目的是在生产故障发生时，能够迅速地恢复业务运行，减少停机时间和数据丢失，满足用户对RTO和RPO的要求。 特性 产品形态：目前支持3种产品形态，同城多活、同城主备、异地主备。 统一入口：作为云上的统一入口，可基于IaaS和PaaS云产品搭建多活容灾业务系统。 资源隔离：通过命名空间和容灾管理中心实现业务隔离、故障隔离。 故障隔离：通过演练空间实现容灾演练故障隔离，演练过程不影响生产业务。 监控告警：提供网络、应用、云主机、数据库、存储等资源的容灾监控告警功能。 容灾切换：故障监控和容灾切换预案管理，提供不同灾难场景下的自动或手动切换和回切。 容灾演练：故障演练验证容灾架构的可靠性，满足容灾审计要求和验证系统RTO。

接口功能介绍 查看事件告警规则的详情信息。 接口约束 regionID（资源池）和alarmRuleID（告警规则）存在。 URI GET /v4/monitor/describeeventalarmrule 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID 是 String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba 请求参数 请求头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 参数 参数类型 说明 示例 下级对象 alarmRuleID String 告警规则ID 2c2472dff6335b4bbe459609fc9f8154 regionID String ctyun资源池ID 81f7728662dd11ec810800155d307d5b name String 规则名 ctyunrule desc String 描述 demo service String 本参数表示服务。取值范围： ecs：云主机。 evs：云硬盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs dimension String 本参数表示告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs repeatTimes Integer 重复告警通知次数 0 silenceTime Integer 告警接收策略静默时间，多久重复通知一次，单位为秒 300 recoverNotify Integer 本参数表示恢复是否通知。取值范围： 0：否。 1：是。 根据以上范围取值。 0 notifyType Array of Strings 本参数表示告警接收策略。取值范围： email：邮件告警。 sms：短信告警。 根据以上范围取值。 ['email','sms'] contactGroupList Array of Objects 告警联系人组 contactGroup notifyWeekdays Array of Integers 本参数表示通知周期。取值范围： 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消息推送url地址 [' status Integer 本参数表示告警规则启用状态。取值范围： 0：启用。 1：停用。 根据以上范围取值。 0 alarmStatus Integer 本参数表示告警规则告警状态。取值范围： 0：正常。 1：正在告警。 根据以上范围取值。 0 createTime Integer 创建时间，毫秒级时间戳。 1689580180000 updateTime Integer 更新时间，毫秒级时间戳。 1689580180000 projectID String 项目ID 0 conditions Array of Objects 具体匹配策略 condition resources Array of Objects 资源信息列表 resources resourceScope Integer 规则的资源范围，取值范围： 0：实例资源类型。 1：资源分组类型。 2：全部资源类型 。 根据以上范围取值。 0 defaultContact Integer 是否使用天翼云默认联系人接收通知，取值范围： 0：否。 1：是。 根据以上范围取值。 0 表 contactGroup 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID 000f03221f4d8cc8bb2e1c30fb751ccc name String 告警联系人组名称 告警组aaa 表 condition 参数 参数类型 说明 示例 下级对象 eventName String 事件指标 migrationeventstart description String 事件中文描述 云主机迁移发生 value String 出现次数，告警阈值，整数格式字符串 1 period String 本参数表示算法统计周期。 5m level Integer 告警等级。取值范围： 1：紧急。 2：警示。 3：普通。 根据以上范围取值。 3 表 resources 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源信息 resourceObj 表 resourceObj 参数 参数类型 说明 示例 下级对象 name String 资源实例标签键 uuid value String 资源实例标签值 17d7e40a1f4ebca6fdb437dbb43237ee

类别 数量限制 类型限制 迁移任务 24小时内，单个Region内最多创建迁移任务数为5000个。 OMS当前针对对象元数据迁移只支持Http协议标准请求头：ContentType 迁移任务组 24小时内，单个Region内最多创建迁移任务组数量为100个。 OMS当前针对对象元数据迁移只支持Http协议标准请求头：ContentType

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

接口功能介绍 网关负载均衡开启ipv6 接口约束 无 URI POST /v4/gwlb/enableipv6 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 gwLbID 是 String 网关负载均衡ID gwlbxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 gwLbID String 网关负载均衡 ID gwlbxx 枚举参数 无 请求示例 请求url POST /openapi/v4/gwlb/enableipv6 请求头header 无 请求体body { "regionID": "xxxx", "gwLbID": "xxxx" }

接口功能介绍 网关负载均衡关闭删除保护 接口约束 无 URI POST /v4/gwlb/disabledeleteprotection 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 gwLbID 是 String 网关负载均衡ID gwlbxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 gwLbID String 网关负载均衡 ID gwlbxxx 枚举参数 无 请求示例 请求url POST /openapi/v4/gwlb/disabledeleteprotection 请求头header 无 请求体body { "regionID": "xxxx", "gwLbID": "xxxx" }

删除一个弹性伸缩配置 接口功能介绍 删除一个弹性伸缩配置 接口约束 无 URI POST /v4/scaling/configdelete 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b configID 是 Integer 伸缩配置ID 410 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Config.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling config info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩配置信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 configID Integer 伸缩配置ID 410 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "configID": 410 } 响应示例 json { "returnObj": { "configID": 410 }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 }

查询用户弹性伸缩资源配额 接口功能介绍 查询用户的弹性伸缩组、伸缩配置、伸缩策略配额。 接口约束 无 URI POST /v4/scaling/quota 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 错误码 message String 失败时的错误描述，一般为英文描述 description String 失败时的错误描述，一般为中文描述 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 scalingGroupLimit Integer 伸缩组配额 50 scalingRuleLimit Integer 伸缩策略配额 10 scalingConfigLimit Integer 伸缩配置配额 100 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b" } 响应示例 json { "returnObj": { "scalingGroupLimit": 50, "scalingRuleLimit": 10, "scalingConfigLimit": 100 }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 }

停用一个周期策略 接口功能介绍 停用一个周期策略 接口约束 无 URI POST /v4/scaling/rule/stopcycle 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

停用伸缩组中的指定策略 接口功能介绍 停用伸缩组中的指定策略。 接口约束 无 URI POST /v4/scaling/rule/stop 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

开启云主机保护 接口功能介绍 开启云主机保护 接口约束 无 URI POST /v4/scaling/group/protectenable 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 542 instanceIDList 是 Array of Integers 实例ID列表 [474] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 instanceIDList Array of Integers 实例ID列表 [474] 请求示例 请求头header 无 请求体body json { "groupID": 542, "regionID": "81f7728662dd11ec810800155d307d5b", "instanceIDList": [ 474 ] }

检查弹性伸缩组是否可以修改 接口功能介绍 检查弹性伸缩组是否可以修改 接口约束 无 URI POST /v4/scaling/group/check 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 result Integer 伸缩组是否可以修改取值范围：1：可以修改2：不可以修改 1 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 405 }

移入云主机 接口功能介绍 将一台或多台云主机移入伸缩组。 接口约束 无 URI POST /v4/scaling/group/instancemovein 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 483 instanceUUIDList 是 Array of Strings 云主机ID列表 ['9861703b2ccf370de06az1d33d655872'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.instance.moveInNotFound 错误码 message String 失败时的错误描述，一般为英文描述 movein scaling instance not found description String 失败时的错误描述，一般为中文描述 未找到可迁入弹性伸缩云主机列表信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 instanceIDList Array of Integers 实例ID列表 [329]

删除一个告警策略 接口功能介绍 删除一个告警策略 接口约束 无 URI POST /v4/scaling/rule/deletealarm 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 511 ruleID 是 Integer 伸缩策略ID 72 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found instance description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 72 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "ruleID": 72, "groupID": 499 }

关闭云主机保护 接口功能介绍 关闭云主机保护 接口约束 无 URI POST /v4/scaling/group/protectdisable 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 542 instanceIDList 是 Array of Integers 实例ID列表 [474] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 instanceIDList Array of Integers 实例ID列表 [474] 请求示例 请求头header 无 请求体body json { "groupID": 542, "regionID": "81f7728662dd11ec810800155d307d5b", "instanceIDList": [ 474 ] }

响应参数 参数 参数类型 说明 示例 下级对象 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/monitor/updatealarmblacklist 请求头header 无 请求体body { "blacklistID": "46d7bc837ac45238a9342076d0b9f9f0", "name": "ctyunalarmblacklist", "desc": "demo", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "resources": [ { "resource": [ { "name": "uuid", "value": "7dd744ea5a0261d3e62738f82f5fd3e1" }, { "name": "instancename", "value": "ecmaf97" } ] } ], "metrics": [ "cpuutil", "memutil" ], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": [ "234bee0616f65b0aadb8c0903d480a58" ] }

接口功能介绍 本接口用于删除GB28181凭证。 接口约束 删除凭证前请确保存在该凭证。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI DELETE /v2/gb28181Certs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 1942b6dc15704a93950d90d3101d3ebb 枚举参数 无 请求示例 请求url DELETE '/v2/gb28181Certs/openapi01' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "1942b6dc15704a93950d90d3101d3ebb","returnObj": {"RequestId": "1942b6dc15704a93950d90d3101d3ebb"}}

接口功能介绍 本接口用于修改设备的目录。 接口约束 修改设备目录前确保存在该目录以及设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/dirs//devices/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DirId 是 String 目录ID。 1548576244711424 DeviceId 是 String 设备ID。 29942028422873997 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 68561b784a2944a7a713186f5cb20d34 枚举参数 无 请求示例 请求url PUT '/v2/dirs/1548576244711424/devices/29942028422873997' 请求头header 无 请求体body {"InProtocol":"gb28181"}

接口功能介绍 调用此接口可设置指定告警规则的告警联系人及通知方式。 接口约束 告警规则存在。 URI POST /v4/monitor/setalarmrulecontact 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID alarmRuleID String 是 2c2472dff6335b4bbe459609fc9f8154 告警规则ID contactGroupList Array of String 是 ["7e6b4ac7cf07561db381fea74c401f50"] 告警接收策略通知人ID列表 notifyType Array of String 是 ["sms"] 告警接受策略通知方式。取值范围：sms：短信通知。email：邮件通知。根据以上范围取值。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

接口功能介绍 调用此接口可变更告警联系人所属的告警联系人组列表。 接口约束 告警联系人及告警联系人组存在。 URI POST /v4/monitor/updatecontactgroups 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 contactID String 是 a6fb570f22995bde989cdf0819c687d0 告警联系人ID actionType String 是 add 本参数表示变更类型。取值范围：add：新增。del：删除。根据以上范围取值。 contactGroupIDList Array of String 否 ["fe7f0cdc469255168d3ab06355482090"] 告警联系人组ID列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0

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

告警规则 自定义告警规则：批量删除 接口功能介绍 调用此接口可批量删除多个自定义监控/事件告警规则。 接口约束 告警规则存在。 URI POST /v4/monitor/deletecustomalarmrules 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleIDList 是 Array of Strings 告警规则ID列表 ['f79fe6a8284f5cd89031812b06821b9c','eec4a76a35ba57b891c6c4fd923351d6'] 响应参数 参数 参数类型 说明 示例 下级对象 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

接口功能介绍 创建证书csr接口 接口约束 请保证账户余额大于0 URI POST /v1/manageCertificate/createCertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 keySpec 是 String 证书算法 RSA2048 subject 是 String 证书主体（拥有者） CNuserName,OUkms,Otele,CCN subjectAlternativeNames 是 List 证书主体别名 ["test1.example.com","test2.example.com"] exportablePrivateKey 是 int 证书私钥是否需要导出使用 1 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 用户创建证书成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff csr String 生成的证书csr BEGIN CERTIFICATE REQUESTnMIIDADCCAegCAQAwgboxCzAJBgNVBAYTAkNOMREwDwYDVQQIEwhaaGVqaWFuZzERnnmkj4rgnEND CERTIFICATE REQUESTn

本小节介绍购买渗透测试服务的操作步骤。 操作步骤 1. 在天翼云官网注册账户后，进入天翼云官网首页，在产品按钮中选择“安全及管理> 安全服务 > 渗透测试”，进入渗透测试页面。 2. 点击渗透测试服务的立即订购，按需求填写购买即可。 3. 您可以选择小型、中型、大型三种规格。 规格选择 描述 常见系统 小型渗透 测试对象为1个应用系统。 门户网站（仅包含信息展示页面）为一个应用系统，属于小型系统。 中型渗透 测试对象的复杂度相当于5个应用系统。 办公系统，包含邮箱系统、财务系统、工时系统，为三个应用系统，属于中型系统。 大型渗透 测试对象的复杂度相当于10个应用系统。 网银系统，包含门户网站、个人网银、企业网银、手机银行、微信银行、App用户端，为六个应用系统，属于大型系统。

本章节将为您详细介绍创建告警规则的操作场景及步骤。 操作场景 云监控支持灵活的创建告警规则。您既可以根据实际需要对某个云硬盘的监控指标设置自定义告警规则，同时也能够使用告警模板为多个资源或者云服务批量创建告警规则。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，此处我们选择华东1。 3. 单击“管理与部署>云监控服务”，进入监控概览页面。 4. 单击“告警服务”下拉菜单，单击“告警规则”，进入告警规则列表页面。 5. 在“告警规则”列表界面，单击“创建告警规则”按钮。 6. 在“创建告警规则”页面，根据界面提示配置参数。 配置参数及相关含义说明如下： 模块 参数 参数说明 配置示例 约束与限制 选择监控对象 规则类型 选择规则的类型，指标监控（包括站点监控）。 指标监控 选择监控对象 服务 配置告警规则监控的云服务资源类型。 云硬盘 选择监控对象 维度 用于指定告警规则对应指标的维度名称。 云硬盘 选择监控对象 监控对象类型 具体实例/资源分组/全部资源 具体实例 选择监控对象 监控对象 用来配置该告警规则针对的具体资源，可以是一个或多个。 磁盘名称 定义告警策略 选择类型 自定义创建/从模板导入。 自定义创建 定义告警策略 策略 满足全部/任意策略 策略信息包括：指标、数据类型（原始值、最大值、最小值、平均值）、判断条件（>、≥、 100KB，连续发生1次，普通 同一告警规则下，告警条件最多支持添加20条。 定义告警策略 无数据处理 不做处理/视为告警/视为恢复 不做处理 配置告警通知 发送通知 配置是否发送邮件通知用户，可以选择“是” （推荐选择）或者“否”。 是 配置告警通知 通知方式 配置告警通知的通知方式。 通知联系人组 配置告警通知 告警联系组 配置发生告警通知的用户组。 配置告警通知 触发场景 触发告警邮件的场景，可在告警及恢复时发送提醒信息。 出现告警 配置告警通知 通知渠道 配置告警通知的通知渠道，支持邮箱、短信、语音。 邮箱 配置告警通知 重复告警 指告警发生后如果未恢复正常，将重复发送告警通知次数。 不重复 配置告警通知 通知频率 配置告警通知的通知频率。 每24小时通知一次 配置告警通知 通知周期 配置告警通知的周期时间。 星期天、星期一、星期二、星期三、星期四、星期五、星期六 配置告警通知 通知时段 配置告警通知的时间段。 00:00:0023:59:59 配置告警通知 告警回调 配置告警通知webhook地址。 配置告警通知 通知模板 配置告警通知的通知模板，用户可以自定义创建。如未选择通知模板，告警信息将按系统默认模板发送。 系统模板 规则信息 名称 该告警规则的自定义名称。 evsalarmnote 规则信息 企业项目 选择告警规则适用的企业项目。 default 规则信息 描述 添加对该告警规则描述（此参数非必填项）。 7. 告警规则添加完成后，当监控指标触发设定的阈值时，云监控会在第一时间通过邮件实时告知您云上资源异常，以免因此造成业务损失。关于云监控的其他操作和更多信息，请参考《云监控服务》。

3、配置源库及目标库信息 进入实例配置第一个步骤的【配置源库及目标库信息】页面，填入源库与目标库的相关配置信息，包括数据库类型、IP地址端口、数据库账号、数据库密码等信息。 完成上述信息的填写后，点击源数据库和目标数据库的“测试连接”按钮进行数据库连接测试，检查数据库能否正常连接。 4、配置迁移对象及高级配置 源库和目标库连通性测试成功后，点下一步按钮，进入实例配置第二个步骤的【配置迁移对象及高级配置】页面，在“源库对象”中选择要迁移的源库对象，包含：库、TABLE，选中后点击“>”按钮，将待迁移对象移动到“已选择对象”中。 5、预检查 点击“下一步预检查”，进入【预检查】页面。预检查会检查如下列表信息，并给出检查结果，用户可以依据检查结果进行下一步操作。 检查项 检查内容 源库连通性检查 检查数据传输服务器能否连通源数据库。 待迁移表是否存在主键检查 勾选增量迁移时，检查待迁移表中是否存在无主键的表。 源数据库的模式名表名是否合法 检查源数据库的模式名表名是否合法，名称不可以包含+"%'<>,.字符。 源库参数wallevel是否为logical 勾选增量迁移时，检查源库wallevel参数值是否为logical。 目标库连通性检查 检查数据传输服务器能否连通目标数据库。 源库参数maxreplicationslots校验 勾选增量迁移时，检查源库maxreplicationslots参数值是否大于当前已使用的复制槽数量。 源库参数maxwalsenders校验 勾选增量迁移时，检查源库maxwalsenders参数值是否大于当前已使用的复制槽数量。 源库用户权限检查 检查源库用于DTS任务的用户是否具有相应的权限。 源库主备状态检查 勾选增量迁移时，检查源库是否为集群中的主库。 待同步表REPLICAIDENTITY模式检查 检查待迁移表REPLICAIDENTITY值是否都为FULL 检查源库和目标库字符集一致性检查 检查源库和目标库字符集是否一致

前提条件 已创建存储库。 客户端状态为已激活。 操作步骤 方法1：在备份计划页面创建备份计划 1. 登录控制中心。 2. 在控制中心左上角选择地域，此处选择华东华东1。 3. 选择“存储>云备份”，进入云备份控制台。单击左侧“ECS文件备份”或“本地文件备份”按钮，进入文件备份控制台。 4. 单击“备份计划”按钮，进入备份计划页面。单击“创建备份计划”按钮，在弹出页面配置如下内容： 参数 说明 详细说明 参考取值 备份计划名称 您可自定义计划名称 可不填，系统自动生成。只能由数字、字母、组成，不能以数字和开头、且不能以结尾。 backuptest ECS名称/客户端名称 ECS文件备份为云主机名称，本地文件备份为客户端名称 备份计划绑定的云主机或本地客户端名称。 ecmxxxx 存储库名称 计划绑定存储库的名称 存储库和备份的ECS/本地服务器需在同一区域。 test 备份目录规划 备份计划中设置的备份目录。显示计划中指定、排除文件目录或文件的规则信息 可选择全部目录 、指定目录或高级规则 。 全部目录：选择全部目录后，备份系统会自动过滤系统特殊目录，这些目录将不会加入备份计划，如/dev、/proc、/sys。 指定目录：选择指定目录后，需要指定备份文件路径。单击新增目录可自定义多个备份目录，最多可以添加10条。 路径输入规则： 不能包含/dev、/proc、/sys或子目录； 不支持通配符，且必须为绝对路径； 单条备份路径的字符最长为4095。 高级规则：您可以指定目录加入备份计划。同时可以通过“备份文件规则”选择文件加入备份计划。提供包括所有文件 、 包含下列文件 、排除下列文件三种规则。包含和排除文件需要用户手动输入路径或者文件。路径输入规则同上。 注意 : 1.不建议对系统路径进行备份，具体请参考上方约束与限制 2.包含和排除文件文件所输入的文件列表路径必须在备份文件路径之下。 全部目录 备份周期 配置备份计划执行的时间间隔 间隔时间单位为每月、每周、每天、每小时。 每月：指定在每月的几日几时进行备份。 每周：指定在每周的周几几时进行备份。 每天：指定在每天的几时进行备份。 每小时：每小时进行一次备份。 每天 00：00时 全量备份配置 配置是否启用定期全量备份 启用： 启用此选项后可按配置的频次定期进行全量备份，频次的设置范围为0100，设置0表示每次备份都执行全量备份，两次全量备份的间隔时间不可小于1天，建议合理设置备份周期与全量备份频次。 不启用： 备份策略不会定期执行全量备份操作，默认在绑定的存储库的首次备份进行全量备份，后续进行永久增量备份。 说明：若保留规则选择按数量保留，全量备份配置频次需要小于保留的备份数量，否则不会按配置的全量备份频次进行定期全量备份。 每执行10次增量备份后，执行一次全量备份 保留规则 配置保留备份副本的时间 提供按时间、按数量和永久保留三种规则。 按时间：当选择按时间保留时，需要配置保留该备份的时间。时间单位：天、周、月、年。 注意：最小保留周期为1天，最大输入9999年。 按数量：该备份计划产生的备份副本保留的总份数，取值范围为12000 永久保留：系统不会自动删除备份，直至您手动删除。 按时间：30天 高级保留选项 若选择了按数量保留，还可以配置高级保留选项进行备份副本的长期保留 高级保留选项与按数量保留规则共同生效。 保留天备份：取值范围为0100，保留指定周期内每天最新的一个备份副本，例如设置为10，则会保留前10天每天最新的备份副本 保留周备份：取值范围为0100，保留指定周期内每周最新的一个备份副本，例如设置为5，则会保留前5周每周最新的备份副本 保留月备份：取值范围为0100，保留指定周期内每月最新的一个备份副本，例如设置为3，则会保留前3月每月最新的备份副本 保留年备份：取值范围为0100，保留指定周期内每年最新的一个备份副本，例如设置为2，则会保留前2年每年最新的备份副本 说明：可同时设置天备份、周备份、月备份和年备份，会取并集进行保留。即设置保留天备份为10，周备份为2时，总共会保留12份备份。长期保留规则与按数量保留可以同时执行，不会产生冲突。 保留前5周每周最新的备份副本 备份流量限制 配置指定时间段的备份流量速度上限 限速时间段：配置需要进行流量限制的起止时间 流量限制：配置该时间段的流量速度上限 注意：使用备份流量限制的客户端版本需不低于v2.4.0，最多可配置4个时间段。 9：00到18：00进行5MB/s的流量速度限制 5. 单击“确定”，备份计划状态为“创建中”，等待状态变为“正常运行”，即完成备份计划的创建。 6. 备份计划创建成功时默认开始执行，在下一个备份时间点会自动备份数据，若需暂停计划请参考“暂停备份计划”。若需立即执行一次备份，请单击“立即执行”。

本节介绍了SQL Server agent错误日志轮转的相关内容。 操作场景 使用存储过程关闭当前的RDS for SQL Server代理错误日志文件，并循环RDS for SQL Server代理错误日志扩展编号（就像重新启动服务器）。 新的RDS for SQL Server代理错误日志包含一个表示已创建新日志的行。 前提条件 成功连接RDS for SQL Server实例。通过SQL Server客户端连接目标实例。 操作步骤 执行以下命令，循环RDS for SQL Server代理错误日志。 EXEC [msdb].[dbo].[rdscycleagenterrorlog] 执行成功后，系统将会如下提示： plaintext RDSProcessSuccessfulCompleted

本文带您了解云硬盘快照的原理。 创建原理 快照可以分为全量快照和增量快照，全量快照是所有数据的一个完整的只读副本，增量快照保存基于全量快照的差异化数据。云硬盘创建的第一个快照是全量快照，不对空数据块进行备份。后续创建的快照均是增量快照，仅备份上一个快照以来有变化的数据块。全量快照和增量快照的元信息中均会存储全量的数据块信息，因此在通过任一快照回滚云硬盘时，均可以恢复对应历史时间点所有的云硬盘数据。 删除原理 删除快照时需要根据快照包含的数据块以及数据块的引用关系来进行空间的释放。当云硬盘的第一个全量快照删除后，全量快照的属性会被该云硬盘的第一个增量快照继承，该增量快照会补充备份全量快照中的数据块，导致该增量快照使用容量增加。 容量原理 以一块云硬盘所有快照的数据块占用的存储空间为粒度统计快照使用容量。云硬盘快照总容量为该云硬盘已保留的第一份快照（即全量快照）的全量大小与后续所有增量快照的增量大小之和。您可以在云硬盘控制台上通过查看云硬盘详情查看快照容量的大小。具体操作，请参见查看快照使用容量。 说明 快照数据保存在块存储集群中，不会占用云硬盘本身的空间。快照按实际占用的容量收取快照费用（分地域计费）。更多信息，请参见云硬盘快照计费说明。

针对长期未得到处理的告警，可通过升级通知机制督促相关负责人尽快处置。在通知策略中配置升级策略后，系统将按照预设的通知渠道向相关处理人员推送告警信息，从而提醒其及时开展故障排查与问题解决工作。 前提条件 已创建通知对象。具体操作，请参见【通知对象】。 新建升级策略 1. 登录【应用性能监控控制台】，在左侧导航栏选择告警管理 > 升级策略。 2. 在升级策略 页面单击创建升级策略。 3. 在右侧区域顶部文本框中输入升级策略名称。 4. 在升级规则区域，设置通知条件，即当告警在一段时间内未被认领或未被解决时发送告警通知。例如：当告警10分钟未认领时发送升级通知。 参数 说明 通知对象 选择通知对象。 联系人：选择具体联系人后还需选择使用电话、短信或邮件的通知方式。 联系人组：选择具体联系人组后还需选择使用电话、短信或邮件的通知方式。 钉钉/飞书/企微：通过钉钉、飞书或企业微信发送告警通知。 Webhook：通过Webhook发送告警通知。 通知时段 满足通知条件的告警会在设置的通知时段内发送告警通知。 重复次数 重复发送告警通知的次数。当告警不满足通知条件后，告警通知将不再发送。 4. 单击+添加规则，可以新增一条升级规则。 5. 设置完成后，单击保存。