接口功能介绍 非对称密钥签名接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricSign 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 加密算法，取值范围为RSAPSSSHA256、SM2 RSAPSSSHA256 digest 是 String 消息摘要 mkmscsninfnenfck 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 签名成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 value String 签名值 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba requestId String 请求ID baffe114c43746e9904292783a810c7c

接口功能介绍 获取非对称密钥公钥 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/getPublicKey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id 2ab1a98370724bbca5826387f05ae0d8 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取非对称公钥成功 returnObj Array of Objects 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 93744738dc6d4f90b2d20d537b5d64e1 publicKey String 非对称密钥公钥 BEGIN PUBLIC KEY MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAERveD+oLdkLEqGVJ5Me/3pf5cnhda j1S/3n0qjm1Zokp1RuU60C9nZxVbsQi8KEII9f5h0ZpGMsYpgW4rsCwRhg END PUBLIC KEY cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792

接口功能介绍 本接口用于创建回调规则，即绑定回调模板至设备。 接口约束 创建回调规则确保存在该回调模板以及需要绑定的设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI POST /v2/callbackTemplate//callbackRule 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateId 是 String 模板ID。 739943519892963328 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 700576974938832896 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 TemplateId String 模板ID。 739943519892963328 DeviceId String 设备ID。 700576974938832896 CreatedTime String 回调规则创建时间。 1691995152 UpdatedTime String 回调规则更新时间。 1691995152 RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

接口功能介绍 调用此接口可查看告警联系人的配置详情。 接口约束 告警联系人ID存在。 URI GET /v4/monitor/describecontact 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 contactID String 是 a6fb570f22995bde989cdf0819c687d0 告警联系人ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 name String 用户名 gxlupdate phone String 手机号 18919128910 email String 邮箱 864307365@qq.com contactGroupList Array of Objects 所属组信息 contactGroup lastUpdate String 最近更新时间 20220929T09:51:33Z 表contactGroup 参数 参数类型 说明 示例 下级对象 contactGroupID String 联系人组ID b6fb5df3gasd5bde989cdf0819c687d0 name String 联系人组名称 testgroup

告警黑名单 告警黑名单：删除 接口功能介绍 批量删除告警黑名单。 接口约束 告警黑名单存在。 URI POST /v4/monitor/deletealarmblacklists 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b blacklistIDList 是 Array of Strings 告警黑名单ID列表 ['5a592d2f48695667a088b9d54336c166'] 响应参数 参数 参数类型 说明 示例 下级对象 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 请求示例 请求url /v4/monitor/deletealarmblacklists 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "blacklistIDList":[ "5a592d2f48695667a088b9d54336c166" ] }

通知模板 通知模板：标记自定义默认通知模板 接口功能介绍 调用此接口可标记自定义默认通知模板。 接口约束 1. 通知模板存在。 2. 同一服务和维度下，自定义默认通知模板只能设置一个。 URI POST /v4/monitor/marknoticetemplateisdefault 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 noticeTemplateID 是 String 通知模板ID 312b56b43e4311ed8ef2005056898fe0 isDefault 是 Boolean 是否为自定义默认通知模板 false 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true

站点监控 站点监控任务：启用 接口功能介绍 调用此接口可启用站点监控任务。 接口约束 站点监控任务ID列表不能为空。 URI POST /v4/monitor/enablesitemonitor 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 taskIDList 是 Array of Strings 站点监控任务ID列表 ['64ea16644347558e9bc6651341c2fa15'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true 请求示例 请求url /v4/monitor/enablesitemonitor 请求头header 无 请求体body json { "taskIDList":["64ea16644347558e9bc6651341c2fa15"] }

监控看板 监控看板：删除视图 接口功能介绍 删除监控视图。 接口约束 参见请求参数说明。 URI POST /v4/monitor/monitorboard/deleteview 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b viewIDs 是 Array of Strings 要删除的监控视图ID ['ab6fe00f971dd17ff5db493f0cb628e6'] 响应参数 参数 参数类型 说明 示例 下级对象 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/monitorboard/deleteview 请求头header 无 请求体body json { "regionID": "1234567890", "viewIDs": ["868b84d01a6fb6b28b7f26bdf85f96ab"] }

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

站点监控 站点监控任务：删除 接口功能介绍 调用此接口可删除站点监控任务。 接口约束 站点监控任务ID列表不能为空。 URI POST /v4/monitor/deletesitemonitor 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 taskIDList 是 Array of Strings 站点监控任务ID列表 ['64ea16644347558e9bc6651341c2fa15'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true 请求示例 请求url /v4/monitor/deletesitemonitor 请求头header 无 请求体body json { "taskIDList":["64ea16644347558e9bc6651341c2fa15"] }

站点监控 站点监控任务：禁用 接口功能介绍 调用此接口可禁用站点监控任务。 接口约束 站点监控任务ID列表不能为空。 URI POST /v4/monitor/disablesitemonitor 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 taskIDList 是 Array of Strings 站点监控任务ID列表 ['64ea16644347558e9bc6651341c2fa15'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true 请求示例 请求url /v4/monitor/disablesitemonitor 请求头header 无 请求体body json { "taskIDList":["64ea16644347558e9bc6651341c2fa15"] }

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

本节主要介绍查询迁移进度 迁移进度展示了迁移过程中，实时迁移任务的表迁移进度，可以帮助您了解迁移完成的情况。 DRS提供流式进度展示，帮助您在迁移过程中实时了解迁移进展。全量迁移过程中，展示迁移进度总览和迁移明细。 进度总览中，您可以查看结构、数据、索引迁移的进度，当显示为100%时，表示该项迁移完成。过程中，数据和索引的迁移相对较慢。 迁移明细中，您可以查看具体迁移对象的迁移进度，当“对象数目”和“已迁移数目”相等时，表示该对象已经迁移完成，可通过“查看详情”查看每个对象的迁移进度。增量迁移中，“进度明细”将不再显示，您可以使用“迁移对比”页签查看一致性情况。 前提条件 已登录数据复制服务控制台。 已启动迁移任务。 操作步骤 步骤 1 在“实时迁移管理”界面，选中指定迁移任务，单击任务名称，进入“基本信息”页面。 步骤 2 单击“迁移进度”页签，查看迁移进度。 查看结构、数据、索引的迁移的百分比进度。 “全量迁移”模式：当全量迁移完成时，显示全量迁移各项指标完成进度100%。 “全量+增量”迁移模式：全量迁移完成后，开始进行增量迁移可，在“迁移进度”页签下，查看增量迁移同步时延。 增量迁移时延也可在“实时迁移管理”界面查看，当增量时延超过用户设置或系统默认的时延阈值时，任务管理界面增量时延显示为红色。 说明 时延 源库当前系统时间 成功同步到目标库的最新一个事务在源库的提交成功时间。 一个事务同步的完整过程如下： 1. 源端数据库的抽取； 2. 经过网络的传输； 3. 由DRS进行日志解析； 4. 最终在目标数据库上的执行完成。 这样完成了事务从源到目标的同步，时延为该事务最后在目标数据库上执行完成时的源库当前系统时间（currenttime）与该事务在源库的提交成功时间（committedtime）的时间差，时延为0代表源和目标瞬时一致，无新的事务需要同步。 注意 长时间未提交事务和频繁DDL操作均可以造成高时延。 查看迁移对象的进度。在“进度明细”下，单击目标迁移对象“详细信息”列的“查看详情”，查看对象的迁移进度，进入增量迁移后，该数据将不再显示，您可以使用“迁移对比”页签，进行一致性对比。

接口功能介绍 调用该接口创建镜像缓存 接口约束 无 URI POST /eci/api/v1/imageCache/createImageCache 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 区域ID bb9fdb42056f11eda1610242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageCacheName 是 String 镜像缓存名字 test imageCacheSize 否 Integer 镜像缓存大小 ,默认为20G 20 retentionDays 否 Integer 镜像缓存保留时间（单位天），不传或传0表示永不过期 ，最大值3650 30 tags 否 Array of Objects 标签 tag securityGroupId 是 String 安全组ID sgtest vSwitchId 是 String 子网ID subnettest azInfo 是 Object 可用区 azInfo imageRegistryCredentials 否 Array of Objects 不带 http:// 或 https:// 前缀的镜像仓库地址 imageRegistryCredential images 是 Array of Strings 镜像列表 ["registryvpccrshuadong1.ctyun.cn/xeci/base:latest"] eip 否 Object 弹性公网 IP。如果需要拉取公网镜像，需要确保 ECI 实例能够访问公网，您可以配置 EIP 或者 NAT 网关实现公网访问。 eip vpcId 是 String 实例所在VpcId vpcctt6yag121 表 tag 参数 是否必填 参数类型 说明 示例 下级对象 key 否 String 标签的key keytest value 否 String 标签的value valuetest 表 azInfo 参数 是否必填 参数类型 说明 示例 下级对象 azName 是 String az名称 az1 表 imageRegistryCredential 参数 是否必填 参数类型 说明 示例 下级对象 server 是 String 服务名称 chengdu1az1.crs.ctyun.cn userName 是 String 用户名 testuser password 是 String 镜像凭证密码 testpwd 表 eip 参数 是否必填 参数类型 说明 示例 下级对象 eipInstanceId 是 String eip 实例ID az1

本页介绍天翼云TeleDB数据库元数据pgsubscriptiontable的内容。 存储发布订阅中的表信息。 名称 类型 定义 srsubid Oid 订阅（subscription）的 OID srrelid Oid 表（table）的 OID pubname NameData 发布（publication）的名称

项目 描述 No. 序号。 Log ID 日志ID。 File 日志文件存储路径。 Type 日志类型。 ServerNum 日志采集的服务器个数。 Status 日志采集的状态： Processing：日志采集中。 Succeeded：采集成功。 PartiallySucceeded：部分采集成功。 Failed：采集失败。

接口功能介绍 安全告警标记已处理 接口约束 传参规范 URI POST /vfw/v2alarmhandle 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 alarmIds 是 Array of Strings alarmIds ["110"] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Integer 接口返回结果 1 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "alarmIds": ["110"] } 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj": 1 } 状态码 请参考 状态码

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

接口功能介绍 关联带宽及其绑定VPC下的子网，覆盖原来关联的子网。 幂等接口，同一子网重复设置时，视为成功。 接口约束 无 URI POST /v3/bandwidth/setSubnet 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 bandwidthOid 是 String 带宽ID bwsya8ts02mjfxfxf2i000t subnetOidList 是 Array of Strings 子网ID列表，长度至少为1 snddlkbe3d868wblg7r4wx7 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"bandwidthOid":"bwfoo","subnetOidList":["snxx"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

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

接口功能介绍 将QOS复制到账号的其它资源池下。 接口约束 无 URI POST /v3/qos/copyQos 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 qosOidList 是 Array of Strings 要复制的QOS ID列表 targetRegionIdList 否 Array of Strings 复制的目标资源池ID列表, 非必传, 不传默认复制到账号下所有资源池 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "qosOidList":["sqsxxxa","sqsxxxb"], "targetRegionIdList":["region1","region2"] } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } }

接口功能介绍 快照策略功能请联系客户经理开通。 幂等接口，重复取消会忽略并视为取消成功。 注意！若云电脑与快照策略不存在分配关系，取消时会直接忽略。 接口约束 无 URI POST /v3/snapshotPolicy/cancelFromDesktops 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y desktopOidList 是 Array of Strings 云电脑ID列表。长度限制[1,10]。 D0023092201180710 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotPolicyOid":"sspxxx","desktopOidList":["XXXXXXXXXXXXX6925"]}

接口功能介绍 设置本地管理员权限v3 接口约束 无 URI POST /v3/user/batchSetLocalAdministrator 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOidList 是 Array of Strings 用户ID列表，最大数量100 desktopAdminPriv 否 String 账号权限(DesktopUser普通权限;DesktopAdmin本地管理员权限) 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "desktopAdminPriv":"DesktopAdmin", "pubUserOidList":["upgfoo","upgbar"] } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码

接口功能介绍 修改VPC子网属性 接口约束 无 URI POST /v3/vpc/subnet/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 subnetOid 是 String VPC子网ID snvpma7obaz5i6wgv4fh38f subnetName 是 String VPC子网名称（只能包含中文、英文、数字、下划线、中划线和点，长度限制:[2,64]） maxmmaxm 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"subnetOid":"subnetmod","subnetName":"fooNewName"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

接口功能介绍 仅支持未激活（待确认状态）的用户 接口约束 无 URI POST /v3/user/resendActivationMail 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOid 是 String 用户ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "pubUserOid":"upoxxxxx" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

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

接口功能介绍 创建角色 接口约束 无 URI POST /v3/role/createSystemRole 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 sysRoleName 是 String 角色名称 testrole sysRoleDesc 否 String 角色描述 roletestdescripetion status 是 Integer 角色状态（1有效） 1 shareFlag 否 Integer 角色是否共享（0私有，1共享） 0 sysRoleCode 否 String 角色标识 test555 orgOid 是 String 部门ID orgtest 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "sysRoleName":"test555", "sysRoleDesc":"roletestdescripetion", "status":1, "shareFlag":0, "sysRoleCode":"test555", "orgOid":"orgtest" }

接口功能介绍 修改快照属性 接口约束 无 URI POST /v3/snapshot/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotOid 是 String 快照ID ssbmda2gjsbz89lkx2a1an5 name 是 String 快照名称。只能包含汉字、数字、英文字母、中划线和下划线，长度限制116个字符。 abc description 是 String 描述。字符数限制[0,250]。 abc 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotOid":"dstfoo","name":"fooupdateaUpi6aRm","description":"fooremark"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

接口功能介绍 删除防护规则接口 接口约束 请保证ruleId存在 URI POST /vfw/v2systemsecpolicydelete 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 否 String 防火墙id和类型必须填一个 dca4f9ffaca2447aa24310c1e62c4690 firewallType 否 String 防火墙id和类型必须填一个 NorthSouth ruleId 是 Long 规则id 1099 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "ruleId":1099, "firewallId":"dca4f9ffaca2447aa24310c1e62c4690" }

接口功能介绍 一键创建子网路由表 接口约束 传参规范 URI POST /vfw/v2createsubnetroute 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 subnetId 是 String 子网id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body 无 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!" } 状态码 请参考 状态码

接口功能介绍 查询资源池规格 接口约束 传参规范 URI GET /vfw/v2queryregionmaximums 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 RegionBuyMenuEntity 表 RegionBuyMenuEntity 参数 参数类型 说明 示例 下级对象 protectionIpNumMax Integer 可防护ip最大数 1 flowProcessingCapacityMax Integer 最大公网流量处理能力 1 vpcQuotaMax Integer VPC边界防火墙最大数量 1 vpcFlowProcessingCapacityMax Integer 最大VPC流量处理能力 1 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {}

接口功能介绍 统计地址簿数量和所用ip数量 接口约束 传参规范 URI GET /vfw/v2addressgroupstatistic 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 AddressGroupStatisticsView 表 AddressGroupQueryView 参数 参数类型 说明 示例 下级对象 addressGroupNum Integer 地址组数量 1 ipQuota Integer 可添加 IP 总数 10000 addressGroupQuota Integer 地址簿配额 1000 ipNum Integer 所有地址簿的ip数量之和 2 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {}