接口功能介绍 资源解绑标签接口 接口约束 无 URI POST /v1/lebalControl/unbindResource 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 resourceId 是 String 资源id 9612627252624b61bf5cd66ca3c7a0b3 prodSpecInstId 否 String 产品规格实例id 53e50630604f42eba9d4fd9e0d8458bf labelId 是 String 标签标识 9612627252624b61bf5cd66ca3c7a0b3 baseResourceId 是 String 资源标识 9612627252624b61bf5cd66ca3c7a0b3 key 是 String key值 123 value 是 String value值 123 operateType 否 String 操作类型(解绑UNBIND) UNBIND 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d

接口功能介绍 修改标签接口 接口约束 无 URI POST /v1/lebalControl/updateLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 operateType 否 String 操作类型（新增ADD，修改UPDATE，删除DELETE） UPDATE 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 56495f1608e845a7871844941bcc8350 枚举参数 无 请求示例 请求url 请求头header { "regionId": "200000001852" } 请求体body { "key": "xyz", "value": "777" }

接口功能介绍 修改标签接口 接口约束 无 URI POST /v1/lebalControl/updateLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 operateType 否 String 操作类型（新增ADD，修改UPDATE，删除DELETE） UPDATE 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 56495f1608e845a7871844941bcc8350 枚举参数 无 请求示例 请求url 请求头header { "regionId": "200000001852" } 请求体body { "key": "xyz", "value": "777" }

SSL VPN客户端密码重置。 接口功能介绍 SSL VPN客户端密码重置 接口约束 无 URI POST /v4/vpn/sslclient/resetkeyword 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 sslClientID 是 String SSL客户端ID c81b17f32073409295e3cfd78bf49444 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 616797965481 请求示例 请求url 无 请求头header 无 请求体body json { "sslClientID":"c81b17f32073409295e3cfd78bf49444", "regionID":"b342b77ef26b11ecb0ac0242ac110002" }

接口功能介绍 获取监控/告警服务的服务与维度的对应关系。 接口约束 无。 URI GET /v4/monitor/queryalarmserdimrelations 请求参数 Query参数 无。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 relations Array of Objects 关系列表 relation 表relation 参数 参数类型 说明 示例 下级对象 service String 服务 ecs dimension Array of String 服务列表 ["ecs"] 请求示例 GET /v4/monitor/queryalarmserdimrelations 响应示例 json { "statusCode": 800, "returnObj": { "relations": [ {"service": "ecs", "dimension": ["ecs"]}, {"service": "evs", "dimension": ["evs"]}, {"service": "cdci", "dimension": ["netbag"]}, {"service": "ippool", "dimension": ["trafficp", "fip", "fipv6"]}] }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

接口功能介绍 获取监控/告警服务的维度与设备类型的对应关系。 接口约束 无。 URI GET /v4/monitor/querydimdevrelations 请求参数 Query参数 无。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 relations Array of Objects 关系列表 relation 表relation 参数 参数类型 说明 示例 下级对象 dimension String 维度 ecs device String 设备类型 vm 请求示例 GET /v4/monitor/querydimdevrelations 响应示例 json { "statusCode": 800, "returnObj": { "relations": [ {"dimension": "ecs", "device": "vm"}, {"dimension": "disk", "device": "disk"}, {"dimension": "pms", "device": "metal"} ] }, "errorCode": "", "message": "Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功

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

接口功能介绍 校验监控视图的名称是否存在（重复）。 一个监控面板（template），包含多个监控视图（views），监控视图包含多个监控项（items）内容。 此处检验的名称，指的是监控视图（views）的名称。 接口约束 regionID（资源池）和templateID（监控面板）存在。 URI GET /v4/monitor/checkmonitor 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 f2efc544504711ed8fb7005056897257 监控模板ID title String 是 view1 监控视图名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 exist Boolean 是否重复命名 true

接口功能介绍 清空指定监控面板的所有监控视图（不可回退，请谨慎操作）。 一个监控面板包含若干个监控视图。 接口约束 regionID（资源池）、templateID（监控面板）存在。 URI POST /v4/monitor/clearmonitorview 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 clearCount Integer 成功清除的监控视图个数 2 请求示例 POST /v4/monitor/clearmonitorview 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "templateID": "466d5eb4484311eda9b7005056897257" }

接口功能介绍 查询指定地域内的可用区信息 接口约束 无 URI GET /eci/api/v1/region 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 地域Id bb9fdb42056f11eda1610242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 请求成功(200)或失败(非200) 200 error String 错误码，三段式 ECI.Openapi.StatusReasonInternalError message String 错误信息描述 Internal error occurred returnObj Object 返回信息 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 region Object 地域Id region 表 region 参数 参数类型 说明 示例 下级对象 regionId String 地域Id {} zones Array of Strings 可用区信息 枚举参数 无 请求示例 请求url GET 请求头header {"regionId": "bb9fdb42056f11eda1610242ac110002"} 请求体body 无 响应示例 { "statusCode": 200, "returnObj": { "region": { "regionId": "b342b77ef26b11ecb0ac0242ac110002", "zones": [ "cnxinan11A", "cnxinan12A", "cnxinan13A" ] } } }

接口功能介绍 计算hmacSm3 接口约束 请保证账户余额大于0 URI POST /v1/get/hmaccompute 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 hmac 是 String kms鉴权值 B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw requestDate 是 String 时间戳 Wed, 29 Aug 2023 17:05:01 CST accessKey 是 String ctapi鉴权ak ae2cc5cc5e8211ea978a186590d96509 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 regionId 是 Integer 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥id 3896591785c441a993b247f81634bea7 input 是 String 待处理数据 aa 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码 取值范围：200 成功 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 HMAC结果 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 hmacoutput String sm3hmac结果 DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjKy5nl requestId String 请求id a857cc58ab6f40acb9e7fa1781209a76

本节为您介绍自建Oracle迁移至自建MySQL任务配置。 前提条件 （1）自建MySQL目标端版本为5.6、5.7、8.0版本。 （2）MySQL实例对表名的英文大小写不敏感，如果使用大写英文建表，MySQL会先把表名转为小写再执行建表操作。 （3）如果您的自建Oracle版本为12c及以上，待迁移表的名称长度需不超过30个字节。 （4）如果源Oracle数据库中存在表名相同仅大小写不同的表，可能会导致迁移对象重名并在结构迁移中提示“对象已经存在”。如果出现这种情况，请在配置迁移对象的时候，使用对象名重命名功能对重名的对象进行重命名。 （5）MySQL需要关闭大小写敏感。 目标端权限要求 迁移模式 所需权限 基础权限 SELECT, DELETE, INSERT 全量迁移 需具备基础权限，且具备ALTER权限 增量迁移 需基本基础权限 结构迁移 CREATE, REFERENCES, INDEX, TRIGGER, CREATE VIEW, DROP, CREATE ROUTINE, EXECUTE 稽核修复 需基本基础权限 目标端配置 数据源类型 选定为MySQL，可将源端迁移至版本范围内的MySQL数据库 服务器IP 目标端数据库的连接IP 端口号 目标端数据库的端口 用户名 用于连接待目标端数据库的用户名称 密码 用于连接待目标端数据库的用户的密码 数据库 目标端用于接收源端数据的数据库名称

步骤类别 参数 参数说明 选择监控对象 规则类型 选择指标监控：对数据指标进行监控。 选择监控对象 云服务 选择VPC终端节点。 选择监控对象 维度 选择终端节点。 选择监控对象 监控对象类型 选择具体实例或资源分组。 选择监控指标 选择类型 可以选择从模板导入或自定义创建。 选择监控指标 模板 选择需要导入的模板。 选择监控指标 监控指标 选择需要监控的数据指标。 选择监控指标 策略 可以选择原始值、平均值、最大值、最小值。 选择监控指标 聚合周期 选择数据聚合的周期。 选择监控指标 出现次数 选择出现多少次触发通知。 选择监控指标 发送通知 配置是否发送邮件通知用户，可以选择“是”或者“否”，推荐选择“是”。 选择监控指标 选择告警联系组 配置发生告警通知的用户组。 选择监控指标 重复告警 告警发生后，如果监控项未恢复正常，之后间隔多久再次发送告警。 选择监控指标 触发场景 触发告警邮件的场景，可在告警及恢复时发送提醒信息。 选择监控指标 通知周期 配置告警通知的周期时间。 选择监控指标 通知时段 配置告警通知的时间段。 选择监控指标 通知方式 配置告警通知的通知方式，支持邮箱及短信。 选择监控指标 告警回调 填写接口URL，例如 规则信息 名称 填写该告警规则的名称。 规则信息 企业项目 选择告警规则适用的企业项目。 规则信息 描述 添加对该告警规则的描述。

步骤类别 参数 参数说明 选择监控对象 规则类型 选择指标监控：对数据指标进行监控。 选择监控对象 云服务 选择VPC终端节点。 选择监控对象 维度 选择终端节点服务。 选择监控对象 监控对象类型 选择具体实例或资源分组。 选择监控指标 选择类型 可以选择从模板导入或自定义创建。 选择监控指标 模板 选择需要导入的模板。 选择监控指标 监控指标 选择需要监控的数据指标。 选择监控指标 策略 可以选择原始值、平均值、最大值、最小值。 选择监控指标 聚合周期 选择数据聚合的周期。 选择监控指标 出现次数 选择出现多少次触发通知。 选择监控指标 发送通知 配置是否发送邮件通知用户，可以选择“是”或者“否”，推荐选择“是”。 选择监控指标 选择告警联系组 配置发生告警通知的用户组。 选择监控指标 重复告警 告警发生后，如果监控项未恢复正常，之后间隔多久再次发送告警。 选择监控指标 触发场景 触发告警邮件的场景，可在告警及恢复时发送提醒信息。 选择监控指标 通知周期 配置告警通知的周期时间。 选择监控指标 通知时段 配置告警通知的时间段。 选择监控指标 通知方式 配置告警通知的通知方式，支持邮箱及短信。 选择监控指标 告警回调 填写接口URL，例如 规则信息 名称 填写该告警规则的名称。 规则信息 企业项目 选择告警规则适用的企业项目。 规则信息 描述 添加对该告警规则的描述。

请求参数 请求头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 表 returnObj 参数 参数类型 说明 示例 下级对象 packList Array of Objects 通知套餐包列表 packObj currentCount Integer 当前页记录数 10 totalCount Integer 获取对象数据条数 50 totalPage Integer 总页数 1 表 packObj 参数 参数类型 说明 示例 下级对象 packID String 通知套餐包ID， 如果值为default，代表免费套餐包。 000f09221f4d8cc8bb2e1c30fb751aa8 packType String 通知套餐包类型，取值范围： sms：短信通知套餐包。 voice：语音通知套餐包。 根据以上范围取值。 sms status Integer 此参数表示状态， 取值范围： 1：正常。 2：已用尽。 3：已到期。 6：冻结。 7：下单中。 根据以上范围取值。 1 effectiveTime Long 套餐生效时间，毫秒级时间戳 1727712000000 expireTime Long 套餐到期时间，毫秒级时间戳 1730390399000 orderCtime Integer 订单创建时间，秒级时间戳 1727712000 quota Integer 总量 1000 used Integer 已用量 5

接口功能介绍 查询证书列表 接口约束 无 URI POST /v1/manageCertificate/listCertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNumber 否 Integer 页码，默认为1 1 pageSize 否 Integer 每页显示证书数量，默认为10 10 instanceId 否 String 实例Id，非必传，当为空时列出所有证书，不为空时列出指定实例下的证书 insX63C8r 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 列表成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 content Array of Strings 证书列表 certInfo pageNumber String 当前页码 1 pageSize String 本页数量 10 totalCount String 证书总数 10 requestId String 请求id a857cc58ab6f40acb9e7fa1781209a76 表 certInfo 参数 参数类型 说明 示例 下级对象 certificateId String 证书id c761ed38f58245ca996bd11e9740dec8 keySpec String 证书密钥类型 RSA2048 exportablePrivateKey Integer 证书私钥是否可导出 1：可 0：不可 1 subject String 证书主体 CN'defaultUserNameCNuserName', OUkms, Oaliyun, STBeiJing, CCN createdTime String 证书创建时间 20221107 18:15:34 status Integer 证书状态 1.PENDING待导入 2.ACTIVE启用 3.INACTIVE禁用 4.REVOKED已吊销 2

接口功能介绍 查询租户购买的eip列表信息。 接口约束 天翼云用户。 URI POST /osm/v2/console/listEip 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNumber 是 Integer 当前分页 1 pageSize 是 Integer 分页显示的数据条数 10 regionID 否 String 资源池id rs848834 azName 否 String 可用区名称 az834834 vpcID 否 String vpc id vpcuijdsj3443 eipId 否 String eip id 700c065cbbd35b8aa07d551dba4a5141 响应参数 参数 参数类型 说明 示例 下级对象 error String 接口错误详情 statusCode String 接口请求状态码 00000表示成功，其他为失败 message String 请口操作结果说明 操作成功或失败说明 page Object 返回数据对像 page returnObj Array of Objects 返回数据对像数组 returnObj 表 page 参数 参数类型 说明 示例 下级对象 current Integer 当前分页 3 size Integer 分页数据记录数 10 total Integer 总数据量 54 表 returnObj 参数 参数类型 说明 示例 下级对象 id String eip id 7uyewjjw977343 name String eip名称 eiposm eipAddress String eip地址 20.138.38.20 status String 状态 ACTIVE: 激活,已绑定 DOWN: 未使用 bandwidth String 带宽 100Mbps createdAt String 创建时间 2024/10/10 10:10 expireDate String 到期时间 2024/10/10 10:10

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

接口功能介绍 移除安全组v3 接口约束 无 URI POST /v3/securityGroup/remove 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 桌面id securityGroupOid 是 String 安全组id portOid 否 String 网卡id，参数为空表示桌面移除安全组，参数非空表示桌面网卡移除安全组 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回安全组id sgdes9ihmdrpas8pdge4e4l 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopOid":"D0025042401321395", "securityGroupOid":"sgdes9ihmdrpas8pdge4e4l", "portOid":"portggpgxz5n5nhmro3fw34jg" }

接口功能介绍 加入安全组v3 接口约束 无 URI POST /v3/securityGroup/join 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 桌面id securityGroupOid 是 String 安全组id portOid 否 String 网卡id，参数为空表示桌面绑定安全组，参数非空表示桌面网卡绑定安全组 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回安全组id sgdes9ihmdrpas8pdge4e4l 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopOid":"D0025042401321395", "securityGroupOid":"sgdes9ihmdrpas8pdge4e4l", "portOid":"portggpgxz5n5nhmro3fw34jg" }

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

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

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

接口功能介绍 虚机弹性IP绑定或者解绑v3 接口约束 无 URI POST /v3/fip/action 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 虚机ID fipOid 是 String 弹性IP ID action 是 String 操作类型,绑定：bind，解绑：unbind 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "desktopOid":"D0025042501321534", "fipOid":"fipuwk3p534tu2kti3uxt0cz", "action":"bind" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"jobtask5ketvt44tv75pjn0wwemc" }

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

接口功能介绍 VIP绑定弹性IPv3 接口约束 无 URI POST /v3/vip/bindFip 路径参数 无 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" } 状态码 请参考 状态码

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

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

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

接口功能介绍 查询apr支持的全部应用 接口约束 传参规范 URI GET /vfw/v2appqueryAll 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Array of Objects 接口返回结果 AppInfoEntity 表 AppInfoEntity 参数 参数类型 说明 示例 下级对象 id Long 自增id 1111 name String app名称 迅雷 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body 无 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj": [ { "id" :1, "name": "名称" } ] }

接口功能介绍 更新投递任务状态 接口约束 传参规范 URI POST /vfw/v2logupdatedeliverstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 id 是 Long 任务id deliverStatus 是 Integer 投递状态 0不投递 1投递 firewallId 是 String 防火墙id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "id": 162, "firewallId": "91e76b89efea420595fd859baf4eb2e4", "deliverStatus": false }

接口功能介绍 降配配额最低值 接口约束 传参规范 URI GET /vfw/v2minquota 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 MinQuotaVo 表 MinQuotaVo 参数 参数类型 说明 示例 下级对象 protectIpNum Integer 防护ip最小值 vpcQuota Integer vpc配额最小值 1 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!", "returnObj": [ "protectIpNum": 20, "vpcQuota": 3 } }