站点监控 站点监控任务：删除 接口功能介绍 调用此接口可删除站点监控任务。 接口约束 站点监控任务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"] }

本文主要介绍DRDS控制台统计分析中的分片合理性分析功能。 操作步骤 1. 在天翼云官网首页的顶部菜单栏，选择【产品 > 数据库 > 关系型数据库 > 分布式关系型数据库】，进入分布式关系型数据库产品页面。然后单击【管理控制台】，进入【概览】页面。 2. 在左侧导航栏，选择【DRDS > 统计分析】，进入SQL执行分析页面。然后在顶部菜单栏，选择区域和项目。 3. 单击导航栏的【分片合理性分析】，进入到分片合理性分析页面。 4. 在页面右上角选择【实例】下拉框（部分资源池位于左上角），可以选择需查看的目标实例。【schema】下拉框可以选择目标schema，并可对目标表名进行模糊查询。 5. 在分片合理性分析页面，可以查看目标实例在目标时间段内分片数据量合理性分析和分片访问量合理性分析，通过分析DRDS实例对应MySQL的存储情况和访问情况，提示用户分片策略是否合理，是否存在存储热点或访问热点。

接口功能介绍 删除证书 接口约束 无 URI POST /v1/manageCertificate/deleteCertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 证书删除成功 returnObj String 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 7a41626f0e604cef9776eb19fc8ec7f5 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "certificateId": "e961bd8237ee4c1fa9965cf37b4fbd01" }

接口功能介绍 导入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 无

参数 参数类型 说明 示例 下级对象 taskID String 巡检任务ID acd8b6b4610b97d202306301808 totalCount Integer 获取对象数据条数 2 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 inspectionResultList Array of Objects 巡检结果列表 inspectionResultObj

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 100000 message String 结果简述 正确返回 returnObj Object 返回对象 returnObj error String 错误码 CDN200002 errorMessage String 错误详情 请求参数校验失败，XXX

接口功能介绍 查询租户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

机房管理员没有超级管理权限，Ukey是Dedicated HSM提供给您的身份识别卡，此卡仅创建专属加密实例的用户持有。 敏感数据（密钥）存储在硬件加密卡中，即使加密机制造商也无法读取内部密钥信息。

接口功能介绍 关联带宽及其绑定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 {}

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

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

接口功能介绍 创建SNAT规则v3 接口约束 无 URI POST /v3/snat/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 natOid 是 String NAT网关ID fipOidList 是 Array of Strings 弹性IP ID列表 type 是 String SNAT规则类型（SUBNET子网; CIDR自定义网段） subnetOid 否 String 子网ID，只能在未设置SNAT规则的子网下创建SNAT规则，typeSUBNET时必传 cidr 否 String 网段，typeCIDR时必传 XXX.XXX.XXX.XXX/XX description 是 String SNAT规则描述（不能超过250个字符"） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj

接口功能介绍 删除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":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 创建DNAT规则v3 接口约束 无 URI POST /v3/dnat/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 natOid 是 String NAT网关ID fipOid 是 String 弹性IP ID privateIpAddress 是 String 私网IP portType 是 String 端口类型（SPECIAL具体端口; ALL全部端口） externalPort 否 String 公网端口，portTypeSPECIAL时必传 internalPort 否 String 私网端口，portTypeSPECIAL时必传 protocol 否 String 支持协议（TCPTCP协议;UDPUDP协议），portTypeSPECIAL时必传 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj

接口功能介绍 修改云电脑计算机名 接口约束 无 URI POST /v3/desktop/modifyComputerName 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023092601181391 computerName 是 String 计算机名（计算机名称只能由数字、大小写字母以及中划线组成；最大长度15个字符） testxx123 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOid":"D0023092601181391","computerName":"testxx123"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码