分布式数据库通过在不同物理位置的多个节点上存储数据来提高系统的可用性和可扩展性。而分布式事务则需要确保这些节点上数据的一致和完整。 分布式事务全局一致性面临挑战 为实现分布式事务全局数据一致性，我们将面临如下挑战： 数据分散 分布式事务需要满足事务的ACID的特性，而业务数据分散存储在网络中的多个节点上。因此，分布式数据库在进行事务的分发，协同多节点完成业务请求过程中，如何确保所有节点上数据同步更新将是一大挑战。 网络延迟与故障 跨网络多节点需要协调配合，协调能否正常、顺利作业是关键，这决定了业务数据的一致性和请求响应的及时性。网络时延、异常、主机故障和操作系统调度异常等不确定因素，都会给分布式事务一致性带来诸多挑战。而数据库需要在异常发生后，能够快速自愈，并能保证异常期间事务的完整性（不出现数据丢失、错乱）和一致性将又是另一大挑战。 并发控制 在多个事务并发执行时，如何避免数据冲突和死锁也是一大难题。 分布式事务全局一致性实现策略 TeleDB引入全局事务管理节点（GTM），专门处理分布式事务一致性工作。它通过全局时钟（Global Timestamp）和两阶段提交（Two Phase Commit）两种策略，使分布式环境下的事务保持一致成为可能。

本文以Prometheus监控上报告警，并发送告警通知到企业微信群为例，帮助您快速使用告警管理功能，从创建告警、配置联系人到接收到第一条告警消息。 步骤一：创建通知对象 告警管理支持将告警通知通过短信、电话、邮件、企业微信等方式发送给通知对象。此处以创建企业微信群为例，展示如何通过告警管理中的机器人向您指定的企业微信群发送告警通知。创建其他通知对象的操作，请参见【通知对象】。 1. 登录应用性能监控控制台 ，在左侧导航栏选择告警管理 > 通知对象。 2. 单击钉钉/飞书/企微 页签，然后单击企微 。 3. 在新建机器人面板设置以下参数，然后单击确定。 参数 说明 名称 自定义企业微信机器人的名称。 机器人地址 输入企业微信机器人的Webhook地址。 告警模板 可编辑告警模板内容，告警触发时将根据模板内容进行发送。 恢复模板 可编辑告警模板内容，告警恢复时将根据模板内容进行发送。 步骤二：创建通知策略 此处展示如何将所有告警事件中告警等级为紧急的告警事件合并为一条告警通知发送至企业微信群中。更多信息，请参见【通知策略】。 1. 登录应用性能监控控制台 ，在左侧导航栏选择告警管理 > 通知策略。 2. 在通知策略 页面单击新建通知策略 。并选择下方高级设置。 3. 在新建通知策略页面设置通知策略名称。 4. 在匹配规则区域设置告警事件的匹配规则。（静默策略优先于通知策略，即已被静默策略匹配到的告警事件将会被静默，无法再进行通知策略的事件匹配。） 1. 选择无预设来源。通知策略会针对所有告警事件进行匹配规则过滤并发送通知。 2. 设置匹配规则表达式，您可以自定义标签或选择已有的标签。例如：ctyunarmsalertlevel等于4。 3. 单击下一步。 5. 在事件分组 区域，设置告警事件不需要分组，然后单击下一步。 6. 在通知对象区域，设置以下参数。 1. 选择通知对象为钉钉/飞书/企微，并选择上文【步骤一】创建的企业微信机器人。 2. 选择告警恢复后是否发送恢复通知。 发送恢复通知：当告警下面全部事件都恢复时，告警状态是否自动恢复为已解决。当告警恢复时，系统将会发送通知给告警处理人。 3. 设置通知时段，告警会在设置的通知时段内发送告警通知例如：通知时段为。00:0023:59。 4. 单击下一步。 7. 在重复/升级策略区域设置告警是否需要重复通知或使用升级策略。 不需要升级策略，告警未恢复状态下只发送一次。 重复通知：设置重复频率。当告警未恢复时，告警会以设置的重复频率循环发送告警信息直至告警恢复。 升级策略：选择升级策略，告警未恢复状态下，告警通知将会根据升级策略发送通知给其他通知对象。 8. 设置完成后，单击保存。

接口功能介绍 本接口用于查询指定设备的服务配置列表，包含视频、视图和AI配置等。 接口约束 需要确认存在该设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/device//resource/list 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceType 是 String 设备类型，需与查询的DeviceId真实设备类型一致。取值：ipc，nvr。 ipc 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 Resource Object 资源信息。 Resource RequestId String 请求ID。 362d4e78556b47129182d0881fade86b 表 Resource 参数 参数类型 说明 示例 下级对象 Video Array of Objects 视频资源。 Video Viid Array of Objects 视图资源。 Viid AI Array of Objects AI资源。 AI 表 Video 参数 参数类型 说明 示例 下级对象 ChannelNum String 通道号。 1 ChannelName String 通道名称。 通道1 WorkOrderNo String 订单号。 202211031607018234 WorkOrderId String 订单ID。 workorder20723343 BillingMode String 计费模式。取值：packages(资源包)，onDemand(按需计费)，unBinding(停用)。 packages ResourceId String 资源ID。 resource20723343 RecordNum String 录制配置，取值：0：无录制；1：录制。 1 TemplateId String 录制模板ID。 717074786139029504 TotalDeviceCount String 设备总路数。 100 RemainDeviceCount String 设备剩余路数。 100 CodeRate String 码率。 8 StorageTime String ST天数 。 ST3 BandWidth String 总带宽。 100 IsTrialOrder String 是否试用。取值：0(代表商用)，1(代表试用)。 0 CreateTime String 创建时间。 20221125 16:03:04 ExpireTime String 失效时间。 20241201 10:55:04 表 Viid 参数 参数类型 说明 示例 下级对象 ChannelNum String 通道号。 1 ChannelName String 通道名称。 通道1 WorkOrderNo String 订单号。 202211031607018234 WorkOrderId String 订单ID。 workorder20723343 BillingMode String 计费模式。取值：onDemand(按需计费)，unBinding(停用)。 onDemand ResourceId String 资源ID。 resource20723343 RecordNum String 录制配置，取值：0：无录制；1：录制。 1 TemplateId String 录制模板ID。 717074786139029504 IsTrialOrder String 是否试用。取值：0(代表商用)，1(代表试用)。 0 CreateTime String 创建时间。 20221125 16:03:04 ExpireTime String 失效时间。 20241201 10:55:04 表 AI 参数 参数类型 说明 示例 下级对象 WorkOrderNo String 订单号。 202211031607018234 WorkOrderId String 订单ID。 workorder20723343 BillingMode String 计费模式。取值：packages(资源包)，onDemand(按需计费)，unBinding(停用)。 packages ResourceId String 资源ID。 resource20723343 AppId String AI应用id。 1 AppName String 应用名。 人脸识别 AlgorithmType String 算法类型。 吸烟检测 AnalysisType String 分析类型。 AI100 ConfigCheckArea String 配置检查区域。 false TotalDeviceCount String 设备总路数。 100 RemainDeviceCount String 设备剩余路数。 100 Status String 是否启动算法。 1 CreateTime String 创建时间。 20221125 16:03:04 ExpireTime String 失效时间。 20241201 10:55:04

本页介绍天翼云TeleDB数据库如何查看组件信息。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台，单击系统参数 > 组件信息 ，进入组件信息页面。 2. 在选择下拉框选择组件类型 ，单击查询 。

本页介绍天翼云TeleDB数据库的Constraints设计规范。 1. 建议每个table都使用shard key作为主键或者唯一索引。 2. 建议建表时一步到位把主键或者唯一索引也一起建立。 注意 非shard key不可以建立primary key或者unique index。

本页介绍天翼云TeleDB数据库的Constraints设计规范。 1. 建议每个table都使用shard key作为主键或者唯一索引。 2. 建议建表时一步到位把主键或者唯一索引也一起建立。 注意 非shard key不可以建立primary key或者unique index。

响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 0 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 processAbnomalBehavior Integer 进程异常行为 11 maliciousSofaware Integer 恶意软件 11 userAbnomalBehavior Integer 用户异常行为 11 maliciousNetworkConnection Integer 恶意网络连接 11 other Integer 其他告警数量 11 枚举参数 无 请求示例 请求url 无 请求头header {"ContentType": "application/json"} 请求体body {"timeType": "LASTONEDAY", "startTime": "20230101 00:00:00", "endTime": "20230101 00:00:00", "eventCategoryIds": [1], "eventTypeIds": [8200], "taskId": "112131"}

接口功能介绍 更新已有别名绑定的密钥，别名本身不变 接口约束 请保证账户余额大于0 URI POST /v1/keyName/updateAlias 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥id 474e569e8814474a948bdbcf6d853eff aliasName 是 String 别名 AES256 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 更新别名成功 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "200000001852" } 请求体body { "aliasName": "20251021 09:49:29.153201", "cmkUuid": "e195f54664cf4ccda3cce612d2adc9d0" } 响应示例 { "statusCode": "200", "message": "更新别名成功" }

接口功能介绍 更新密钥轮转周期 接口约束 请保证账户余额大于0 URI POST /v1/versionControl/updateRotationPolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff enableAutomaticRotation 是 String 是否开启轮转 true rotationInterval 是 String 轮转周期 7d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 更新密钥轮转周期成功 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "cmkUuid": "474e569e8814474a948bdbcf6d853eff", "enableAutomaticRotation": "true", "rotationInterval": "7d" }

接口功能介绍 幂等接口，重复添加会忽略并视为添加成功。 接口约束 无 URI POST /v3/commonDesktopPool/addUsers 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 池化桌面池ID dpucod37vk0gca50kur44j4 pubUserOidList 是 Array of Strings 用户ID列表，长度限制[1,30] upglm1215fkk6v0hf8eo4il1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxxx","pubUserOidList":["puoxxx","puoyyy"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

接口功能介绍 操作不可逆，执行请仔细确认。 接口约束 无 URI POST /v3/customImage/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOid 是 String 镜像ID milm91642m8ukk1r7a6h7l5 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"imageOid":"mixxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 删除用户 接口约束 无 URI POST /v3/user/batchRemove 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOidList 是 Array of Strings 用户ID列表，最大数量50 upg8to5zvs52v2g01h6h8fy2 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"pubUserOidList":["upgfoo","upgbar"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 并发桌面池功能请联系客户经理开通。 接口约束 无 URI POST /v3/concurrentDesktopPool/addDesktops 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 并发桌面池ID dpybiqd3vedlt5u4cspy6vd resourcePackOid 是 String 资源包ID rsp8qvf6t33j2yh97s3t8drc pubUserOidList 是 Array of Strings 用户ID列表，可设置一个或多个，最多30个 upg68xjc1c655mmccohrq1m6 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxxx","resourcePackOid":"resxxx","pubUserOidList":["puoxxx"]}

接口功能介绍 创建对等连接路由v3 接口约束 无 URI POST /v3/peeringRoute/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 peeringOid 是 String 对等连接id vpcOid 是 String vpc id destinationList 是 Array of Strings 目的地址集合 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。 xxx 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "vpcOid":"vpcks38av7mklcehgu674ead", "peeringOid":"peer556a8qkcihe5qci4e79lq", "destinationList":["192.168.1.0/24","192.168.2.0/24"] } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"xxx" }

接口功能介绍 修改用户信息 接口约束 无 URI POST /v3/user/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOid 是 String 用户ID upg2lck6loc5swjlg2x6e16e userName 是 String 用户名称。字符数限制：[1,20]。 xiemushuxiugai email 否 String 邮箱。字符数限制：[1,50]。 email@foo.com gender 否 String 性别。枚举值范围：[男,女]。 null telephone 否 String 固定电话。字符数限制：[0,20]。 null position 否 String 职位。字符数限制：[0,50]。 null 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj

接口功能介绍 将基础策略克隆到账号的其它资源池下。 接口约束 无 URI POST /v3/strategy/cloneStrategy 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 sourceStrategyOid 是 String 待克隆的基础策略 targetRegionId 是 String 目标资源池 targetOrgOid 是 String 目标部门 targetStrategyName 是 String 目标策略名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "sourceStrategyOid":"dsyxxxxxx", "targetRegionId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "targetOrgOid":"orgxxxxxx", "targetStrategyName":"xxxxxx" }

接口功能介绍 VIP解绑弹性IPv3 接口约束 无 URI POST /v3/vip/unbindFip 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vipOid 是 String vip id fipOid 是 String 弹性ip id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。 jobtaskxxx 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "vipOid":"vipxxyrk3utggvmmyeiunfic", "fipOid":"fip9x9t48ate9ht07d7hceo5" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"jobtaskxxx" } 状态码 请参考 状态码

接口功能介绍 调用此接口可删除创建告警规则。 接口约束 告警规则存在。 URI POST /v4/monitor/deletealarmrule 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID alarmRuleID String 是 2c2472dff6335b4bbe459609fc9f8154 告警规则ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 请求示例 POST /v4/monitor/deletealarmrule 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "alarmRuleID": "2c2472dff6335b4bbe459609fc9f8154" }

接口功能介绍 调用此接口可验证资源分组名称是否存在。 接口约束 无。 URI GET /v4/monitor/verifyrenameresourcegroup 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID name String 是 test 分组名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 校验成功标识 true 请求示例 GET /v4/monitor/verifyrenameresourcegroup 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "name": "test" } 响应示例 json { "statusCode":800, "returnObj":{ "success":true }, "errorCode":"", "message":"Success", "msgDesc":"成功" }

接口功能介绍 调用此接口可删除指定资源分组。 接口约束 资源分组存在。 URI POST /v4/monitor/deleteresourcegroup 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID resGroupID String 是 95f7f0cbb5d7547e86673fceeab177d5 资源分组ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true 请求示例 POST /v4/monitor/deleteresourcegroup 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "resGroupID": "0134af8f44bf50dfbb0c9ad642612830" }

接口功能介绍 删除NAT网关v3 接口约束 无 URI POST /v3/nat/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 natOid 是 String NAT网关ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "natOid":"xxxxxxxxxxx" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 创建安全组v3 接口约束 无 URI POST /v3/securityGroup/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 securityGroupName 是 String 安全组名称 remark 否 String 安全组备注 strategynetworkDTOList 否 Array of Objects 安全组规则信息 strategynetworkDTOList 表 strategynetworkDTOList 参数 是否必填 参数类型 说明 示例 下级对象 direction 是 Integer 规则方向。[入方向：15，出方向：10] ipAddressField 是 String IP地址 protocolType 是 String 端口协议。[10：自定义TCP，15：自定义UDP，20：全部ICMP，25：GRE，30：全部TCP非自定义，35：全部UDP非自定义，99：全部放通] portRange 是 String 端口范围，例如 20000,20006，如果是全部端口则填 ALL authPolicy 是 Integer 规则类型。[拒绝：15，允许：10]

接口功能介绍 修改部门属性 接口约束 无 URI POST /v3/org/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 orgOid 是 String 部门ID orgudptjl8j3kifkb7uj54jq orgName 是 String 部门名称。字符数限制：[1,20]。 testxdfvs description 是 String 部门描述。字符数限制：[0,255]。 null 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"orgOid":"orgmod","orgName":"mod","description":""} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

接口功能介绍 取消部门资源包配额 接口约束 无 URI POST /v3/resourcePack/orgQuota/cancel 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 orgOid 是 String 部门ID org18qnu7l41v8fr2xif6jdq 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"orgOid":"orgdel"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 对称密钥解密接口 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/decrypt 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ciphertextBlob 是 String 待解密密文，且需经过Base64编码 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 解密成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 plaintext String 解密后的明文经过Base64编码后的值 sc7280+klUSln3Y9FHdfKGUT+6kPrcIMW41uZQeXxGU cmkUuid String 解密所用密钥id 6b1f657c816b4534a41a903e7a60e703 keyVersionId String 解密所用密钥版本 a857cc58ab6f40acb9e7fa1781209a76

接口功能介绍 查询黑白名单详情接口 接口约束 传参规范 URI GET /vfw/v2blackwhitepolicyinfo 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 blackWhiteType 是 String 黑白类型，black，white firewallId 是 String 防火墙id regionId 是 String 资源池id ruleId 是 Long 规则id uid 是 String 租户id 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 addressDirection String 地址方向，dst，src dst blackWhiteDesc String 黑白名单描述 黑白名单描述 blackWhiteType String 黑白类型，black，white black firewallId String 防火墙ID a6449feab4db11e9a6b40242ac110007 ip String 127.0.0.1 ipBeginNum String ip的开始数字形式 ipEndNum String ip的结束数字形式 ipProto String IP协议，v4，v6 v4 mask Integer 掩码 24 privateIps String 私网ips 192.168.1.1/24 regionId String 资源池ID a6449feab4db11e9a6b40242ac110007 ruleId Long 规则ID 321 ruleName String 规则名称 status String 规则开关，disable，enable disable uid String 租户ID 9f3618ee1c594598a942550985345d0d

接口功能介绍 无 接口约束 无 URI POST /cgw/v1/upstream/updateTimeoutConfig 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 7a2828074ef6e32e041a2ef124b19e63 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 connect 否 Float 连接超时时间(s)，默认值为10 6 instId 是 String 实例ID 878da73f7dba36ff0ae80e004a4f28f9 id 是 String 服务内部id 1234563f7dba36ff0ae80e004a4f28f9 read 否 Float 接收消息超时时间(s)，默认值为60 6 send 否 Float 发送消息超时时间(s)，默认值为60 6 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 接口状态码 2000 code String 错误码，异常时非空 CGW1001 returnObj Object 返回数据 message String 异常描述 success 枚举参数 无 请求示例 请求url 请求头header { "regionId": "1234567890" } 请求体body { "instId": "878da73f7dba36ff0ae80e004a4f28f9", "id": "00000000000000000050", "connect": 10, "send": 60, "read": 60 }

接口功能介绍 切换防护规则防护状态接口 接口约束 请保证ruleId存在 URI POST /vfw/v2systemsecpolicyswitchprotectstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙ID a6449feab4db11e9a6b40242ac110007 ruleId 是 Long 规则ID 321 status 是 String 规则开关，disable:,enable: disable 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header {"regionid": "100054c0416811e9a6690242ac110002","userId":"562b89493b1a40e1b97ea05e50dd8170","accountId":"ca888cf3674d4a83a42dbd71f4a09e94","urlType": "CTAPI"} 请求体body {"firewallId": "a6449feab4db11e9a6b40242ac110007","regionId": "fecnjniakfkn2314ndekqldedcsadfg","ruleId": 321,"status": "disable","uid": "562b89493b1a40e1b97ea05e50dd8170"}

接口功能介绍 切换资产防护状态接口 接口约束 传参规范 URI POST /vfw/v2systemvrfbindswitchprotectstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 eipIds 是 Array of Strings eip列表 protectStatus 是 Boolean 防护状态 firewallId 是 String 防火墙id 9f3618ee1c594598a942550985345d0d: gwlbeSubnetId 否 String 引流子网id(gwlbeSubnetId和cidr只填一个) subnet23 subnetIds 是 Array of Strings 子网id列表 cidr 否 String 引流子网cidr(gwlbeSubnetId和cidr只填一个) 192.168.1.0/24 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null

接口功能介绍 地址簿更新内容（IP/端口） 接口约束 传参规范 URI POST /vfw/v2addressitemupdate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 id 是 Long id 1 groupId 是 Integer 地址簿id 10 description 否 String 地址簿描述 描述 content 是 String ip/端口 v4 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Integer 接口返回结果 1 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "content": "1.1.1.2", "description": "1223", "id": 1700, "groupId": 9 }

接口功能介绍 入侵防御日志excel导出 接口约束 传参规范 URI POST /vfw/v2logmanagerexporteventlog 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id startTime 是 Long 开始时间 endTime 是 Long 结束时间 type 是 String 日志种类 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "type": "accessctl", "firewallId": "4f12ffeaed354b77971952870c2ceacf", "startTime": 1731554974, "endTime": 1731641374, "ipProto": "1", "action": "2", "srcIp": "", "srcPort": "", "desIp": "1", "desPort": "", "ruleId": "", "regionId": "81f7728662dd11ec810800155d307d5b" }

指标ID 指标名称 含义 取值范围 测量对象&维度 监控周期（原始指标） bandwidthusage 带宽使用率 当前流量带宽与最大带宽限制的百分比 0200% 测量对象：Redis 4.0/5.0主备实例数据节点Redis 4.0/5.0 Cluster集群实例数据节点测量维度：dcsclusternode 1分钟