使用须知 在创建同步任务前，请务必阅读以下使用须知。 说明 建议创建单独用于DRS任务连接的数据库帐号，避免因为数据库帐号密码修改，导致的任务连接失败。 连接源或目标数据库的帐号密码修改后，请尽快修改连接信息，避免任务连接失败后自动重试，导致数据库帐号被锁定影响使用。 表使用须知 类型名称 使用和操作限制 数据库权限设置 l 源数据库帐号需要具备如下权限：SELECT、SHOW VIEW、EVENT、LOCK TABLES、REPLICATION SLAVE、REPLICATION CLIENT。 l 目标数据库帐号必须具有每张表的如下权限：INSERT、SELECT、UPDATE、DELETE、CONNECT、CREATE、REFERENCES。 同步对象约束 l 支持表、索引、约束（主键、空、非空）的同步，不支持视图、外键、存储过程、触发器、函数、事件、虚拟列、唯一约束、唯一索引的同步。 l 全量同步支持comment，增量不支持。 l 不支持的数据类型有：xml、geometry、point、lineString、polygon、geometrycollection、multipoint、multilinestring、multipolygon。 l 不支持非MyISAM和非InnoDB表的同步。 l 对象名同步到目标库后会转换成小写，因此选择的源库表中不能存在表名称字母相同但大小写不同的表，否则，会导致同步失败。 源数据库要求 l 增量同步时，MySQL源数据库的binlog日志必须打开，且binlog日志格式必须为Row格式。 l 在磁盘空间允许的情况下，建议源数据库binlog保存时间越长越好，建议为3天。设置为0，可能会导致同步失败。 − 源数据库为自建MySQL时，通过设置expirelogsdays参数设置binlog保留时间。建议将expirelogsday参数设置在合理的范围，确保恢复时断点处的binlog尚未过期，以保证任务中断后的顺利恢复。 − 源数据库为RDS for MySQL时，设置binlog保留时间可参考《RDS用户指南》。 l 源数据库GTID状态必须为开启状态，源数据库实例没有开启GTID的情况下不支持主备倒换，DRS任务会因为位点不续接而中断导致无法恢复。 l 必须设置MySQL源数据库的server－id，server－id的取值范围在2－4294967296之间。 l 源数据库中的库名、表名不能包含：. /"以及非ASCII字符。 目标数据库要求 l 目标数据库实例的运行状态必须正常。 l 目标数据库实例必须有足够的磁盘空间。 l 目标数据库的时区设置必须与源数据库一致。 操作须知 l 相互关联的数据对象要确保同时同步，避免因关联对象缺失，导致同步失败。常见的关联关系：索引引用表等。 l 不支持外键级联操作。当外键是普通索引的时候，可能会导致表结构创建失败，建议改成唯一索引。 l 不支持源数据库进行恢复操作。 l 不支持强制清理binlog，否则会导致同步任务失败。 l 源数据库不支持reset master或reset master to命令，可能会导致DRS任务失败或者数据不一致。 l 不建议在数据库中使用非精确数值类型做主键，该特性影响 DRS 增量场景下对 UPDATE、DELETE语句的同步，导致任务失败。 l 如果无主键表中包含大字段（blob、text、clob、nclob、bytea），增量同步阶段存在大字段数据不一致的可能性。 l 源库为RDS for MySQL实例时，不支持带有TDE特性并建立具有加密功能表。 l 源库为RDS for MySQL实例时，支持源端多张表对DWS一张表的映射。详细操作可参考创建MySQL到DWS同步任务。 l 如果源库MySQL不支持TLS1.2协议，或者为版本较低的自建库（低于5.6.46或在5.7.05.7.28之间），如果不支持TLS1.2协议，需提交运维申请才能使用SSL测试连接。 l 网络中断在30秒内恢复的，不影响实时同步，如果超过30秒，则会导致同步任务失败。 l MySQL的唯一约束（unique key）在同步到目标DWS后会改写成普通约束，主键（primary key）的同步保持不变。 l 目标数据库与源数据库字符集不一致可能会导致同步后数据不一致或者同步失败。 l 数据类型不兼容时，可能引起同步失败。 l 支持目标数据库中的表比源数据库多列场景，但是需要避免以下场景可能导致的任务失败。 − 目标端多的列要求非空且没有默认值，源端insert数据，同步到目标端后多的列为null，不符合目标端要求。 − 目标端多的列设置固定默认值，且有唯一约束。源端insert多条数据后，同步到目标端后多的列为固定默认值，不符合目标端要求。 l 实时同步过程中，若源库为RDS时，支持修改端口，修改之后同步任务失败，需要通过重试后继续进行同步。 l 实时同步过程中，若源库为非RDS时，不支持修改端口。 l 实时同步过程中，不支持IP、帐号、密码修改。 l DRS全量同步表结构时，源库中char、varchar、nvarchar、enum、set字符类型长度在目标库会按照字节长自动扩大（因为目标库为字节长），扩大倍数和源库中列的字符集有关。如源库字符集为UTF8的按照字节长扩大3倍，为UTF8MB4的按照字节长扩大4倍。 l 增量同步过程中支持DDL操作。 − 一对一的场景下，默认同步的DDL类型有CREATETABLE，RENAMETABLE，ADDCOLUMN，MODIFYCOLUMN，ALTERCOLUMN，CREATEINDEX，DROPINDEX，RENAMEINDEX，CHANGECOLUMN，TRUNCATETABLE，DROPTABLE，客户可以根据自身需求，在对象选择页面选择需要同步的DDL类型。 − 多对一场景下，执行colunm重命名操作，必须停业务操作，不然会有数据不一致的风险。 − 新增和修改表名、列名、索引名时不能超出63字符，否则任务会失败。 − 源库无主键表增加主键的时候，必须含有第一列，否则任务会失败。 l 增量同步过程中，库级同步新建的无主键表必须包含以下列中的其中之一。 INTEGER TYPES: TINYINT、SMALLINT、INT、BIGINT、NUMERIC/DECIMAL； CHARACTER TYPES: CHAR、BPCHAR、VARCHAR、VARCHAR2、NVARCHAR2； DATE/TIME TYPES: DATE、TIME、TIMETZ、TIMESTAMP、TIMESTAMPTZ、INTERVAL、SMALLDATETIME； 无主键表会指定可作为分布列的其中一列作为分布列，如果所有列类型都无法作为分布列，会导致建表失败，DRS同步中断。 l 库级同步，在增量同步过程中，不能在源库创建名称字母相同但大小写不同的表，否则会导致其中一张表无法同步。 l 建议将expirelogday参数设置在合理的范围，确保恢复时断点处的binlog尚未过期，以保证服务中断后的顺利恢复。 l 源端同步的表如果有AUTOINCREMENT属性，结束任务时，DRS会自动刷新同步表的序列整型列所对应的DWS自增列（sequence）起始值，刷新值为该列的最大值+10000。

接口功能介绍 创建iplistener 接口约束 无 URI POST /v4/iplistener/create 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 gwLbID 是 String 网关负载均衡 ID gwlbxxx name 是 String 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 test description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:"{},./;'[]·！@ ￥%……&（） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc action 是 Object 动作配置 action 表 action 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 默认规则动作类型。取值范围：forward forward forwardConfig 是 Object 转发配置，当type为forward时，此字段必填 fowardConfig 表 forwardConfig 参数 是否必填 参数类型 说明 示例 下级对象 targetGroups 是 Array of Objects 后端服务组 targetGroup 表 targetGroup 参数 是否必填 参数类型 说明 示例 下级对象 targetGroupID 是 String 后端服务组ID tg0xxx weight 否 Integer 权重，当前只支持配置100 100

接口功能介绍 非对称密钥签名接口 接口约束 请保证账户余额大于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

自定义事件 自定义事件：删除 接口功能介绍 调用此接口可删除自定义事件。 接口约束 资源池ID，自定义事件ID列表不能为空。 URI POST /v4/monitor/deletecustomevents 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b customEventIDList 是 Array of Strings 自定义事件ID列表 ['EVENT78901234t678a901202306301809'] 响应参数 参数 参数类型 说明 示例 下级对象 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/deletecustomevents 请求头header 无 请求体body json { "regionID":"81f7728662dd11ec810800155d307d5b", "customEventIDList":["EVENT78901234t678a901202306301809"] }

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

接口功能介绍 获取接入点的接口权限详情 接口约束 无 URI POST /v1/applicationAccessPointManage/listPointUriPolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Strings 接口权限详情 ["kms:cmk:create","kms:cmk:create"] 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" } 响应示例 plaintext { "statusCode": 200, "message": "获取Uri权限详情成功", "returnObj": { "list": [ "kms:cmk:create", "kms:cmk:create" ] } } 状态码 请参考状态码章节 错误码 请参考错误码章节

本页介绍天翼云TeleDB数据库的开发相关规范。 1. 建议对表、视图、列添加备注，可以通过阅读备注信息，快速了解相关对象定义，了解相关业务关联逻辑。 2. 在对象命名时，取名应与该对象表达的意义相匹配，做到见名知义。 3. 建议update更新时尽量增加 <> 判断条件，例如update tablea set columnb c ；可以更改为update tablea set columnb c where columnb <> c；更新列时，已经是更新后值的记录不会再去更新，不会新增1个版本记录，可以减少vacuum回收工作量。 4. 建议不要使用大事务，大事务会锁更多的资源，锁的时间会更长，应将大事务按业务需要拆分成多个小事务，拆分成小事务后可以有效降低锁冲突概率。 5. 建议大批量数据入库时，使用copy代替insert、upsert，可以显著提高效率。 6. 不使用外键，外键会让数据库逻辑变的更复杂，还有一些使用限制，应通过业务逻辑代替外键。 7. 不使用触发器，触发器严重影响性能，应通过业务逻辑代替触发器。

接口功能介绍 操作日志excel导出 接口约束 传参规范 URI POST /vfw/v2logmanagerexportoperatelog 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id beginTime 是 Long 开始时间 endTime 是 Long 结束时间 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "firewallId": "4f12ffeaed354b77971952870c2ceacf", "severities": [ "HIGH" ], "action": "UPDATEASSERTPROTECT", "beginTime": 1731554784, "endTime": 1731641184, "regionId": "81f7728662dd11ec810800155d307d5b" }

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

接口功能介绍 至少指定一项待修改的属性。 接口约束 无 URI POST /v3/customImage/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOid 是 String 镜像ID mijdf39e1579j44bcrpa4hg imageName 否 String 镜像名称。只能由数字、英文字母、中划线、下划线和小数点组成，字符数限制[1,50]。 description 否 String 描述。字符数限制[0,200]。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"imageOid":"mixxx","imageName":"abb","description":null} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

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

接口功能介绍 修改VPC子网DNS 接口约束 无 URI POST /v3/vpc/subnet/modifyDns 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 subnetOid 是 String 子网ID snfdvgm1exbhxbyvhh4eg2f dnsList 是 Array of Strings 子网DNS服务器列表（最少1个，最多5个） 115.115.115.115 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"subnetOid":"subnetmod","dnsList":["114.114.114.114"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

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

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

接口功能介绍 操作前请确保池化桌面池中没有云电脑 接口约束 无 URI POST /v3/commonDesktopPool/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 池化桌面池ID dpucod37vk0gca50kur44j4 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 快照策略功能请联系客户经理开通。 接口约束 无 URI POST /v3/snapshotPolicy/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotPolicyOid":"sspxxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 计算增强型云电脑功能请联系客户经理开通。 接口约束 无 URI POST /v3/ecs/modifyNickname 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID nickname 是 String 别名（最大长度20，只能包含数字、字母、汉字） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "desktopOid":"XXXXXXXXXXXXX6925", "nickname":"nicknameTest" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码

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

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

接口功能介绍 提供切换黑白名单或白名单防护状态接口 接口约束 无 URI POST /vfw/v2blackwhitepolicyswitchprotectstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙ID a6449feab4db11e9a6b40242ac110007 regionId 是 String 资源池ID ruleId 是 Long 规则ID 321 status 是 String 规则开关；disable；enable； disable uid 是 String 租户ID 6ee4c9fa71c3403eab8af44e29c3e4c1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果

接口功能介绍 计算增强型云电脑功能请联系客户经理开通。 接口约束 无 URI POST /v3/ecs/bindUser 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOid 是 String 用户ID desktopOid 是 String 云电脑ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "pubUserOid":"upgxxx", "desktopOid":"XXXXXXXXXXXXX6925" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 计算增强型云电脑功能请联系客户经理开通。 接口约束 无 URI POST /v3/ecs/modifyPassword 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID password 是 String 密码，字符数限制：[8,26]。 必须至少包含大小写英文字母、数字和特殊符号三类字符，特殊字符集合：~!@ $%^&()+{[]} ;:,.'?/<>。 密码不建议包含与账号相关的信息。 密码不能使用3个及以上键盘连续相邻字符，如123，Qwe等。 注意：如果传入password参数，建议您使用HTTPS协议发送请求，避免密码泄露 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj

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

接口功能介绍 云硬盘快照功能请联系客户经理开通。 接口约束 无 URI POST /v3/cloudVolumeSnapshot/modifyAttribute 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotOid 是 String 云硬盘快照ID snapshotName 是 String 云硬盘快照名称（不能超过64个字符） description 是 String 云硬盘快照描述（不能超过250个字符"） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "snapshotOid":"xxxxxxxxxxx", "snapshotName":"snapshotNameTest", "description":"this is cloud volume snapshot test" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } }

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

接口功能介绍 幂等接口，重复解绑会忽略并视为成功。 接口约束 无 URI POST /v3/desktop/unbindUser 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023101301183998 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOid":"XXXXXXXXXXXXX6925"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 切换云电脑所在VPC 接口约束 无 URI POST /v3/desktop/batch/changeVpc 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOidList 是 Array of Strings 云电脑ID列表，可设置一个或多个，最多10个 D0023092101180485 subnetOid 是 String 目标VPC子网ID snw3b8o6cb7afw4l3vd3bgb 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOidList":["XXXXXXXXXXXXX6925"],"subnetOid":"snxxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

接口功能介绍 安全告警标记已处理 接口约束 传参规范 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":{ }} 状态码 请参考 状态码 错误码 请参考 错误码