接口功能介绍 导入uk证书 接口约束 无 URI POST /v1/manageCertificate/importCertificateForUK 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 algorithm 是 String 证书算法 SM2 cert 是 String 证书pem格式 ukName 是 String 证书别名 test epId 否 String 企业项目 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 9612627252624b61bf5cd66ca3c7a0b3

接口功能介绍 查看实例状态 接口约束 无 URI GET /v3/api/getStatus 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 445d30ce3d5d40a2a79dc444a8c83859 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 华东1 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 message String 错误信息 statusCode String 800成功 其他失败 returnObj Object 返回数据 returnObj error String 错误码 表 returnObj 参数 参数类型 说明 示例 下级对象 prodInstId String 实例ID status Integer 实例状态 枚举参数 参数名 status 枚举值 类型 说明 1 String 运行中 1 String 开通中 2 String 已过期 5 String 规格变更中 6 String 网络变更中 20 String 配置变更中

接口功能介绍 查看一分钟发布消息量 接口约束 无 URI GET /v3/api/getPubTpm 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 445d30ce3d5d40a2a79dc444a8c83859 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 华东1 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 message String 错误信息 statusCode String 800成功 其他失败 returnObj Object 返回数据 returnObj error String 错误码 表 returnObj 参数 参数类型 说明 示例 下级对象 prodInstId String 实例ID tpm Integer 一分钟生产消息量 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body 无

接口功能介绍 查看弹性IP信息 接口约束 无 URI GET /v3/api/getEip 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 445d30ce3d5d40a2a79dc444a8c83859 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 华东1 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 message String 错误信息 statusCode String 800成功 其他失败 returnObj Object 返回数据 returnObj error String 错误码 表 returnObj 参数 参数类型 说明 示例 下级对象 prodInstId String 实例ID eip String 弹性IP值，如果未绑定则为空 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body 无

本文介绍批量导入和导出防护规则的操作步骤。 下载防护规则模板 1. 登录云防火墙（原生版）控制台。 2. 进入防护规则页面。 互联网边界：在左侧导航栏选择“访问控制 > 互联网边界规则”，选择“入向规则”或者“出向规则”页签。 VPC边界：在左侧导航栏选择“访问控制 > VPC边界规则”，选择“内网互访规则”页签。 3. 单击规则列表右上方的下载模板图标，弹出下载模板确认框。 4. 单击“确定”，下载防护规则模板到本地。 批量导入防护规则 1. 按表格要求填写您要添加的防护规则信息。 注意 请按照模板要求填写相应参数，确保导入文件的格式与模板一致，否则可能会导入失败。 防护规则参数说明如下： 参数名称 参数说明 名称 自定义防护规则名称。名称长度不能超过100个字符。 源IP地址 支持以下格式： 地址段，使用“/”隔开掩码，如：192.168.2.0/24 IP地址簿名称。IP地址簿为多个IPv4地址的集合，添加IP地址簿请参见添加IP地址簿。 源端口 支持以下格式： 端口号。 端口地址簿名称。端口地址簿为多个端口的集合，添加端口地址簿请参见[添加端口地址簿](

本节介绍如何配置VPC边界防护的黑白名单规则。 添加黑白名单规则 1. 登录云防火墙（原生版）控制台。 2. 在左侧导航栏，选择“访问控制 > VPC边界规则”，进入VPC边界规则页面。 3. 选择“黑名单规则”或“白名单规则”页签，单击“添加黑名单”或“添加白名单”，在弹出的添加黑白名单页面中，填写规则信息。 参数说明如下： 参数名称 参数说明 地址方向 可选择“源地址”或“目的地址”。 源地址：访问流量中的发送数据包的IP地址。 目的地址：访问流量中的接收数据包的IP地址。 名称 自定义规则名称。名称长度不能超过100个字符。 IP地址 支持输入IPv4地址或使用已添加的地址簿： 输入IPv4：使用“/”隔开掩码，如192.168.2.0/24，0.0.0.0/0表示任意地址。 地址簿选择：通过下拉框选择已添加的IP地址簿，添加IP地址簿请参见添加IP地址簿。 描述 （可选）自定义规则描述。 4. 以上所有的字段填写完毕后，点击“确认”时，需要校验这条规则加入后，是否超过客户剩余的规格，若未超过则生成相应的防护规则。 删除黑白名单 单击黑白名单列表操作中的“删除”，弹出删除确认框，确定后删除该黑白名单规则，若是“取消”则关闭对话框。

本节介绍了如何创建数据库账号。 操作场景 开通实例后，通过控制台创建数据库账号。 操作步骤 1. 登录天翼云官网。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在【实例管理】的实例列表中选择目标实例，点击实例名称进入实例管理详情页。 6. 选择账号管理页签。 7. 点击创建账号按钮。 8. 在弹出框中，填写账号、密码、备注说明、选择账号类型和密码有效期，点击确定提交。 参数 说明 账号 由字母、数字或下划线组成。 不能以pg开头。 不能使用SQL关键字。 长度为2~63个字符。 账号类型 支持数据库账号：高权限账号和普通账号。 密码 长度为8~32个字符。 由大写字母、小写字母、数字和特殊字符中的任意三种或以上组成。 特殊字符支持为!@ $%^&()+。 有效期 支持有效期为长期有效和短期有效。 备注说明 填写备注信息，最大支持1000个字符。 注意 不同资源池因IaaS资源能力等原因，加载版本有所差异，详见

本文介绍了重启RDSPostgreSQL实例操作。 通常出于维护目的，您可能需要重启数据库实例。例如当实例出现连接数满或者其他性能问题时，您可以通过控制台页面手动对数据库实例进行重启操作。 约束限制 如果数据库实例处于“异常”状态，可能会重启失败。 重启数据库实例会重新启动数据库引擎服务。重启数据库实例将导致短暂中断，在此期间，数据库实例状态将显示为“重启中”。 重启过程中，实例将不可用。重启后实例会自动释放内存中的缓存，请在业务低峰期进行重启，避免对高峰期业务造成影响。 如果是主备实例，对应的备实例也会被同步重启，业务也会有中断。 操作步骤 1. 登录天翼云门户。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在“实例管理”页面，选择指定的实例，单击“更多”>“重启”。如果是主备实例，对应的备实例也会被同步重启，业务也会有中断。 6. 在“重启”弹框，单击“确定”重启实例。 7. 实例重启完成后，实例状态为正常运行中。

本节介绍云手机（政企版）的创建虚拟私有云操作说明。 操作场景 云手机如果需要上网，需配置虚拟私有云（VPC）、子网及上网带宽。VPC可在开通云手机服务时同步创建，也可单独管理。 创建虚拟私有云 1.进入“云手机”控制台； 2.单击“网络管理”，选择“虚拟私有云”，进入虚拟私有云管理页面； 3.点击“创建虚拟私有云”按钮； 4.配置虚拟私有云的“网段”、“名称”、“子网名称”、“子网网络地址”等信息； 5.确认配置信息后，点击“立即创建”，即完成云手机虚拟私有云及子网的创建。 创建IPv6云手机 当虚拟私有云开启了IPv6的功能后，创建云手机在网络模块配置时，选择开启IPv6功能的子网后，云手机则同样可以选择是否开启IPv6，具体操作如下。 操作步骤 1.在创建虚拟私有云时，子网 IPv6网段选择“开启IPv6”； 2.创建云手机时，网络模块选择绑定开启IPv6的业务子网，然后选择“开启IPv6”； 3.云手机其他信息完成配置后，点击“开通云手机”，即完成IPv6的云手机创建。

接口功能介绍 查询租户ak列表信息 接口约束 无 URI POST /v1/userAkControl/listUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否鼻涕那 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d pageNumber 否 Integer 当前页码，不传默认为1 1 pageSize 否 Integer 页码大小，不传默认为10 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Objects 租户ak列表 userAkList totalCount Integer 总数量 5 pageNum Integer 当前页码 1 pageSize Integer 页码大小 10 表 userAkList 参数 参数类型 说明 示例 下级对象 userAk String 租户ak 09bc65a7aeea902c67dfa006c797795f policy String ak权限 full status String ak状态 1 createTime String 创建时间 20241205 16:40:00

通过本接口可获得已存在的单一转码模板的详细配置信息。 接口功能介绍 通过本接口可获得已存在的单一转码模板的详细配置信息。 接口约束 本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。 URI POST /template/transcode/get 请求体 body 参数 参数 是否必填 参数类型 说明 示例 下级对象 templateId 是 Long 模板id 100000000004 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 code 是 Integer 本次请求的结果码。 0 message 是 String 错误文本信息，执行成功时，为空字符串。 "" data 是 Object 返回数据。 data 表 data 参数 是否必填 参数类型 说明 示例 下级对象 templateId 是 Long 模板id 100000000004 name 是 String 模板名称。 transcodeTemplate type 是 String 类型 SYS favorite 是 Boolean 是否为选定模板 true format 是 String 转码目标文件格式 MP4 encrytion 是 String 表示是否加密目标视频 false video 是 Object 视频的转码参数 video audio 是 Object 音频的转码参数 audio remark 否 String 转码模板备注 模板备注 表 video 参数 是否必填 参数类型 说明 示例 下级对象 codec 是 String 视频编码 H264 bitRate 是 String 视频的码率。 512K frameRate 是 Integer 视频的帧率。 24 height 是 Integer 目标视频的高度。 1024 width 是 Integer 目标视频的宽度。 768 autoRotate 是 Boolean 标识当前模板是否支持自动旋转。 true 表 audio 参数 是否必填 参数类型 说明 示例 下级对象 codec 是 String 音频的编码。 AAC bitRate 是 String 音频的码率 128k sampleRate 是 Integer 音频的频率 44100

接口描述：查询lua脚本预部署环境的编译信息。 请求方式：post 请求路径：/icdn/udfscript/queryudfscriptcompileresult 使用说明：单个用户一分钟限制调用10000次，并发不超过100。 请求参数说明（json）： 参数 是否必填 参数类型 说明 示例 下级对象 domain 是 String 域名必须属于当前用户且合法有效 ctyun.cn scriptname 是 String 为264位的小写字母、数字、下划线组合，以小写字母、数字开头结尾 luatest 返回参数说明： 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 returnObj message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数domain为必填，且不能为空 表 returnObj 参数 参数类型 说明 示例 下级对象 compiledresult Array of Objects 返回结果数组 compiledresult 表 compiledresult 参数 参数类型 说明 示例 下级对象 info String 编译结果 success time String 编译完成时间 20221104T18:49:31+08:00 rip String 下发机器 1.1.10.0 示例： 请求路径： 请求参数： { "domain":"ctyun.cn", "scriptname":"luatest" } 返回结果： { "statusCode": 100000, "message": "正确返回", "returnObj": { "compiledresult": [ { "info": "success", "time": "20221104T18:49:31+08:00", "rip": "1.1.10.0" }, { "info": "success", "time": "20221104T19:05:43+08:00", "rip": "1.1.158.0" }, { "info": "success", "time": "20230404T14:21:50+08:00", "rip": "1.11.185.45" } ] } } 错误码请参考：参数code和message含义

接口描述：调用本接口查询脚本在预部署环境运行的异常情况。 请求方式：post 请求路径：/icdn/udfscript/queryudfscriptexception 使用说明：单个用户一分钟限制调用10000次，并发不超过100。 请求参数说明（json）： 参数 是否必填 参数类型 说明 示例 下级对象 domain 是 String 域名必须属于当前用户且合法有效 ctyun.cn scriptname 是 String 函数脚本名 为264位的小写字母、数字、下划线组合，以小写字母、数字开头结尾 luatest 返回参数说明： 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 returnObj Object 返回对象 returnObj message String 结果简述 正确返回/参数不合法 error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，参数domain为必填，且不能为空 表 returnObj 参数 参数类型 说明 示例 下级对象 executionerror Array of Objects 返回运行异常信息数组 executionerror 表 executionerror 参数 参数类型 说明 示例 下级对象 info String 异常内容 601: No such API: ctyun.resp.setoutput123 time String 运行异常的时间 20230207T15:43:53+08:00 rip String 下发机器 171.105.185.45 示例： 请求路径： 请求参数： { "domain":"ctyun.cn", "scriptname":"luatest" } 返回结果： { "statusCode":100000, "message":"正确返回", "returnObj":{ "executionerror":[ { "info":"601: No such API: ctyun.resp.setoutput123", "time":"20230207T15:43:53+08:00", "rip":"171.105.185.45" } ] } } 错误码请参考：参数code和message含义

接口功能介绍 还原系统盘，可使用sys类型快照或all类型快照还原数据盘，可使用data类型快照或all类型快照还原系统盘和数据盘，可使用all类型快照 接口约束 无 URI POST /v3/snapshot/rollbackDesktops 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 还原类型，枚举值范围：[sys,data,all]（sys还原系统盘;data还原数据盘;all还原系统盘和数据盘） sys rollbackSettings 是 Array of Objects 还原配置列表，长度限制：[1,10] rollbackSettings 表 rollbackSettings 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023092701181644 snapshotOid 是 String 用于还原云电脑磁盘的快照ID ss41l5yfe2lg4fdsm4vags5 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj

接口功能介绍 创建终端节点 接口约束 传参规范 URI POST /vfw/v2createendpoint 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cidr 否 String 创建子网的cidr 最后一位掩码1628（和gwlbeSubnetId必须传一个） gwlbeSubnetId 否 String 引流子网（和cidr必须传一个） vpcId 是 String 开启防护的vpc scenarioType 是 String 场景类型eip;nat;vpcPeer对等连接;cda云专线;ec云间高速 scenarioId 是 String 场景id，列表获取 natId 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 表 GwlbeInfoVo 参数 参数类型 说明 示例 下级对象 endpointName String 终端节点名称 endpointId String 终端节点id vpcName String Vpc名称 subnetName String 子网名称 description String 描述

接口功能介绍 统计列表信息 接口约束 传参规范 URI GET /vfw/v2reportstatistics 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 startTime 是 String 开始时间 20240925T05:36:13Z endTime 是 String 结束时间 20240925T05:36:13Z 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 ReportStatisticsView 表 ReportStatisticsView 参数 参数类型 说明 示例 下级对象 dailyCount Integer 日报个数 1 dailyLastUpdated String 日报最后更新日期 20241024T16:00:24Z weeklyCount Integer 周报个数 2 weeklyLastUpdated String 周报最后更新日期 20241023T16:00:00Z monthlyCount Integer 月报个数 3 monthlyLastUpdated String 月报最后更新日期 20241024T16:00:24Z

接口功能介绍 当前只支持操作资源包来源的带宽 接口约束 无 URI POST /v3/bandwidth/modifySpec 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 bandwidthOid 是 String 带宽ID bwlkh1f0xbikbe0tufj2tl2 size 是 Integer 带宽大小（单位：Mbps），需大于0 3 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"bandwidthOid":"bwfoo","size":3} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 并发桌面池功能请联系客户经理开通。 接口约束 无 URI POST /v3/concurrentDesktopPool/editPolicy 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 并发桌面池ID dpurmb31l1two2so9us14ro keepDuration 否 Integer 用户断开连接后，云电脑所占并发额度的保留时长（单位：分钟），至少是3 33 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxx","keepDuration":33} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

接口功能介绍 修改对等连接v3 接口约束 无 URI POST /v3/peering/update 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 peeringOid 是 String 对等连接id peeringName 是 String 对等连接名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。 xxx 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "peeringOid":"peer8x46rpnaa0lfqlnji8aac", "peeringName":"peeringxxx" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"xxx" } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 修改子账号信息 接口约束 无 URI POST /v3/subManager/update 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 subManagerOid 是 String 子账号ID(不可修改) remark 是 String 备注信息。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "subManagerOid":"subxxxxxxxxxxxxxxxxxxxxxxxx", "remark":"财务部主管" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 判断防护能力是否升级 接口约束 传参规范 URI GET /vfw/v2firewalljudgeabilityupgrade 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 flowProcessingCapacity 是 Integer 公网流量处理能力(单位Mbps) 100 protectionIpNum 是 Integer 可防护公网IP数 1 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg uid 是 String 租户id 562b89493b1a40e1b97ea05e50dd8170 userId 是 String 用户ID vpcId 是 String vpc 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 接口返回结果

接口功能介绍 添加地址簿 接口约束 传参规范 URI POST /vfw/v2addressgroupadd 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 addressGroupName 是 String 地址簿名称 name description 否 String 地址簿描述 描述 addressType 是 String 地址簿类型v4;v6;port v4 addressContent 是 Array of Strings 地址簿ips或者ports ["1.1.1.1"] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Integer 接口返回结果 1 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "addressGroupName": "test", "description": "12", "addressType": "v4", "addressContent": [ "1.1.1.1" ] }

接口功能介绍 提供更新资产的提示信息接口 接口约束 无 URI POST /vfw/v2systemvrfbindtipupdate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ids 是 String 提示 regionId 是 String 资源池ID 9f3618ee1c594598a942550985345d0d uid 是 String 租户ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header {"regionid": "100054c0416811e9a6690242ac110002","userId":"562b89493b1a40e1b97ea05e50dd8170","accountId":"ca888cf3674d4a83a42dbd71f4a09e94","urlType": "CTAPI"} 请求体body {"ids": [],"regionId": "","uid": ""}

接口功能介绍 更新通知设置 接口约束 传参规范 URI POST /vfw/v2notificationset 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 notifyId 是 String 通知id c6580ef202d64af48cae1e46c140d3ae subscribeUserIds 是 Array of Strings 订阅人 ["1111"] notifyTitle 是 String 通知名称 入侵检测告警 notifyType 是 Array of Strings 通知类型 ["SERIOUS","HIGH","MEDIUM"] notifyMethod 是 Array of Strings 通知方式 ["EMAIL"] timeRange 是 Array of Integers 订阅时间范围 [8,20] status 是 Integer 状态 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null

接口功能介绍 获取资产同步时间接口 接口约束 传参规范 URI GET /vfw/v2systemvrfbindsynctime 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 资产同步类型 eip 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj" : "20241113 02:00:22" } 状态码 请参考 状态码

接口功能介绍 下发dpi配置并保存配置，实现配置持久化 接口约束 传参规范 URI POST /vfw/v2dpisave 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ddosProtect 否 String DDos防护开关 firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 runmode 否 String 运行模式 avProtect 否 String AV防护开关 vpatch 否 String 虚拟补丁开关 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header {"regionid": "100054c0416811e9a6690242ac110002","userId":"562b89493b1a40e1b97ea05e50dd8170","accountId":"ca888cf3674d4a83a42dbd71f4a09e94","urlType": "CTAPI"} 请求体body { "firewallId":"c7cfe772fd3f482da630132e6548a19a", "vpatch":"on", "runmode":"block", "ddosProtect":"on", "avProtect":"off" }

接口功能介绍 迁入用户v3 接口约束 无 URI POST /v3/org/migrateUser 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOidList 是 Array of Strings 用户ID列表，可设置一个或多个，最多10个 orgOid 是 String 部门ID includeDesktop 否 Boolean 是否包含云电脑，默认false。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "pubUserOidList":["upgfoo","upgbar"], "orgOid":"orgmig", "includeDesktop":false } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码

本页介绍天翼云TeleDB数据库元数据pgclslevel的内容。 存储行列级安全访问策略的分层信息。 名称 类型 定义 polid int16 策略ID levelid int16 层级ID shortname NameData 简称 longname text 长名称

本页介绍天翼云TeleDB数据库元数据pgsubscriptionshard的内容。 存储发布订阅中，shardmap订阅信息。 名称 类型 定义 srsubid Oid 订阅（subscription）的 OID srshardid int32 分片（shard）的 ID pubname NameData 发布（publication）的名称

监控看板 监控看板：创建 接口功能介绍 创建监控看板，可以创建空看板，也可以附带视图创建。 接口约束 1. 可创建看板数量不能超过用户的看板配额数量。 2. 其他参见请求参数说明。 URI POST /v4/monitor/monitorboard/create 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b name 是 String 监控看板名称， 同资源池下看板名称不可重复 名称 views 否 Array of Objects 监控视图 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 资源键对应的值 5ac245b3dd9b75c3cee5d1b674bb0d69 表 gaugePattern 参数 是否必填 参数类型 说明 示例 下级对象 minVal 否 Integer 仪表盘最小值。默认值为0 0 maxVal 否 Integer 仪表盘最大值。默认值为100 100 threshold 否 Array of Integers 仪表盘中间分段取值，长度必须为2。默认值为[30,80] [30,80]

本页介绍天翼云TeleDB数据库如何使用数据稽查功能对比迁移。 数据稽查功能用于对比源库与目标库的数据差异，帮助用户及时发现数据不一致的问题。支持对源库和目标库的对象数目、数据行数、字段内容等多个维度的进行一致性对比。 数据稽查的类型 对象对比 对象级对比任务，对源库和目标库的数据库、索引、表、视图等对象的数量进行对比，检查数据对象是否缺失。 支持的数据链路：MYSQL > TeleDB、PostgreSQL > TeleDB。 行数对比 通过对源和目标库中表的行数进行对比，检查表的数据是否缺失。 支持的数据链路：MYSQL > TeleDB、PostgreSQL > TeleDB、 Oracle > TeleDB。 内容对比 通过对源和目标库中表的行数据进行对比，检查表的行数据是否一致。 支持的数据链路： MYSQL > TeleDB、PostgreSQL > TeleDB、 Oracle > TeleDB。 支持设置数据块大小： 用户可以自由控制内容对比的数据块大小，数据块的大小可设置在100010000范围内。 支持抽样校验： 如果迁移或同步的数据量非常大，对所有数据都进行校验会对源库和目标库造成高负荷。为此，内容对比提供抽样校验功能，用户可以通过设置抽样比例对数据进行抽样检验，以减小数据库的负担。可设置的抽样比例为10%、20%、30%、……、100%。 支持设置任务超时时间： 用户可以设定内容对比任务的最长运行时间，如果任务未能在最大期限内完成，则任务自行终止。可设置的时间长度为1180分钟。 支持查看不一致数据的所在范围： 如果发现不一致的数据，用户可以查看不一致数据所在的范围，缩小了用户需要自行检查的数据范围。 操作步骤 1. 在DTS的实例管理页面，单击目标实例名称，进入实例详情页面。 2. 在左侧菜单栏选择 数据稽查 ，进入数据稽查页面。 3. 在数据稽查 页面，您可以分别在对象级对比、数据级对比、内容级对比页面创建不同级别的对比任务。

介绍分布式消息服务RabbitMQ与天翼云其他服务关系。 虚拟私有云(CTVPC，Virtual Private Cloud) 虚拟私有云为分布式消息服务RabbitMQ提供一个逻辑隔离的区域，构建一个安全可靠、 可配置和管理的虚拟网络环境。更多信息请参见虚拟私有云。 弹性云主机（CTECS，Elastic Cloud Server） 分布式消息服务RabbitMQ订购后，默认按照用户选择的实例规格开通弹性云主机，云主机由 CPU、内存、镜像、云硬盘组成，同时结合VPC、安全组、数据多副本保存等能力，打造一个既高效又可靠安全的计算环境，确保分布式消息服务RabbitMQ持久稳定运行。更多信息请参见弹性云主机。 云硬盘（CTEVS，Elastic Volume Service） 分布式消息服务RabbitMQ订购后，默认按照用户选择的存储大小开通云硬盘。云硬盘是一种可弹性扩展的块存储设备，可以为分布式消息服务RabbitMQ提供高性能、高可靠的块存储服务。更多信息请参见云硬盘。 弹性IP（Elastic IP，EIP） 弹性IP是可以独立申请的公网 IP 地址，包括公网IP地址与公网出口带宽服务。可以与分布式消息服务RabbitMQ动态绑定和解绑，实现云资源的互联网访问。针对需要公网访问分布式消息服务RabbitMQ实例的需求，用户可开通弹性IP后，在RabbitMQ实例开通页面进行绑定。更多信息请参见弹性IP。