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

接口功能介绍 修改云电脑归属部门 接口约束 无 URI POST /v3/desktop/batch/modifyOrg 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOidList 是 Array of Strings 云电脑ID列表，可设置一个或多个，最多10个 D0023092001180339 orgOid 是 String 部门ID org4eq48g7mes4dvuh011j2o includeUser 否 Boolean 是否包括云电脑关联用户，默认为否 includeUser 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopOidList":["XXXXXXXXXXXXX6925"],"orgOid":"orghgh29f93c2anwk0332hxn","includeUser":null}

查看资产详情 在资产详情页面可以查看资产的基础信息，以及该资产上存在的风险。 1. 登录云安全中心控制台。 2. 在左侧导航栏，选择“资产中心 > 资产管理”，进入资产管理页面。 3. 在资产管理页面，单击资产操作列的“查看”，即可进入资产详情页面。 在“资产信息”页签，查看资产的基础信息。 资产信息展示基础信息的丰富程度和购买的安全产品相关。购买了服务器安全卫士（原生版）或者云等保专区的主机安全产品后，其基础信息会更加丰富。 切换到“脆弱性信息”页签，查看资产的脆弱性信息，包括告警数量、漏洞扫描结果、基线检测结果、账号检测结果。 资产导入 1. 选择需要导入的资产类型。 2. 在资产列表上方，单击“导入”。 3. 在弹出的“资产导入”窗口中，单击“资产导入模板下载”，下载导入模板。 4. 按照导入模板字段说明，完成模板填写。 5. 单击“选择文件”，上传模板文件。 6. 单击“导入”，完成导入。

接口功能介绍 获取多证书 接口约束 无 URI GET /v4/elb/listdomaincertlinks 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b listenerID 否 String 监听器 ID listenerxxxxx 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 检查结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 results Array of Objects 检查结果列表 test results 表 results 参数 参数类型 说明 示例 下级对象 certificateName String 多证书 id test certificateType String 类型类型: ca / certificate ca extDomainName String 扩展域名 domain createdTime String 创建时间 20221011T19:50:44Z domainCertID String 多证书 id dclxxxx

接口功能介绍 非对称密钥签名接口 接口约束 请保证账户余额大于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数据库元数据pgxckeyvalue的内容。 存储分布式集群中元数据键值对信息。 名称 类型 定义 dboid Oid 数据库的OID reloid Oid 分布表的OID keyvalue NameData 主分布键的特殊值 nodegroup Oid 热组的OID coldnodegroup Oid 冷组的OID

状态 描述信息 创建中 创建开发机的配置信息 已创建 开发机任务已提交 运行中 开发机已创建完成并正常运行，需等到“访问”按钮可点击后能远程访问 停止 开发机已停止，停止实例后未保存到持久化存储中的数据将丢失

库用户信息 说明 用户类型 可选择“带登录名的SQL用户”和“不带登录名的SQL用户”。不带登录名的SQL用户不能登录，但是可以被授予权限。 用户名 库用户的名称。 登录名 关联登录名。登录名登录后，登录名对此库的权限即为该用户具有的权限。 默认架构 指定服务器为此数据库用户解析对象名时搜索的第一个架构。 拥有的Schema 配置该用户拥有的架构列表。 成员身份 配置该用户具有的角色列表。一个用户具有某个角色，表示该用户具有此角色包含的所有权限。 安全对象 配置该用户对数据库对象的具体权限。

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

接口功能介绍 删除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 接口返回结果

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

对云电竞服务使用到的名词做解释。 串流 云电竞的串流处理是将云端服务器上运行的游戏画面传输至用户本地终端，并将本地终端的操作指令反馈到云端服务器上，实现低端设备畅玩海量游戏的效果。 云桌面 云桌面是替代传统电脑的一种新模式；采用云桌面后，用户无需再购买电脑主机，用户采用瘦终端（与电视机顶盒类似的设备）连接显示器和键鼠，用户安装客户端后通过特有的通信协议访问后端服务器上的云主机来实现交互式操作，达到与传统电脑一致的体验效果。 云电竞 云电竞指的是天翼云基于云桌面能力，向用户提供的无需高端硬件设施，也可让用户畅玩高配3A大作、热门网络游戏的功能服务。 瘦终端 瘦终端指小型行业专用商用PC，使用嵌入式处理器、小型本地闪存、轻量版操作系统来接入桌面，相较于传统 PC 来说，造价更低，部署更简。 边缘节点 边缘节点是相对于复杂网络结构提出的一个概念，指距离最终用户接入具有较少的中间环节的网络节点，对最终接入用户有较好的响应能力和连接速度。

本文将为您介绍如何为云硬盘创建备份与管理备份。 创建云硬盘备份 操作场景 在云硬盘控制台对已有的云硬盘进行备份。 操作步骤 1. 登录控制中心。 2. 单击控制中心左上角的，选择地域，此处我们选择华东1。 3. 单击“存储>云硬盘”，进入云硬盘主页面。 4. 在云硬盘页面，单击待创建备份的云硬盘所在行“操作>更多>创建云硬盘备份”, 进入“创建云硬盘备份”页面。 5. 选择合适的存储库和企业项目，您所操作的云硬盘会默认被勾选并展示在右侧。 如果有其他云硬盘需要备份，可以在云硬盘列表中勾选需要备份的云硬盘，勾选后点击右向箭头，将在已勾选云硬盘列表区域展示，如下图所示。对于已选磁盘操区域中不需要备份的磁盘，可以勾选后点击左向箭头进行删除。 6. 确认需备份云硬盘和存储库信息无误后，在下方“备份配置”模块中为已选择的云硬盘配置对应的备份方式：“自动备份”“立即备份”，确认配置后点击“下一步”。 自动备份：需要在“备份策略”的下拉菜单中，选择一个已有的备份策略，或者单击右侧的“创建策略”创建一个新的备份策略。在备份创建完成后，所选云硬盘会绑定到该备份策略中，按照备份策略进行周期性备份。注意：如果选择的云硬盘已经绑定到其他备份策略，在选择新的备份策略后，云硬盘会自动从原备份策略解绑，并绑定到新的备份策略。 立即备份：会对选择的云硬盘将立即进行一次备份。 同时选择两种备份方式，即立即执行一次备份，后续按照备份策略进行周期性备份。 7. 在云硬盘备份资源详情页面，确认配置无误后，点击“我已阅读并同意相关协议《云硬盘备份服务协议》”，点击“确认下单”；若配置信息有误，点击上一步进行修改。 8. 根据页面提示，返回“云硬盘备份控制台页面”，点击“备份副本”切换至备份副本列表。您可以手动刷新页面，查看备份创建状态。当云硬盘备份副本的“状态”变为“可用”时，表示备份创建成功。

接口功能介绍 无 接口约束 无 URI GET /cgw/v1/upstream/one 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 instId 是 String 实例Id id 是 String 服务内部id 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 7a2828074ef6e32e041a2ef124b19e63 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 接口状态码 2000 code String 错误码，异常时非空 CGW1001 returnObj Object 返回数据 UpstreamVO message String 异常描述 success 表 UpstreamVO 参数 参数类型 说明 示例 下级对象 balancerStrategy Object 服务负载均衡策略 BalancerStrategy certFileName String 证书文件名 certFileName certKeyFileName String 密钥证书文件名 certFileKeyName createTime String LocalDateTime创建时间 20231010 12:12:21 enableMtls Boolean 是否开启了双向认证 false enableWebsocket Boolean 是否开启了websocket支持 false groupName String 组名 default healthCheckConfig Object 健康检查配置 HealthCheckConfigVO id String ID 878da73f7dba36ff0ae80e004a4f28f9 label Object 标签map labelNames Array of Objects 标签名列表 LabelNameDTO name String 服务名称 test namespace String 命名空间 prod namespaceId String Nacos命名空间ID prod nodes Array of Objects 固定地址节点列表 VipServiceNodeDTO retry Object 重试配置 Retry serviceNameInRegistry String 注册中心服务名 demo serviceProtocol String 服务协议 http sourceType String 服务来源，VIP：固定地址；NACOS：nacos来源；KUBERNETES：云容器引擎来源 NACOS timeout Object 超时时间配置 Timeout type String 类型，取值：control或Ingress control typeDesc String 类型含义，取值：管控或Ingress 管控 updateTime String LocalDateTime更新时间 20231010 13:13:13 表 BalancerStrategy 参数 参数类型 说明 示例 下级对象 balancerType String 服务负载均衡策略，roundrobin、chash、ewma、leastconn，默认值为roundrobin roundrobin hashOn String 哈希位置，支持的类型有 vars（Nginx 内置变量），header（自定义 header），cookie，consumer，默认值为 vars vars key String key，负载均衡类型为chash时，必填。可配置项有：uri, servername, serveraddr, requesturi, remoteport, remoteaddr, queryString, host, hostname uri 表 HealthCheckConfigVO 参数 参数类型 说明 示例 下级对象 active Object 服务健康检查主动健康检查配置 ActiveHealthCheckDTO passive Object 服务健康检查被动健康检查配置 PassiveHealthCheckDTO 表 ActiveHealthCheckDTO 参数 参数类型 说明 示例 下级对象 concurrency Integer 主动检查时同时检查的目标数，默认值10 10 enable Boolean 是否开启，开启true，不开启false，默认不开启 false healthy Object 主动检查（健康节点）配置 ActiveHealthyDTO httpPath String 主动检查的 HTTP 请求路径，默认值"/" / httpsVerifyCertificate Boolean 主动检查使用 HTTPS 类型检查时，是否检查远程主机的SSL证书, 默认值true true port Integer 主动检查的 HTTP 请求主机端口（范围1~6553, 默认值 1 reqHeaders Array of Objects 主动检查使用 HTTP 或 HTTPS类型检查时，设置额外的请求头信息, 默认值[] String timeout Integer 主动检查的超时时间（单位：秒），默认值1 1 type String 主动检查的类型配置项：http、https、tcp，默认值http http unhealthy Object 主动检查（非健康节点）配置 ActiveUnhealthyDTO 表 ActiveHealthyDTO 参数 参数类型 说明 示例 下级对象 httpStatuses Array of Objects 主动检查（健康节点） HTTP 或 HTTPS 类型检查时，健康节点的HTTP状态码,校验范围200~599,默认值[200, 302] Integer interval Integer 主动检查（健康节点）检查的间隔时间（单位：秒），大于等于1，默认值1 1 successes Integer 主动检查（健康节点）确定节点健康的次数,校验范围1~254，默认值2 1 表 ActiveUnhealthyDTO 参数 参数类型 说明 示例 下级对象 httpFailures Integer 主动检查（非健康节点）HTTP 或 HTTPS 类型检查时，确定节点非健康的次数，校验范围1~254，默认值5 5 httpStatuses Array of Objects 主动检查（非健康节点） HTTP 或 HTTPS 类型检查时，非健康节点的HTTP状态码，校验范围200~599，默认值[429, 404, 500, 501, 502, 503, 504, 505] Integer interval Integer 主动检查（非健康节点）检查的间隔时间（单位：秒），大于等于1，默认值1 1 tcpFailures Integer 主动检查（非健康节点）TCP 类型检查时，确定节点非健康的次数，校验范围1~254，默认值2 2 timeouts Integer 主动检查（非健康节点）确定节点非健康的超时次数，校验范围1~254，默认值3 3 表 PassiveHealthCheckDTO 参数 参数类型 说明 示例 下级对象 enable Boolean 是否开启，开启true，不开启false，默认不开启 false healthy Object 被动检查（健康节点）配置 PassiveHealthyDTO unhealthy Object 被动检查（非健康节点）配置 PassiveUnhealthyDTO 表 PassiveHealthyDTO 参数 参数类型 说明 示例 下级对象 httpStatuses Array of Objects 被动检查（健康节点） HTTP 或 HTTPS 类型检查时，健康节点的HTTP状态码，校验范围200~599，默认值[200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308] Integer successes Integer 被动检查（健康节点）确定节点健康的次数，校验范围0~254，默认值5 5 type String 被动检查的类型配置项：http、https、tcp，默认值http http 表 PassiveUnhealthyDTO 参数 参数类型 说明 示例 下级对象 httpFailures Integer 被动检查（非健康节点）HTTP 或 HTTPS 类型检查时，确定节点非健康的次数，校验范围0~254，默认值5 5 httpStatuses Array of Objects 被动检查（非健康节点） HTTP 或 HTTPS 类型检查时，非健康节点的HTTP状态码，校验范围200~599，默认值[429, 500, 503] Integer tcpFailures Integer 被动检查（非健康节点）TCP 类型检查时，确定节点非健康的次数，校验范围0~254，默认值2 2 timeouts Integer 被动检查（非健康节点）确定节点非健康的超时次数，校验范围0~254，默认值7 7 表 LabelNameDTO 参数 参数类型 说明 示例 下级对象 labelName String 标签名原始值。用于传参，和tips展示 version labelNameVO String 标签名别名，用于web展示 versionvo 表 Retry 参数 参数类型 说明 示例 下级对象 retries Integer 重试次数 3 retryTimeout Float 重试超时时间 6 表 Timeout 参数 参数类型 说明 示例 下级对象 connect Float 连接超时(s) 10 read Float 读取超时(s) 60 send Float 发送超时(s) 60 表 VipServiceNodeDTO 参数 参数类型 说明 示例 下级对象 host String 节点ip 127.0.0.1 port Integer 节点端口 8080 priority Integer 节点优先级配置，只有在高优先级的节点不可用或者尝试过，才会访问一个低优先级的节点。默认值为0，可以设置为负数，让其作为备份节点 1 weight Integer 节点权重 1

本页面介绍云数据库ClickHouse实例管理方面的常见问题。 云数据库ClickHouse实例开通后的管理类常见问题总结： 实例开通后能否扩容? 是的,云数据库ClickHouse实例开通后支持以下三种扩容方式: 存储空间扩容 用户可以在选择相应实例,进入“扩容”页面提交扩容申请。系统会在后台扩充数据盘,实现用户数据存储能力的扩展。 计算节点CPU/内存升级 用户可以选择将实例进行升级，将内存容量升级大一倍等。系统会在后台对选定计算节点进行硬件资源的扩充升级。 增加计算节点数量 当数据量或并发访问压力增大时，用户可以通过在添加更多计算节点的方式来扩充整体处理能力。系统会自动完成新节点的部署与旧数据同步。 以上三种扩容均需在控制台上提交申请,系统后台会根据申请内容完成自动化处理，存储和计算资源的扩充能有效满足业务规模的扩张。 实例扩容对运行中实例的影响有哪些? 存储空间扩容过程中: 数据访问速度会短期下降,读写性能受到一定影响。 计算节点CPU/内存升级过程中: 相关节点会进入升级流程，此期间读写操作会失败。 增加计算节点过程中： 不对现有数据进行迁移，故影响最小，线上业务无感知，仅同步数据库中已有结构及元数据到新节点。 计算资源不足时,应该选择哪种扩容方式? 当实例计算资源(如CPU、内存)不足导致查询性能下降时,可以考虑以下扩容方式: 对已有计算节点进行升级：仅影响该节点短暂下线,对其他节点和业务整体影响小，扩充节点计算能力,提升实例整体处理性能，成本相对较低,是第一选择。 增加计算节点数量：新节点随即上线,不影响线上业务，性能上升程度受新节点规格限制，成本随增加节点数成比例增长。 所以,计算资源不足时,优先考虑对现有节点进行升级,其次增量增加计算节点数量。两种方式结合还可获得最大利益。