接口功能介绍 证书私钥解密 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePrivateKeyDecrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 解密算法，取值范围为RSAESOAEPSHA256、RSAESOAEPSHA1、RSAESPKCS1V15、SM2 RSAESOAEPSHA1 ciphertextBlob 是 String ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 解密密文 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 解密成功 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff plaintext String 解密后明文 csedLEchgF5ijFx9nEc5Y0DpzWb

接口功能介绍 证书公钥加密 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePublicKeyEncrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 使用的算法，取值范围为RSAESOAEPSHA256、RSAESOAEPSHA1、RSAESPKCS1V15、SM2 RSAESOAEPSHA1 plaintext 是 String 待加密明文 abc 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 加密成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff ciphertextBlob String 加密后密文 ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi requestId String 请求id 2a56124813ed4ef7a359e818dce118d8

接口功能介绍 密钥版本详情查询 接口约束 请保证账户余额大于0 URI POST /v1/versionControl/describeKeyVersion 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取密钥版本成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 creationDate String 版本创建时间 Tue Oct 25 15:06:52 CST 2022 requestId String 请求id 87d821f6679544eda3553b6e9dbc2e4c

响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态码（2000成功，5000系统错误,18xxxx业务错误） 2000 error String 业务错误码，RCCstatusCode RCC1000 message String 返回结果描述 SUCCESS returnObj Object 返回数据体 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 subOrderPrices Array of Objects 子项目价格 subOrderPrices 表 subOrderPrices 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 serviceTag String 标记 PAAS finalPrice Double 最终价格 4.509 orderItemPrices Array of Objects 价格细分 orderItemPrices 表 orderItemPrices 参数 参数类型 说明 示例 下级对象 itemId Double 项目id bb9081d2c88511edae4d34800d471146 totalPrice Double 总价 4.505 finalPrice Double 最终价格 4.505 resourceType String 资源类型 PAASRCC 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "clusterName": "mycluster", "engineType": "nacos", "cycleType": "101", "cycleCnt": "1", "autoRenewStatus": "true", "autoRenewCycleType": "3", "autoRenewCycleCount": "1", "resSize": 3, "cpuNum": 4, "memSize": 8, "securityGroupUuid": "59893", "vpcUuid": "16623", "subnetUuid": "25024", "azInfo":[{"azId":3,"azName":"az3"}] }

客户端限速修改。 接口功能介绍 客户端限速修改 接口约束 支持集群模式资源池。 URI POST /v4/vpn/sslclientqos/update 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 sslClientID 是 String SSL客户端ID sslclientf6ee upBandwidth 是 Integer 上行带宽,单位为Kbps或Mbps 10 downBandwidth 是 Integer 下行带宽,单位为Kbps或Mbps 10 isLimitSpeed 否 Boolean 是否限速 取值范围: false:不限速 true:限速 false 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 616797965481

响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态码（2000成功，5000系统错误,18xxxx业务错误） 2000 error String 业务错误码，RCCstatusCode RCC1000 message String 返回结果描述 SUCCESS returnObj Object 返回数据体 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 subOrderPrices Array of Objects 子项目价格 subOrderPrices 表 subOrderPrices 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 serviceTag String 标记 PAAS finalPrice Double 最终价格 4.509 orderItemPrices Array of Objects 价格细分 orderItemPrices 表 orderItemPrices 参数 参数类型 说明 示例 下级对象 itemId Double 项目id bb9081d2c88511edae4d34800d471146 totalPrice Double 总价 4.505 finalPrice Double 最终价格 4.505 resourceType String 资源类型 PAASRCC 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "clusterName": "mycluster", "engineType": "nacos", "cycleType": "101", "cycleCnt": "1", "autoRenewStatus": "true", "autoRenewCycleType": "3", "autoRenewCycleCount": "1", "resSize": 3, "cpuNum": 4, "memSize": 8, "securityGroupUuid": "59893", "vpcUuid": "16623", "subnetUuid": "25024", "azInfo":[{"azId":3,"azName":"az3"}] }

接口功能介绍 调用此接口可获取下载链接地址。 接口约束 参见请求参数说明。 URI POST /v4/monitor/taskcenter/download 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b taskID 是 String 任务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 参数 参数类型 说明 示例 下级对象 downloadUrl String 下载链接地址 枚举参数 无 请求示例 请求url /v4/monitor/taskcenter/download 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "taskID": "TASKtacd8b6b4610b97d202306301808" }

接口功能介绍 一个监控视图包含一个或多个监控项，监控项为keyvalue格式。 校验指定监控视图中的监控项 Key 是否存在。 接口约束 regionID（资源池）、templateID（监控面板）、viewID（监控视图）存在。 URI GET /v4/monitor/checkmonitoritem 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID viewID String 是 4cb790ae489411edb386005056897257 监控视图ID itemKey String 是 key1 监控项Key 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 exist Boolean 是否存在给定监控项Key true

接口功能介绍 检查是否存在给定名称的监控面板。 这里的名称，是指监控面板自身的名称。 接口约束 regionID（资源池）存在。 URI GET /v4/monitor/checkmonitorname 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID name String 是 templatenameexisttest 要检查的监控面板名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 exist Boolean 是否存在给定名称的监控面板 true 请求示例 GET /v4/monitor/checkmonitorname?regionID81f7728662dd11ec810800155d307d5b&nametemplatenameexisttest 响应示例 json { "statusCode": 800, "returnObj": { "exist": true }, "errorCode": "", "message": "Success", "msgDesc": "成功" }

告警模板 告警模板：批量删除 接口功能介绍 调用此接口可批量删除告警模板。 接口约束 告警模板ID列表不能为空。 URI POST /v4/monitor/deletealarmtemplates 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b templateIDList 是 Array of Strings 告警模板ID列表 ['312b56b43e4311ed8ef2005056898fe0','318cc4a83e4311ed8ef2005056898fe0'] 响应参数 参数 参数类型 说明 示例 下级对象 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

监控看板 监控看板：重命名 接口功能介绍 重命名监控看板。 接口约束 参见请求参数说明。 URI POST /v4/monitor/monitorboard/rename 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b boardID 是 String 监控看板ID 58631437d4897105d9ac9bc044d7b6ab name 是 String 新监控面板名称，不可重复 newname 响应参数 参数 参数类型 说明 示例 下级对象 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

接口功能介绍 查询CSR列表信息及CSR详细信息。 接口约束 无 URI POST /v1/csr/list 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNum 是 Integer 页码 1 pageSize 是 Integer 每页数量 10 keyword 否 String 域名关键字搜索 test.cn encryptionAlgorithm 否 String 加密算法。取值范围：RSA、ECC、SM2 RSA 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 200 message String 提示信息 Success error String 仅错误时返回 CCMS100000063 returnObj Object 分页 Page 表 Page 参数 参数类型 说明 示例 下级对象 totalSize Integer 数据总量 100 list Object 数据记录 CsrListResult 表 CsrListResult 参数 参数类型 说明 示例 下级对象 id String uuid 6ee1160088ef44ec80213d1a448b2d8e name String csr6b9cea crs名称 domainName String ctyun.cn 域名 privateKeyIsEmpty Boolean 私钥是否为空 false encryptionAlgorithm String 加密算法 SM2 generateMethod String CSR生成方式 MANUAL createTime String 创建时间 20240513T09:19:01Z

接口功能介绍 禁用租户ak 接口约束 无 URI POST /v1/userAkControl/disableUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 userAk 是 String 租户ak 02baad12e63c471c85400df031e18520 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d 枚举参数 无 请求示例 请求url 请求头header { "regionId": "200000001852" } 请求体body { "userAk": "94c3a9db47d16cb00e144834eb7d4719" }

函数名称 语法 说明 jsoncontains jsoncontains(x, y) 测试一个JSON串是否包含某个特定值。 jsonarraylength jsonarraylength(x) 计算JSON数组中元素的数量。 jsonextract jsonextract(x, path) 从JSON对象或JSON数组中提取一组JSON值（数组或对象）。同jsonvalue函数。 jsontype jsontype(x) 返回JSON串类型，如果指定字段，则返回JSON串中指定字段类型。 jsonvalue jsonextract(x, path) 从JSON对象或JSON数组中提取一组标量值（字符串、整数或布尔值）。同jsonextract函数。 jsonlength jsonlength(x) 返回指定JSON对象或JSON数组的长度。 jsonvalid jsonvalid(x) 判断指定字符串是否为有效JSON。

函数名称 语法 说明 jsoncontains jsoncontains(x, y) 测试一个JSON串是否包含某个特定值。 jsonarraylength jsonarraylength(x) 计算JSON数组中元素的数量。 jsonextract jsonextract(x, path) 从JSON对象或JSON数组中提取一组JSON值（数组或对象）。同jsonvalue函数。 jsontype jsontype(x) 返回JSON串类型，如果指定字段，则返回JSON串中指定字段类型。 jsonvalue jsonextract(x, path) 从JSON对象或JSON数组中提取一组标量值（字符串、整数或布尔值）。同jsonextract函数。 jsonlength jsonlength(x) 返回指定JSON对象或JSON数组的长度。 jsonvalid jsonvalid(x) 判断指定字符串是否为有效JSON。

接口功能介绍 查看VPC信息 接口约束 无 URI GET /v3/api/getVpcInfo 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 445d30ce3d5d40a2a79dc444a8c83859 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 华东1 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 message String 错误信息 statusCode String 800成功 其他失败 error String 错误码 returnObj Object returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 vpcId String VPC的ID subnetId String 子网ID 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body 无 响应示例 { "statusCode": "800", "returnObj": { "vpcId": "vpcdfklkmkdfj", "subnetId": "subnet12345678" } }

本文主要介绍如何配置CloudInit工具 操作场景 CloudInit工具安装完成后，请参考本节操作配置CloudInit工具。 前提条件 已安装CloudInit工具。 已为云主机绑定弹性公网IP。 已登录云主机。 云主机的网卡属性为DHCP方式。 配置步骤说明 包含如下两步操作： 1.配置CloudInit工具。 具体操作请参考配置CloudInit工具。 2.检查CloudInit工具相关配置是否成功。 具体操作请参考检查CloudInit工具相关配置是否成功。 配置CloudInit工具 1.用户可以根据需要根据用户类型配置登录云主机的用户权限。使用root账户登录，需要开启root用户的ssh权限，并开启密码远程登录。 −若用户选择注入密码，则通过自己注入的密码进行远程SSH或noVNC登录。 −若用户选择注入密钥，则通过自己注入的密钥进行远程SSH登录。 2.设置开放root密码远程登录并开启root用户的ssh权限。 以CentOS 6.7系列操作系统为例，在“/etc/cloud/cloud.cfg”设置“disableroot”值为“0”表示不禁用（部分OS的CloudInit配置使用“true”表示禁用，“false”表示不禁用），设置“sshpwauth”为“1”启用密码远程登录，“lockpasswd”设置为“False”表示不锁住用户密码。 users: name: root lockpasswd: False disableroot: 0 sshpwauth: 1 3.在配置文件“/etc/cloud/cloud.cfg”中禁用CloudInit接管网络。 当CloudInit版本等于或高于0.7.9版本时，在配置文件“/etc/cloud/cloud.cfg”中增加如下内容，禁用CloudInit接管网络。 说明： 增加的内容需严格按照yaml格式进行配置。 图 禁用CloudInit接管网络 4.配置agent访问OpenStack数据源。 在“/etc/cloud/cloud.cfg”最后一行添加如下内容，配置agent访问OpenStack数据源。 datasourcelist: [ OpenStack ] datasource: OpenStack: metadataurls: [' maxwait: 120 timeout: 5 applynetworkconfig: false 说明： maxwait和timeout可由用户自定义是否需要配置，上述回显信息中maxwait和timeout的取值仅供参考。 当操作系统版本低于Debian8、CentOS 5时，不支持配置agent访问OpenStack数据源。 CentOS、EulerOS操作系统云主机必须要禁用默认的zeroconf路由，以便精确访问OpenStack数据源。 echo "NOZEROCONFyes" >> /etc/sysconfig/network applynetworkconfig: false为可选项，对于使用CloudInit 18.3及以上版本的用户，需添加此配置项。 5.在配置文件“/etc/cloud/cloud.cfg”中补充如下内容。 manageetchosts: localhost 防止启动云主机时，系统长时间卡在“Waiting for cloudResetPwdAgent”状态。 图 新增manageetchosts: localhost 6.执行vi /etc/ssh/sshdconfig命令，在vi编辑器中打开“/etc/ssh/sshdconfig”。 将“sshdconfig”中的“PasswordAuthentication”的值修改为“yes”。 说明： 如果是SUSE和openSUSE操作系统，需要同时配置“sshdconfig”文件中的以下两个参数为“yes”。 PasswordAuthentication ChallengeResponseAuthentication 7.修改配置文件“cloudinitmodules”。 将ssh从最后提前到第一位处理，提高云主机ssh登录速度。 开启机器名更新机制，请勿注释或删除“ updatehostname”语句。 cloudinitmodules: ssh migrator bootcmd writefiles growpart resizefs sethostname updatehostname updateetchosts rsyslog usersgroups 8.修改以下配置使得镜像创建的云主机主机名不带“.novalocal”后缀且主机名称中可以带点号。 a.执行如下命令，修改“init.py”文件。 vi /usr/lib/python./sitepackages/cloudinit/sources/init.py 不同OS安装的python版本有差异，请选择对应的路径。 按“i”进入编辑模式，根据关键字toks查询，修改内容如下信息所示。 if toks: toks str(toks).split('.') else:

本章节介绍故障演练服务中应用配置管理功能。 概述 应用 是故障演练服务 中一组资源的逻辑聚合，是进行演练管理的核心对象。 创建应用 1. 登录应用高可用服务控制台。 2. 在左侧导航栏中，选择 故障演练 > 应用列表 ，进入应用列表页面。 3. 单击页面中的创建应用按钮。 4. 根据页面提示，填写应用名称 和描述 ，并选择其所属的环境。 5. 填写完毕后，单击确定按钮完成创建。 6. 返回应用列表，可以看到新创建的应用对象。 修改应用 1. 进入应用列表页面。 2. 在应用列表 中找到需要修改的应用对象，单击其操作列的 更多 > 编辑。 3. 在弹出的对话框中，根据需要修改应用名称 或描述 ，然后单击确定按钮完成修改。 4. 返回应用列表，可以看到应用信息已更新。 删除应用 1. 进入应用列表页面。 2. 在应用列表 中找到需要删除的应用对象，单击其操作列的 更多 > 删除。 3. 在弹出的确认对话框中，按提示完成删除操作。 4. 返回应用列表，确认该应用对象已被成功移除。 注意 若该应用下有正在执行的演练任务，则无法直接删除，必须先结束所有相关演练，才能执行删除操作。 若该应用被其他应用的演练任务关联，也无法直接删除，需要先解除关联演练任务对本应用的引用，然后再进行删除操作。

接口功能介绍 设置带宽VPC 接口约束 无 URI POST /v3/bandwidth/setVpc 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 bandwidthOid 是 String 带宽ID bwsya8ts02mjfxfxf2i000t vpcOid 是 String VPC ID vpchlhmzjrk74jg85kg3trh6 subnetOidList 是 Array of Strings 子网ID列表，长度至少为1 snepz4b7l2fdeirbgetbdlg 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"bandwidthOid":"bwfoo","vpcOid":"vpcxxx","subnetOidList":["snxx"]}

接口功能介绍 编辑池化桌面池策略 接口约束 无 URI POST /v3/commonDesktopPool/editPolicy 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 池化桌面池ID dpucod37vk0gca50kur44j4 keepDuration 否 Integer 用户断开连接后，云电脑的保留时长（单位：分钟），至少是3 33 afterReleaseAction 否 String 云电脑释放后操作（rebuild还原;stop关机） null rebuildAfterStopOrReboot 否 String 关机/重启后还原系统（on开启;off关闭） null 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无

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

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

接口功能介绍 删除部门 接口约束 无 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}

接口功能介绍 查询vpc列表 接口约束 无 URI POST /v1/applicationAccessPointManage/listVpc 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 epId 是 String 企业项目id 1 regionToCheck 否 String regionId cnhangzhou 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Objects vpc列表 vpcList 表 vpcList 参数 参数类型 说明 示例 下级对象 vpcID String vpc id vpcw6sty9v8rr name String 名称 vpc314bldy2 cidr String 子网 172.16.0.0/16 ipv6Enabled Boolean 是否开启ipv6 true isBuy Boolean vpc参数 true ipv6CIDRS Array of Strings ipv6子网列表 ["100:1:1f2:7200::/56"] vpcIp String vpc ip 192.168.1.3 subnetIDs Array of Strings 子网id列表 ["subnet7jibndv577","subnetqc90zmk12u"] natGatewayIDs Array of Strings 网关id列表 ["192.168.0.0"]

接口功能介绍 用户可以自行推送的告警事件，非系统自动产生，可以在告警历史中查询到。 接口约束 triggerID（监控平台告警规则ID）、issueID（告警事件ID）存在，status（状态）、clock（告警事件触发时间）满足取值范围，具体范围见请求参数说明。 URI POST /v4/monitor/pushalertissue 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 issueList Array of Objects 是 告警事件列表 issue 表issue 参数 参数类型 是否必填 示例 说明 下级对象 status Integer 是 1 本参数表示状态。取值范围：0：正常。1：告警。根据以上范围取值。 clock Integer 是 告警事件触发时间 1666147320 triggerID String 是 监控平台告警规则ID 63411d5f39fa5e7ce08eac73 issueID String 是 告警事件ID 62368ada39fa5e2ea0cfe901 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否推送成功 true

站点监控 探测节点：查看详情 接口功能介绍 调用此接口可统计探测点在站点任务下异常详情。 接口约束 站点任务ID不能为空。 URI GET /v4/monitor/describeprobepoint 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 taskID 是 String 站点任务ID 64ea16644347558e9bc6651341c2fa15 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 统计结果列表 resultObj 表 resultObj 参数 参数类型 说明 示例 下级对象 pointID String 探测节点ID 1 data Array of Objects 探测点异常统计信息 dataObj 表 dataObj 参数 参数类型 说明 示例 下级对象 value Integer 事件统计数量 5 samplingTime Integer 事件统计采样时间,秒级 1667815639

事件监控 事件监控：查询事件 接口功能介绍 获取资源池下指定维度下的事件。 接口约束 regionID（资源池）、service（服务）、dimension（维度）存在。 URI GET /v4/monitor/events/queryevents 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b service 是 String 服务，见事件监控：查询服务维度接口返回。 ecs dimension 是 String 维度，见事件监控：查询服务维度接口返回。 ecs 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 events Array of Objects 事件列表 eventObj 表 eventObj 参数 参数类型 说明 示例 下级对象 eventName String 事件指标 migrationeventstart description String 事件中文描述 云主机迁移发生

本页介绍天翼云TeleDB数据库系统视图pgauditobjconfdetail的内容。 视图的作用：提供了关于数据库对象审计配置的详细信息。 名称 类型 定义 auditor name 创建或所有审计配置的用户的名称，通过pgcatalog.pggetuserbyid函数根据S.auditorid获取。 objectclass name 被审计对象的类别名称。 objectdesc text 被审计对象的描述，使用pgcatalog.pgdescribeobject函数生成。这个函数接受三个参数：classid、objectid和objectsubid，它们共同唯一确定一个数据库对象，并返回该对象的描述性信息。 actionname text 与审计配置相关联的审计动作的名称，通过pgcatalog.pggetauditactionname函数根据S.actionid获取。 actionmode text 审计动作的模式或类型，描述了在什么情况下触发审计动作。 actionison boolean 表示审计动作是否启用的状态。如果审计动作启用，这个字段将返回一个表示真值的指示（可能是true、1或其他表示启用的值）。

接口功能介绍 查询vpc列表 接口约束 无 URI POST /v1/applicationAccessPointManage/listVpc 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 epId 是 String 企业项目id 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Objects vpc列表 vpcList 表 vpcList 参数 参数类型 说明 示例 下级对象 vpcID String vpc id vpcw6sty9v8rr name String 名称 vpc314bldy2 description String 描述 test CIDR String 子网 172.16.0.0/16 ipv6Enabled Boolean 是否开启ipv6 true isBuy Boolean vpc参数 true ipv6CIDRS Array of Strings ipv6子网列表 ["100:1:1f2:7200::/56"] vpcIp String vpc ip 192.168.1.3 subnetIDs Array of Strings 子网id列表 ["subnet7jibndv577","subnetqc90zmk12u"] natGatewayIDs Array of Strings 网关id列表 ["192.168.0.0"]

本章节主要介绍如何查看健康检查任务。 操作场景 管理员可以在健康检查的管理中心查看所有健康检查任务，便于在修改某些配置之后的场景对比修改前后是否对集群产生影响。 操作步骤 1. 登录FusionInsight Manager。 2. 选择“运维 > 健康检查”。 默认显示所有已保存的检查报告，以列表形式展示，包含如下所示的信息： 健康检查报告记录 项目 说明 检查对象 表示被检查的对象，可打开下拉菜单查看详情。 状态 表示检查的结果状态，包含未发现问题、发现问题和检查中。 检查类型 表示执行检查的主体，包含“系统”、“集群”、“主机”、“服务”和“OMS”五个检查维度。集群维度默认包含所有检查。 启动方式 表示此次检查的属性，是否自动触发或手动执行。 开始时间 表示此次检查的开始时间。 结束时间 表示此次检查的结束时间。 操作 支持“导出报告”和“查看帮助”。 说明 在检查记录列表右上方，可以筛选指定的检查对象和结果状态。 如果检查类型为集群时，“查看帮助”在“检查对象”的下拉菜单中。 系统执行健康检查时，涉及检查对象的监控指标数据时，并非以当前实时的监控数据进行判断，而是收集近期的历史数据，因此存在时间延迟。

本章介绍如何删除云硬盘快照。 操作场景 主机迁移服务，在迁移任务复制/同步/克隆过程中，会对目的端云硬盘生成相应的快照。删除迁移任务后，任务对应的快照也会删除。若目的端使用了专属分布式存储服务 DSS的云盘，SMS生成的快照会占用DSS存储池容量，占用容量等于实际数据存储容量。您可以参考本章节，按需求删除云硬盘快照。 快照类型包括： 割接快照：迁移完成后，会对目的端磁盘制作割接快照，用于后续业务出现问题可以回滚。建议业务割接稳定后再删除此快照。 同步快照：Windows迁移和Linux块迁移，数据迁移并同步完成后，修改目的端服务器配置前会制作同步快照，以确保下次同步和源端数据一致。删除此快照将无法再次进行同步，请谨慎操作。 克隆快照：Windows、Linux克隆目的端时会制作克隆快照，用于克隆服务器以及克隆完成后返回持续同步状态。 操作步骤 1. 登录主机迁移服务管理控制台。 2. 在左侧导航树中，单击“迁移服务器”，进入迁移服务器列表页面。 3. 在迁移服务器列表页面，选择需要删除云硬盘快照的服务器，在“操作”列单击“更多 > 删除云硬盘快照”。 4. 在弹出的“删除目的端云硬盘快照”窗口中，勾选需要删除的快照类型，单击“确定”。