本页介绍了文档数据库服务的分片集群系统架构，方便您更好的了解文档数据库服务。 集群系统架构由Mongos、Shard、ConfigServer三类角色组成。您可以自由选择Mongos和Shard的数量和规格，自由组成您当前业务能力需求的集群。 Mongos角色：负责路由读写请求，将请求分发到Shard。默认最少2个Mongos，最多支持16个Mongos。 Shard角色：负责数据的读写处理和数据存储。是一个三节点的副本集架构，Shard内主节点故障自转移。默认最少2个Shard，最多支持32个Shard。 ConfigServer：负责集群的元数据存储。是一个三节点的副本集结构，内主节点故障自转移。数量不可选，固定1个。 集群系统架构如下：

接口功能介绍 调用此接口可查询信息配置的基本信息和告警对象。 接口约束 参见请求参数说明。 URI GET /v4/monitor/querynoticetemplatevariable 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 group 是 String 本参数表示分组名称。取值范围： basic：基本信息。 entity：告警对象。 根据以上范围取值。 basic dimension 是 String 告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Array of Objects 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 name String lable名称 basic.idc description String lable描述 资源池名称

接口功能介绍 查询产品规格 接口约束 无 URI GET /v3/instance/queryProd 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 200000002368 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 接口系统层面状态码。成功：800，失败：900 message String 描述状态 returnObj Object 返回对象 returnObj error String 错误码，只有非成功才有这个字段，方便快速定位问题 表 returnObj 参数 参数类型 说明 示例 下级对象 data Array of Objects 规格详情列表 FlavorDetail 表 FlavorDetail 参数 参数类型 说明 示例 下级对象 flavorID String 规格id 9b4b5e39db25f2c8391476881ee77d5c specName String 规格名称 rocketmq.2u4g.cluster flavorType String 规格类型 C7 flavorName String 规格类型名称 计算增强型 cpuNum Integer cpu核数 2 memSize Integer 内存大小，单位G 4 multiQueue Integer 多队列数 2 pps Integer 网络最大收发包能力 (万PPS) 40 bandwidthBase Float 基准带宽 (Gbps) 0.8 bandwidthMax Integer 最大带宽 (Gbps) 4 cpuArch String cpu架构（x86、arm） x86 series String 系列 C azList Array of Strings 支持的az名称列表 ["cnhuadong1jsnj1Apublicctcloud", "cnhuadong1jsnj3Apublicctcloud", "cnhuadong1jsnj2Apublicctcloud"] skuProdId String 产品id 201101

6、请求代码示例 json Curl X POST " H "ContentType: application/json" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "appkey:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:aiglobal.ctapi.ctyun.cn" data '{"data":["AAAAAAAAA...."]}' 7、返回值说明 请求成功返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Int 返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表。 0 message 是 String 如果statusCode 为 0，返回 success；如果statusCode 非 0，则返回对应的可读错误信息。 success returnObj 是 Dict 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 politic 是 List 审核场景 / politic[] 表politic 参数 是否必填 参数类型 说明 示例 下级对象 label 是 Int 分类标签值 0 / classname 是 String 分类标签描述 违规 / confidence 是 Float 该段文本违规的置信度 0.98 / 请求失败返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 code 是 Int 错误码，放置API对应的错误码 4010 message 是 Str 返回对应的错误信息 error details 是 Str 返回对应的错误描述 文件大小不符合要求 error 是 String 返回对应的错误码 AIOP4101

通知模板 通知模板：查询变量 接口功能介绍 调用此接口可查询信息配置的基本信息和告警对象。 接口约束 参见请求参数说明。 URI GET /v4/monitor/querynoticetemplatevariable 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 group 是 String 本参数表示分组名称。取值范围：basic：基本信息。entity：告警对象。 根据以上范围取值。 basic dimension 是 String 告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 ecs 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Array of Objects 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 name String lable名称 basic.idc description String lable描述 资源池名称

前提条件 保护实例已初始同步完成，并且保护实例的状态为“同步完成”或者“容灾演练失败”。 保护实例的生产业务位于生产站点时，才能进行容灾演练。 操作步骤 1. 登录管理控制台。 2. 单击服务列表，选择“存储 > 存储容灾服务 SDRS”。进入“存储容灾服务”页面。 3. 在“异步复制”页面，单击待进行容灾演练的保护实例所在站点复制对的保护组数。进入对应站点复制对的保护组页面。 4. 在左侧导航选择相应的保护组。进入保护组详情页面。 5. 在保护实例列表中，单击待进行容灾演练的保护实例所在行操作列的“容灾演练。 6. 进入容灾演练页面，根据界面提示配置容灾演练弹性云主机的信息。 7. 单击“下一步”，进入信息确认界面，确认容灾演练的信息后，单击“提交”开始创建容灾演练。 8. 保护实例状态显示为“创建容灾演练中”，创建完成后，保护实例状态恢复为“同步完成”。 9. 容灾演练创建成功后，可从容灾演练页面进行查看，您可以登录容灾演练服务器，检查业务是否正常运行。 表 参数说明 参数 说明 取值样例 规格 选择容灾演练弹性云主机的规格。 容灾演练名称 设置容灾演练的名称。 名称只能由中文字符、英文字母、数字、“”、“”和“.”组成，且不能有空格，长度不能大于64个字符。 DrillECS02 网络 选择容灾演练的VPC。 容灾演练VPC和容灾站点服务器所在的VPC不能是同一个。 子网 选择容灾演练的子网。 IP 选择容灾演练弹性云主机获取IP地址的方式： l 保留当前IP：当选择的容灾演练子网和生产站点服务器IP存在同一网段时，此选项可以保持容灾演练服务器和生产站点服务器IP地址一致。 l DHCP：自动获取IP地址。 l 手动指定：手动指定时需填写指定的IP地址。

敏感数据识别任务扫描完成后，可通过DSC服务的“识别结果”页面，查看数据资产的风险分布、风险等级以及敏感数据存在的位置。 前提条件 已至少执行过一次敏感数据识别任务。 操作步骤 1. 单击左上角的，选择区域或项目。 2. 在左侧导航树中，单击，选择“安全>数据安全中心”，进入数据安全中心总览界面。 3. 选择左侧导航树中的“敏感数据识别 > 识别结果”，进入识别结果页面。 数据安全中心DSC统计了高风险、中风险和低风险对象的数量及分布图，分别包括大数据、数据库、OBS三个服务。 数据安全中心DSC针对扫描对象提供了详细的识别结果列表，同时，您可以在检测结果列表右上角筛选您想要查看的敏感数据识别结果，可通过风险等级、任务名称、数据类型或者对象名称进行筛选，识别结果列表参数说明如下表所示。 参数名称 参数说明 资产名称 敏感数据识别的对象名称。 数据类型 OBS、数据库、大数据 、MRS。 所属任务 任务名称，检测结果对象隶属的敏感数据检测任务名称。 未知风险信息 根据您设置的识别规则，经检测，未发现风险的资产数量。 低风险敏感信息 根据您设置的识别规则，经检测，统计的低风险（风险等级：1~3级）的资产数量。 中风险敏感信息 根据您设置的识别规则，经检测，统计的中风险（风险等级：4~7级）的资产数量。 高风险敏感信息 根据您设置的识别规则，经检测，统计的高风险（风险等级：8~10级）的资产数量。 上次识别时间 最近扫描该对象的时间。 操作 单击“查看详情”，查看该对象的识别结果明细。 4. 单击扫描对象所在行的“操作”列的“查看详情”，然后进入“结果明细”页面。 在页面的左上角的下拉框中选择任务名称、数据类型或者对象名称，可以通过筛选来查看具体扫描对象的识别结果。 单击页面的右上角的“下载识别结果”，下载风险结果报表。 敏感信息分布 可查看敏感信息的风险分布情况、对应风险等级资产的数量及其占比、Top10命中规则。 血缘图 可查看资产中敏感数据的具体名称、路径、风险等级。

接口功能介绍 接受共享镜像。 接口约束 无 URI POST /v3/shareImage/acceptShareMirrors 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID rg1234567890abcdef1234567890abcd 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOidList 是 Array of Strings 镜像ID列表 响应参数 参数 参数类型 说明 示例 下级对象 code Integer 状态码 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "imageOidList":["miggfapw5e4e5i20ab6wu36","miranfo6aknzrnx4m4nbw1s"] } 响应示例 { "code":0 } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 拒绝共享镜像。 接口约束 无 URI POST /v3/shareImage/rejectShareMirrors 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID rg1234567890abcdef1234567890abcd 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOidList 是 Array of Strings 镜像ID列表 响应参数 参数 参数类型 说明 示例 下级对象 code Integer 状态码 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "imageOidList":["miggfapw5e4e5i20ab6wu36","miranfo6aknzrnx4m4nbw1s"] } 响应示例 { "code":0 } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 批量发布消息 接口约束 无 URI POST /v3/api/publishMessageBatch 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 华东1 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 445d30ce3d5d40a2a79dc444a8c83859 data 是 Array of Objects data data 表 data 参数 是否必填 参数类型 说明 示例 下级对象 topics 是 String 订阅的topic列表，支持多个topic，以逗号分隔 t/a,t/b,t/c clientid 是 String 客户端id qos 是 String 取值为0到2，通信等级，默认为0 payload 是 String 消息文本 响应参数 参数 参数类型 说明 示例 下级对象 message String 描述状态 statusCode String 800成功 其他失败 error String 错误码 returnObj Object 返回对象 枚举参数 无

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 []

定价示例2：多点直连场景 客户需求： 客户有20个省内分支点互相访问，其中10个点接入带宽100Mbps，另外10个点接入带宽300Mbps 方案： 采用办公组网直连模式 定价示例： 100Mbps分支授权费用101001000 300Mbps分支授权费用10 2 1002000 总费用/月1000+20003000元/月 定价示例3：远程办公、办公组网叠加场景 客户需求： 客户总部部署连接器，办公组网带宽500Mbps，另外有美国分支办公组网带宽300Mbps、欧洲分支办公组网带宽200Mbps 并且同时有国内出差员工需要客户端访问总部连接器。客户端数量100个 方案： 同时订购零信任远程办公套餐和网络服务办公组网 定价示例： 购买零信任远程办公VPN版180元/月 90个终端数：906540元/月 网络服务办公组网中国内地带宽：500Mbps3517500元/月 网络服务办公组网美洲带宽：300Mbps540162000元/月 网络服务办公组网欧洲带宽：200Mbps580116000元/月 总费用/月180+540+17500+162000+116000296220/月

开启安全认证 Nacos引擎专享版默认关闭安全认证。可通过控制台开启安全认证。 说明 开启安全认证后，控制台仅能看到有权限访问的命名空间；同时没有配置用户名密码的客户端将无法访问Nacos实例，请谨慎操作。 步骤 1 登录微服务引擎控制台。 步骤 2 在左侧导航栏选择“注册配置中心”。 步骤 3 单击待开启安全认证的Nacos引擎。 步骤 4 在左侧导航栏选择“权限控制”。 步骤 5 单击“开启安全认证”。 步骤 6 在弹出框中单击“确定”，该引擎开启安全认证成功。 关闭安全认证 说明 关闭安全认证后，无法对各个用户进行权限控制，客户端无需密码即可访问Nacos实例，访问控制台可以看到全部的命名空间，请谨慎操作。 步骤 1 登录微服务引擎控制台。 步骤 2 在左侧导航栏选择“注册配置中心”。 步骤 3 单击待关闭安全认证的Nacos引擎。 步骤 4 在左侧导航栏选择“权限控制”。 步骤 5 单击“关闭安全认证”。 步骤 6 在弹出框中单击“确定”，待该引擎的状态变为“可用”时，该引擎关闭安全认证成功。

接口功能介绍 查询站点监控的实时监控数据。 接口约束 regionID（资源池）存在，且存在站点监控资源。 URI POST /v4/monitor/querysitemonitorlatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID deviceUUIDList Array of String 是 ["hxfi20221027191319"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 14 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 hxfi20221027191319 fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID hxfi20221027191319 itemList Array of Objects 监控项值列表 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

接口功能介绍 查询裸金属设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在裸金属设备。 URI POST /v4/monitor/querybaremetallatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID deviceUUIDList Array of String 是 ["ssi30bdlsblz67tapnhg9jecuyzp5d"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 138 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 ssi30bdlsblz67tapnhg9jecuyzp5d fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID ssi30bdlsblz67tapnhg9jecuyzp5d itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

本文介绍科研助手的计费方式。 计费说明 科研助手资源包含CPU、内存、GPU和本地存储等，根据您申请的实际实例资源规格，以及每个实例实际运行时长按需计费，计费时长从开始下载容器镜像 (docker pull) 到实例停止使用进行计算。以小时为出账周期，在每个结算周期生成账单并从账户中扣除相应费用。 计费周期 系统以“小时”为单位统计实际用量（单位取整点区间，如8:009:00），根据实际用量生成话单并结算扣费。 账单出账时间通常在当前计费周期结束后，具体出账时间以系统为准。 计费公式 实例费用的计算公式为：实例费用（实例CPU资源量 x CPU单价 +实例内存资源量 x 内存单价 +实例GPU资源量 x GPU单价+实例磁盘存储资源量 x 实例磁盘存储单价） x 实例运行时长。 产品定价 科研助手产品定价信息可参考 计费项 说明。 计费案例 用户A在2023年6月1日 8:00~9:00的计费周期内，创建一个2 vCPU、4 GB内存、1块 NVIDIA T4 16G GPU卡的开发环境实例，并在实例运行1小时后删除。则用户A在此计费周期内的费用如下： CPU费用2核 x 0.05元/核/小时 x 1 0.1元 内存费用4GB x 0.02元/GB x 1 0.08元 GPU费用1 x 4.09元/块/小时 x 1 4.09元 实例总费用CPU费用+内存费用+GPU费用0.1+0.08+4.094.27元

购买弹性云主机 1. 登录天翼云“控制中心(控制台)”，在页面上方选择用户对应购买弹性云主机的地域，例如“福州3”。选择“计算”大类下的“弹性云主机”产品。或是在天翼云官网首页点击“立即订购”。 2. 单击“创建云主机”。 配置弹性云主机实例规格 1. 选择计费模式“包年/包月”或是“按量付费”。 2. 完成页面必填项的选择，例如地域、主机名称、规格、镜像类型、存储等。 说明 创建云主机过程，请您根据规格特性，选择符合业务需求的云主机规格。请参考： 使用云主机需要您支付相应费用，详细请见： 创建云主机需要配置系统盘与数据盘，如果您对存储性能有要求，请参考： 您需要为存储支付相应的费用，详细请见： 网络配置 1. 选择弹性云主机对应的网络配置选项含网卡、扩展网卡、安全组、弹性IP等，根据页面提示完成操作。 2. 点击“下一步：高级配置”按钮。 说明 安全组是控制云主机访问策略的组件，相关概念与操作，请参考： 如果您有访问公网的需求，请您使用弹性IP，相关概念与应用场景，请参考： 您需要为弹性IP支付相应的费用，请参考：

字段 说明 apiVersion API版本，固定值 autoscaling.ctyun.com/v1beta1 kind API类型，固定值 CronHorizontalPodAutoscaler metadata.name CronHPA策略名称。 metadata.labels 策略标签 metadata.namespace CronHPA策略所在的命名空间。 spec.scaleTargetRef 指定CronHPA的扩缩容对象，可配置以下字段： apiVersion：CronHPA扩缩容对象的API版本。 kind：CronHPA扩缩容对象的API类型。 name：CronHPA扩缩容对象的名称。CronHPA支持HPA策略或Deployment。 spec.jobs CronHPA策略规则，可添加多个规则。每个规则可配置以下字段： name：CronHPA规则名称，该名称需唯一。 schedule：指定任务运行时间与周期，参数格式与gocron类似，请参见下表。 targetSize：扩缩容的Pod数目。 disable：参数值为“true”或“false”。其中“false”表示该规则生效，“true”则表示该规则不生效。

接口功能介绍 关闭云电脑 接口约束 无 URI POST /v3/desktop/batch/stop 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023101301183998 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopList":[{"desktopOid":"XXXXXXXXXXXXX6925"}]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

接口功能介绍 重装云电脑 接口约束 无 URI POST /v3/desktop/batch/rebuild 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023101301183998 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopList":[{"desktopOid":"XXXXXXXXXXXXX6925"}]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

接口功能介绍 解锁云电脑 接口约束 无 URI POST /v3/desktop/batch/unlock 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023101301183998 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopList":[{"desktopOid":"XXXXXXXXXXXXX6925"}]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }}

接口功能介绍 更改接入点的资源权限 接口约束 无 URI POST /v1/applicationAccessPointManage/changePointResourcePolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d policyType 是 String 权限类型 allow cmkList 否 Array of Strings 密钥资源列表 ["908b979ecd964d6499b7856a671ebc82"] certList 否 Array of Strings 证书资源列表 ["908b979ecd964d6499b7856a671ebc82"] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 13e2aeb065364db1a8cc611f3edd63ee

接口功能介绍 获取接入点的接口权限详情 接口约束 无 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 请求头header { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" }

接口功能介绍 更新密钥描述接口 接口约束 请保证账户余额大于0 URI POST /v1/keyManage/updateKeyDescription 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff description 否 String 描述 abcd 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 更新密钥描述成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id de4138537a8b42c3a1a80ce1898f3476 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "cmkUuid": "27e658cf3b904987adfdfe8700ee4f59", "description": "描述更改1" }

vpn用户服务修改。 接口功能介绍 vpn用户服务修改 接口约束 支持集群模式资源池。 URI POST /v4/vpn/ipsecuserservice/update 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 是 String IPSCE 服务名称 ipsec111 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 ipsecServiceID 是 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96

接口功能介绍 查询接入点的终端节点白名单 接口约束 无 URI POST /v1/userEndpointControl/showEndpointWhitelist 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d endpointId 是 String 终端节点id endpointwlp72qh2bd 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 enableWhitelist Boolean 是否开启白名单 true ips Array of Strings ip列表 ["1.1.1.1"] applicationId String 接入点id b2160c2c9c704ca9b8080d186c97280d 请求示例

接口功能介绍 实例节点扩容 接口约束 无 URI POST /v3/api/createAddNodeOrder 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID targetNodeNum 是 Integer 目标实例的代理数，取值为4到9，9节点不可以再进行扩容 响应参数 参数 参数类型 说明 示例 下级对象 message String 描述状态 statusCode String 800成功 其他失败 error String 错误码 returnObj Object 返回对象 枚举参数 无 请求示例 请求url 请求头header { "regionId":"bb9fdb42056f11eda1610242ac110002" } 请求体body { "prodInstId": "123", "targetNodeNum": 4 } 响应示例 { "statusCode": 800 } 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象

接口功能介绍 更新转发规则 接口约束 仅支持更新策略名称和描述，未见策略名称字段；域名和URL字段不支持修改。 URI POST /v4/elb/updaterule 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b ID 否 String 转发规则ID, 该字段后续废弃 xxxx policyID 否 String 转发规则ID, 推荐使用该字段, 当同时使用 ID 和 policyID 时，优先使用 policyID xxxx priority 否 Integer 优先级，数字越小优先级越高，取值范围为：1100(目前不支持配置此参数,只取默认值100) 100 description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:'{},./;'[,]·！@ ￥%……&（） —— +{},《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc conditions 否 Array of Objects 匹配规则数据 conditions action 否 Object 规则目标 action 表 conditions 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 类型。取值范围：servername（服务名称）、urlpath（匹配路径） urlpath serverNameConfig 否 Object 服务名称 serverNameConfig urlPathConfig 否 Object 匹配路径 urlPathConfig 表 serverNameConfig 参数 是否必填 参数类型 说明 示例 下级对象 serverName 否 String 服务名称 xxxx 表 urlPathConfig 参数 是否必填 参数类型 说明 示例 下级对象 urlPaths 否 String 匹配路径 /// matchType 否 String 匹配类型。取值范围：ABSOLUTE，PREFIX，REG REG 表 action 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 默认规则动作类型。取值范围：forward、redirect、deny(目前暂不支持配置为deny) forward forwardConfig 否 Object 转发配置 forwardConfig redirectListenerID 否 String 重定向监听器ID，当type为redirect时，此字段必填 xxzzzz 表 forwardConfig 参数 是否必填 参数类型 说明 示例 下级对象 targetGroups 否 Array of Objects 后端服务组 targetGroup 表 targetGroup 参数 是否必填 参数类型 说明 示例 下级对象 targetGroupID 是 String 后端服务组ID tgxxx weight 否 Integer 权重，取值范围：1256。默认为100 100

接口功能介绍 查看指定资源池内的所有监控面板的具体内容，或者查看某一指定监控面板的内容。 接口约束 regionID（资源池）存在，如果查询指定监控面板内容，则需要templateID（监控面板）存在。 URI GET /v4/monitor/describemonitor 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 否 0bf803e8504911ed8fb7005056897257 监控面板ID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 2 页大小，默认为10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateList Array of Objects 监控面板具体内容 templateList totalCount Integer 查询到的监控面板个数 1 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 表templateList 参数 参数类型 说明 示例 下级对象 templateID String 监控面板ID 0bf803e8504911ed8fb7005056897257 name String 监控面板名称 whGHk regionCtyunID String 监控面板所属资源池ID 81f7728662dd11ec810800155d307d5b fuserLastUpdated String 上次更新时间 20221020T07:30:19Z list Array of Objects 监控视图具体内容 list 表list 参数 参数类型 说明 示例 下级对象 title String 监控视图名称 testViewName content Array of Objects 监控项具体内容，为keyvalue格式 content viewID String 监控视图ID 4cb790ae489411edb386005056897257 表content 参数 参数类型 说明 示例 下级对象 {itemName} String 监控项名称 dim {value} Object 监控项值，与监控项名称组成keyvalue格式，可以为任意内容 turntest8

分布式消息服务RocketMQ版支持任意时间的定时消息，最大推迟时间可达到40天。 定时消息即生产者生产消息到分布式消息服务RocketMQ版后，消息不会立即被消费，而是延迟到设定的时间点后才会发送给消费者进行消费。 收发消息前，请参考收集连接信息收集RocketMQ所需的连接信息。 准备环境 1. 在命令行输入python，检查是否已安装Python。得到如下回显，说明Python已安装。 PS C:> python Python 3.9.9 (tags/v3.9.9:ccb0e6a, Nov 15 2021, 18:08:50) [MSC v.1929 64 bit (AMD64)] on win32 Type "help", "copyright", "credits" or "license" for more information. 如果未安装Python，请使用以下命令安装： pip install rocketmqclientpython 2. 安装librocketmq库和rocketmqclientpython。 说明 建议下载rocketmqclientcpp2.2.0，获取librocketmq库。 3. 将librocketmq.so添加到系统动态库搜索路径。 1. 查找librocketmq.so的路径。 find / name librocketmq.so 2. 将librocketmq.so添加到系统动态库搜索路径。 ln s /查找到的librocketmq.so路径/librocketmq.so /usr/lib sudo ldconfig 以下示例代码中的参数说明如下，请参考收集连接信息获取参数值。 GROUP：表示消费组名称。 ENDPOINT：表示实例连接地址和端口。 TOPIC：表示Topic名称。 发送消息 参考如下示例代码。 import datetime from rocketmq.client import Producer, Message from rocketmq.exceptions import RocketMQException endpoint "${ENDPOINT}" 填写分布式消息服务RocketMQ控制台Namesrv接入点 accesskey "${ACCESSKEY}" 填写AccessKey 在分布式消息服务RocketMQ控制台用户管理菜单中创建的用户ID accesssecret "${SECRETKEY}" 填写SecretKey 在分布式消息服务RocketMQ控制台用户管理菜单中创建的用户密钥 topic "${TOPIC}" 填写Topic，在管理控制台创建 producergroup "${GROUP}" 生产者组group 初始化生产者 producer Producer(producergroup) producer.setnamesrvaddr(endpoint) producer.setsessioncredentials(accesskey, accesssecret, "") 启动生产者 try: producer.start() except RocketMQException as e: print('start producer error:', e) exit(1) msg Message(topic) msg.setbody("Hello RocketMQ") delaytime 10 发送任意延迟消息，时间单位为毫秒，如下所示：消息将在10s后投递 delaytimestamp int((datetime.datetime.now() + datetime.timedelta(secondsdelaytime)).timestamp() 1000) msg.setproperty('STARTDELIVERTIME', str(delaytimestamp)) 发送消息 try: result producer.sendsync(msg) print('send result:', result) except RocketMQException as e: print('send message error:', e) producer.shutdown() exit(1) 关闭生产者实例，释放资源 producer.shutdown()

接口功能介绍 适用于此操作的云电脑需要满足全部条件：1. 计费方式为单实例、资源包。2. 不属于池化桌面池或并发桌面池的云电脑。 此操作将先进行云电脑关机操作。 接口约束 无 URI POST /v3/desktop/resizeSystemDisk 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID diskSize 是 Integer 扩容后系统盘大小（单位：GB）。需为10的倍数，取值范围：(当前系统盘大小,200] autoPay 否 Boolean 是否自动支付（仅创建单独付费云电脑有效），默认false。取值范围： true:是。（仅订购类型为包周期类型有效，需账号有足够金额） false:否。（仅订购类型为包周期类型有效） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 newOrderNo String 订单号（仅创建单独付费云电脑有效）。 newOrderId String 订单id（仅创建单独付费云电脑有效）。 totalPrice String 总价格（仅创建单独付费云电脑有效）。 operation Object 扩容云电脑系统盘操作。可用于查询操作状态（相关接口：查询操作列表）。 operation 表 operation 参数 参数类型 说明 示例 下级对象 operationId String 操作ID。 type String 操作类型。枚举值范围：Common通用型;Task任务型。