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

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

接口功能介绍 给子账号分配角色 接口约束 无 URI POST /v3/user/role 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 userOid 是 String 子账号ID upgxxxxxxxxxxxxxxxxxxxx sysRoleCode 是 Array of Strings 角色标识列表 ["liut555"] orgOid 是 String 部门ID orgtest 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "userOid":"upgxxxxxxxxxxxxxxxxxxxx", "sysRoleCode":["test555"], "orgOid":"orgtest" } 响应示例 { "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 } }

接口功能介绍 能否订购防火墙 接口约束 传参规范 URI GET /vfw/v2canbugfirewall 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 CanDowngradeVo 表 CanDowngradeVo 参数 参数类型 说明 示例 下级对象 result Boolean 能否订购 error String 原因 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!", "returnObj": { "result": false, "error": "已有防火墙无需重复开通" } }

接口功能介绍 修改SNAT规则v3 接口约束 无 URI POST /v3/snat/modify 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 natOid 是 String NAT网关ID snatOid 是 String SNAT规则ID fipOidList 是 Array of Strings 弹性IP ID列表 description 是 String SNAT规则描述（不能超过250个字符"） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "natOid":"xxxxxxxxx", "snatOid":"xxxxxxxxx", "fipOidList":["xxxxxxxxx"], "description":"SNAT规则示例描述" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } }

接口功能介绍 证书公钥验签，signatureValid为验证结果，message仅为接口是否调用成功结果 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePublicKeyVerify 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 解密算法，取值范围为RSAPSSSHA256、SM2 RSAPSSSHA256 message 是 String 待签名数据 abcd messageType 是 String 数据类型 RAW signatureValue 是 String 签名值 ZOyIygCyaOW6GjMlNKiuyjfzw 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 200 error String 错误码 KMS0514 message String 调用结果信息 签名验证成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff signatureValid String 验证结果 true requestId String 请求id 2a56124813ed4ef7a359e818dce118d8

接口功能介绍 证书公钥验签，signatureValid为验证结果，message仅为接口是否调用成功结果 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePublicKeyVerify 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 解密算法，取值范围为RSAPSSSHA256、SM2 RSAPSSSHA256 message 是 String 待签名数据 abcd messageType 是 String 数据类型 RAW signatureValue 是 String 签名值 ZOyIygCyaOW6GjMlNKiuyjfzw 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 200 error String 错误码 KMS0514 message String 调用结果信息 签名验证成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff signatureValid String 验证结果 true requestId String 请求id 2a56124813ed4ef7a359e818dce118d8

接口功能介绍 获取证书 接口约束 无 URI POST /v1/manageCertificate/getCertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取证书成功 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificate String 证书本体 BEGIN CERTIFICATE (X.509 Certificate PEM Content) END CERTIFICATE requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 certificateChain String 证书链 BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Root CA Certificate PEM Content) END CERTIFICATE certificateId String 证书id 474e569e8814474a948bdbcf6d853eff csr String 证书csr BEGIN CERTIFICATE REQUESTMIICxjCCAa4CAQAwPzELMAkGA1UEBhMCQ04xDzANBgNVBAoTBmFsaXl1bjEMMAoGA1UECxMDa21zMREwDwYEND CERTIFICATE REQUEST

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

接口功能介绍 调用此接口可禁用站点监控任务。 接口约束 资源池ID，站点监控任务ID列表不能为空，且站点监控任务ID列表里面的任务ID在查询时status为true。 URI POST /v4/monitor/disablesitemonitor 请求参数 请求体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/disablesitemonitor 请求体body json { "regionID":"81f7728662dd11ec810800155d307d5b", "siteID":["64ea16644347558e9bc6651341c2fa15"] }

任务中心 数据导出任务：删除 接口功能介绍 调用此接口可删除数据导出任务。 接口约束 资源池ID、任务ID不为空。 URI POST /v4/monitor/taskcenter/deletetask 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b taskID 是 Array of Strings 任务ID列表 ['TASKtacd8b6b4610b97d202306301808'] 响应参数 参数 参数类型 说明 示例 下级对象 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/taskcenter/deletetask 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "taskID": ["TASKtacd8b6b4610b97d202306301808"] }

告警模板 告警模板：复制 接口功能介绍 调用此接口可复制告警模板。 接口约束 告警模板ID不能为空。 URI POST /v4/monitor/copyalarmtemplate 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b templateID 是 String 告警模板ID 312b56b43e4311ed8ef2005056898fe0 name 是 String 告警模板名称 xsZSu desc 否 String 告警模板描述 test 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 templateID String 告警模板ID 312b56b43e4311ed8ef2005056898fe0

本节主要介绍凭证管理 凭证管理可添加公有云、私有云、主机、数据库、REDIS、ElasticSearch的认证方式。其中公有云采用AK/SK、密码方式认证，私有云、主机、数据库、REDIS采用用户名/密码方式认证 。 操作步骤 步骤 1 在浏览器中输入 单击左侧导航栏的“ 配置管理 ”，进入配置管理 界面。在“ 凭证管理 ”页签，单击“ 添加 ”。 添加凭证 在“ 输入凭证 ”页面，按照页面提示，选择认证方式并输入相应凭证，如图所示，单击“ 下一步 ”。 若不需要关联对象，可单击“ 保存退出 ”。 输入凭证 在“ 关联对象 ”页面，选择可关联的对象，单击“ 下一步 ”。 关联对象 在“ 确认添加 ”页面，确认添加的凭证与关联的资源，单击“ 确认 ”。 添加完成后，在凭证列表页可以看到添加的凭证。 确认凭证

本页介绍天翼云TeleDB数据库元数据pgclslabel的内容。 存储行列级安全访问策略的标签信息。 名称 类型 定义 polid int16 策略ID labelid int16 标签ID levelid int16 层级ID compartmentid int16[1] 组别ID 数组（长度为 1） groupid int16[1] 组ID 数组（长度为 1）