华为云用户手册

URI URI格式 GET /v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&is_serverless={is_serverless} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 database_name 是 数据库引擎名。支持如下数据库引擎，不区分大小写： MySQL PostgreSQL SQLServer version_name 否 数据库版本号，获取方法请参见查询数据库引擎的版本。（可输入小版本号） is_serverless 否 是否查询Serverless规格。取值范围如下，区分大小写： true：查询Serverless规格。 false：查询非Serverless规格。默认值 false。 spec_code 否 规格编码。 说明： RDS for MySQL规格码请参见云数据库 RDS for MySQL实例类型。

导入工程 打开IntelliJ IDEA，在菜单栏选择“Import Project”。 弹出“Select File or Directory to Import”对话框。 在弹出的对话框中选择解压后的SDK路径，单击“OK”。 “Import project from external model”选择“Eclipse”，单击“Next”，进入下一页后保持默认连续单击“Next”，直到“Please select project SDK”页面。 图2 Import Project 单击“Finish”，完成工程导入。 图3 Finish 完成导入后，目录结构如下图。 图4 目录结构

操作步骤 在MRS Manager，单击“租户管理”。 单击“动态资源计划”页签。 单击“队列配置”页签。 在租户队列表格，指定租户队列的“操作”列，单击“修改”。 在“租户管理”页签左侧租户列表，单击目标的租户，切换到“资源”页签，单击编辑按钮也能打开修改队列配置页面。 表1 队列配置参数 参数名 描述 “最大应用数量” 表示最大应用程序数量。取值范围从“1”到“2147483647”。 “AM最大资源百分比” 表示集群中可用于运行application master的最大资源占比。取值范围从“0”到“1”。 “用户资源最小上限百分比 (%)” 表示用户使用的最小资源上限百分比。取值范围从“0”到“100”。 “用户资源上限因子” 表示用户使用的最大资源限制因子，与当前租户在集群中实际资源百分比相乘，可计算出用户使用的最大资源百分比。最小值为“0”。 “状态” 表示资源计划当前的状态，“运行”为运行状态，“停止”为停止状态。 “默认资源池” 表示队列使用的资源池。默认为“Default”，如果需要修改为其他资源，需要先配置队列容量，请参见配置资源池的队列容量策略。

操作步骤 修改系统资源调整基数。 在MRS Manager界面，单击“系统设置”，在“资源管理”区域单击“静态服务池”。 单击“配置”，显示服务池配置组管理页面。 在“系统资源调整基数”分别修改参数“CPU(%)”和“Memory(%)”。 修改“系统资源调整基数”将限制Flume、HBase、HDFS、Impala和YARN服务能够使用节点的最大物理CPU和内存资源百分比。如果多个服务部署在同一节点，则所有服务使用的最大物理资源百分比不能超过此参数值。 单击“下一步”完成编辑。 需要重新修改参数，可单击页面下方的“上一步”。 修改服务池默认“default”配置组。 在“服务池配置”表格中Flume、HBase、HDFS、Impala和YARN服务对应的“CPU LIMIT(%)”、“CPU SHARE(%)”、“I/O(%)”和“Memory(%)”填写各服务的资源使用百分比数量。 所有服务使用的“CPU LIMIT(%)”资源配置总和可以大于100%。 所有服务使用的“CPU SHARE(%)”和“I/O(%)”资源配置总和需为100%。例如为HDFS和Yarn服务分配使用的CPU资源，2个服务分配到的CPU资源总和为100%。 所有服务使用的“Memory(%)”资源配置总和可以小于或等于100%，也可以大于100%。 “Memory(%)”不支持动态生效，仅在“default”配置组中可以修改。 单击页面空白处完成编辑，MRS Manager将根据集群硬件资源与分配情况，在“详细配置”生成服务池参数的正确配置值。 如果根据业务需要，可以单击“详细配置”右侧的修改服务池的参数值。 在“服务池配置”单击指定的服务名，“详细配置”将只显示此服务的参数。手工修改参数值并不会刷新服务使用资源的百分比显示。支持动态生效的参数，在新增加的配置组中显示名将包含配置组的编号，例如“HBase : RegionServer : dynamic-config1.RES_CPUSET_PERCENTAGE”，参数作用与“default”配置组中的参数相同。 表1 静态服务池参数一览 参数名 参数描述 RES_CPUSET_PERCENTAGE dynamic-configX.RES_CPUSET_PERCENTAGE 配置服务使用CPU PERCENTAGE。 RES_CPU_SHARE dynamic-configX.RES_CPU_SHARE 配置服务使用CPU share。 RES_BLKIO_WEIGHT dynamic-configX.RES_BLKIO_WEIGHT 配置服务占用I/O的权重。 HBASE_HEAPSIZE 配置RegionServer的JVM最大内存。 HADOOP_HEAPSIZE 配置DataNode的JVM最大内存。 yarn.nodemanager.resource.memory-mb 配置当前节点上NodeManager可使用的内存大小。 dfs.datanode.max.locked.memory 配置DataNode用做HDFS缓存的最大内存。 FLUME_HEAPSIZE 配置每个flume实例能使用的最大JVM内存。 IMPALAD_MEM_LIMIT 配置impalad实例可使用的最大内存。 添加自定义资源配置组。 是否需要根据时间自动调整资源配置？ 是，执行3.b。 否，执行4。 单击增加新的资源配置组。在“调度时间”，单击显示时间策略配置页面。 根据业务需要修改以下参数，并单击“确定”保存： “重复”：当勾选“重复”时表示此资源配置组按调度周期重复运行。不勾选时请设置一个资源配置组应用的日期与时间。 “重复策略”：支持“每天”、“每周”和“每月”。仅在“重复”模式中生效。 “介于”：表示资源配置组应用的开始与结束时间。请设置一个唯一的时间区间，如果与已有配置组的时间区间有重叠，则无法保存。仅在“重复”模式中生效。 “default”配置组会在所有未定义的时间段内生效。 新增加的配置组属于动态生效的配置项集合，在配置组应用的时间区间内可直接生效。 新增加的配置组可以被删除。最多增加4个动态生效的配置组。 选择任一种“重复策略”，如果结束时间小于开始时间，默认标识为第二天的时间。例如“22:00”到“6:00”表示调度时间为当天22点到第二天6点。 若多个配置组的“重复策略”类型不相同，则时间区间可以重叠，且生效的策略优先级从低到高的顺序为“每天”、“每周”、“每月”。例如，有“每月”与“每天”的调度配置组，时间区间分别为4:00到7:00，6:00到8:00，此时以每月的配置组为准。 若多个配置组的“重复策略”类型相同，当日期不相同时，则时间区间可以重叠。例如，有两个“每周”的调度配置组，可以分别指定时间区间为周一和周三的4:00到7:00。 在“服务池配置”修改各服务资源配置，并单击页面空白处完成编辑，然后执行4。 用户可单击“服务池配置”右侧的重新修改参数。如果根据业务需要，在“详细配置”单击，手动更新由系统生成的参数值。 保存配置。 单击“保存”，在“保存配置”窗口勾选“重新启动受影响的服务或实例。”，单击是保存并重启相关服务。 界面提示“操作成功。”，单击“完成”，服务成功启动。

MRS权限说明 默认情况下，管理员创建的IAM用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 MRS部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问MRS时，需要先切换至授权区域。 权限模型根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对MRS服务，管理员能够控制IAM用户仅能对集群进行指定的管理操作。如不允许某用户组删除集群，仅允许操作MRS集群基本操作，如创建集群、查询集群列表等。多数细粒度策略以API接口为粒度进行权限拆分，MRS支持的API授权项请参见权限策略和授权项。 如表1所示，包括了MRS的所有默认系统策略。 表1 MRS系统策略 策略名称 描述 策略类别 MRS FullAccess MRS管理员权限，拥有该权限的用户可以拥有MRS所有权限。 细粒度策略 MRS CommonOperations MRS服务普通用户权限，拥有该权限的用户可以拥有MRS服务使用权限，无新增、删除资源权限。 细粒度策略 MRS ReadOnlyAccess MRS服务只读权限，拥有该权限的用户仅能查看MRS的资源。 细粒度策略 MRS Administrator 操作权限： 对MRS服务的所有执行权限。 拥有该权限的用户必须同时拥有Tenant Guest和Server Administrator权限。 RBAC策略 表2列出了MRS常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。 表2 常用操作与系统策略的授权关系 操作 MRS FullAccess MRS CommonOperations MRS ReadOnlyAccess MRS Administrator 创建集群 √ x x √ 调整集群 √ x x √ 升级节点规格 √ x x √ 删除集群 √ x x √ 查询集群详情 √ √ √ √ 查询集群列表 √ √ √ √ 设置弹性伸缩策略 √ x x √ 查询主机列表 √ √ √ √ 查询操作日志 √ √ √ √ 创建并执行作业 √ √ x √ 停止作业 √ √ x √ 删除单个作业 √ √ x √ 批量删除作业 √ √ x √ 查询作业详情 √ √ √ √ 查询作业列表 √ √ √ √ 新建文件夹 √ √ x √ 删除文件 √ √ x √ 查询文件列表 √ √ √ √ 批量操作集群标签 √ √ x √ 创建单个集群标签 √ √ x √ 删除单个集群标签 √ √ x √ 按照标签查询资源列表 √ √ √ √ 查询集群标签 √ √ √ √ 访问Manager页面 √ √ x √ 查询补丁列表 √ √ √ √ 安装补丁 √ √ x √ 卸载补丁 √ √ x √ 运维通道授权 √ √ x √ 运维通道日志共享 √ √ x √ 查询告警列表 √ √ √ √ 订阅告警消息提醒 √ √ x √ 提交SQL语句 √ √ x √ 查询SQL结果 √ √ x √ 取消SQL执行任务 √ √ x √

示例流程 图1 给用户授权MRS权限流程 创建用户组并授权 在IAM控制台创建用户组，并授予MRS服务对应权限。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1.创建用户组并授权中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，切换至授权区域，验证权限： 在“服务列表”中选择MRS服务，进入MRS主界面，单击右上角“购买集群”，尝试购买MRS集群，如果无法购买MRS集群（假设当前权限仅包含MRS ReadOnlyAccess），表示“MRS ReadOnlyAccess”已生效。 在“服务列表”中选择除MRS服务外（假设当前策略仅包含MRS ReadOnlyAccess）的任一服务，若提示权限不足，表示“MRS ReadOnlyAccess”已生效。

操作步骤 登录FusionInsight Manager，查看是否存在未清除的告警？ 是，请修复告警。告警处理完毕后，执行2。 否，执行2。 以omm用户分别登录主备管理节点。 在主管理节点执行以下命令查看管理平面网关。 cat ${BIGDATA_HOME}/om-server/OMS/workspace/conf/oms-config.ini | grep om_gateway 在主备管理节点分别执行ping 管理平面网关，检查节点是否与管理平面网关连通？ 是，执行5。 否，请联系网络管理员修复网络故障，处理完毕后，执行5。 在主管理节点执行以下命令，获取当前环境NTP服务器域名。 本章节后续步骤中将以“ntp.myhuaweicloud.com”为例 cat /opt/Bigdata_func/cloudinit/cloudinit_params | grep ntpserver 在主管理节点执行以下命令，检查集群时间与新的NTP服务器时间偏差。单位为秒。 例如，检查与NTP服务器“ntp.myhuaweicloud.com”的时间差，执行ntpdate -d ntp.myhuaweicloud.com命令，界面显示： 6 Dec 15:16:10 ntpdate[2861453]: step time server 100.79.3.251 offset +2.118107 sec 其中+2.118107 sec表示时间偏差。正数表示NTP服务器时间比集群当前时间快，负数表示NTP服务器时间比集群当前时间慢。 ntp的版本号可以使用ntpq -v或者ntpq --version命令查询，具体显示信息以实际环境为准。 ntpq -v界面显示： 10.1.1.112: ~# ntpq -v ntpq - standard NTP query program - Ver. 4.2.4p8 ntpq --version界面显示： 10.1.1.112: ~# ntpq --version ntpq 4.2.8p10@1.3728-o Mon Jun 6 08:01:59 UTC 2016 (1) 检查时间偏差的绝对值是否超过“150”。 是，执行8。 否，时间偏差的绝对值不超过“150”，以omm用户执行10。 确认是否可以停止集群。 是，停止上层业务并停止集群，然后执行9。 否，任务结束。 确认NTP服务器时间是否比集群当前时间慢？ 是，NTP服务器时间慢，停止集群界面显示“操作成功”后需等待，间隔大约为6得到的时间偏差，再以omm用户执行11。 否，NTP服务器时间快，停止集群界面显示“操作成功”后直接以omm用户执行11。 在主管理节点执行以下命令，更换NTP服务器，任务结束。 sh ${BIGDATA_HOME}/om-server/om/bin/tools/modifyntp.sh --ntp_server_ip ntp.myhuaweicloud.com NTP服务器IP地址不可以设置为集群内节点IP地址，否则可能会导致节点与主备oms节点业务网络断连。 在主管理节点执行以下命令，从NTP服务器“ntp.myhuaweicloud.com”立即强制同步时间并更换NTP服务器，任务结束。 sh ${BIGDATA_HOME}/om-server/om/bin/tools/modifyntp.sh --ntp_server_ip ntp.myhuaweicloud.com --force_sync_time 如果停止了集群，在更换NTP服务器后需要重新启动集群。 执行强制同步时间命令后，集群节点大约需要5分钟完成时间同步。

手动快速部署 如果您使用已有的弹性云服务器部署幻兽帕鲁服务端，请保证您的服务器满足以下条件： 1、系统环境：Centos或Ubuntu 2、安全组需要开放UDP协议的8211端口，保证幻兽帕鲁服务器能够对外正常提供服务。 具体安装可参考以下步骤。 远程连接您的服务器，执行如下命令： wget -P /tmp/ https://documentation-samples.obs.cn-north-4.myhuaweicloud.com/solution-as-code-publicbucket/solution-as-code-moudle/deploy-a-palworld-dedicated-server/userdata/install_palworld.sh chmod 744 /tmp/install_palworld.sh /tmp/install_palworld.sh 图1 执行部署脚本 安装幻兽帕鲁专用服务器时，由于网络波动问题可能会运行失败，如果失败了会自动重试几次。当日志最后出现“good game！”，则表示安装成功。 图2 安装幻兽帕鲁服务端 图3 安装成功 当安装成功后，可以输入netstat -ulpt命令，检查幻兽帕鲁服务器的8211端口是否启动成功。 图4 检查8211端口 父主题： 实施步骤

名词解释 基本概念、云服务简介、专有名词解释 弹性云服务器 ECS：是一种可随时自助获取、可弹性伸缩的云服务器，可帮助您打造可靠、安全、灵活、高效的应用环境，确保服务持久稳定运行，提升运维效率。 虚拟私有云 VPC：为云服务器、云容器、云数据库等云上资源构建隔离、私密的虚拟网络环境。VPC丰富的功能帮助您灵活管理云上网络，包括创建子网、设置安全组和网络ACL、管理路由表、申请弹性公网IP和带宽等。 弹性公网IP EIP：提供独立的公网IP资源，包括公网IP地址与公网出口带宽服务。

常见问题 为什么要下线音视频托管功能？ 媒资托管功能的业务流程，需要经过多个基础组件，容易造成多个基础组件的流量拥塞，影响托管能力可用性。 VOD服务已经有成熟的存量数据迁移工具，并提供多平台上传SDK供点播客户集成，可有效支撑增量媒资的快速上传。 现有客户是否能继续使用音视频托管功能？ 存量托管任务属于一次性任务，现网用户不能再使用。 增量托管任务属于长期任务。VOD后台数据库会持久化存储所有历史任务数据。增量托管不再对新用户开放，也不再迭代优化，建议现网在用此功能的用户将数据从OBS迁移至VOD服务存储，不再依赖托管功能。 音视频托管功能下线后，是否有替代功能？ 可使用VOD服务提供的音视频上传能力（本地上传、URL拉取），来上传音视频文件，存储至VOD服务。使用VOD服务统一管理媒资。 如需要使用上传SDK来上传音视频文件，可通过工单联系客服，离线获取SDK。

视频点播服务的加速功能计费价格调整公告 随着点播业务拓展，海外客户逐渐增多。为提供更好的服务，华为云视频点播服务从2024年2月1日起，中国大陆境外计费将由系数计费变更为分区计费。 调整后的价格如表1所示。 如果您的域名加速范围为全球，将执行中国大陆和中国大陆境外分区计费。 表1 中国大陆境外详细的流量阶梯单价 海外分区 0GB~10TB 10TB~50TB 50TB~100TB 100TB~1PB 1PB以上 价格单位（人民币） 亚太1 0.598 0.486 0.433 0.389 0.359 元/GB 亚太2 0.8 0.785 0.695 0.583 0.531 元/GB 亚太3 0.598 0.486 0.433 0.269 0.239 元/GB 欧洲 0.404 0.284 0.232 0.209 0.187 元/GB 北美洲 0.605 0.568 0.426 0.224 0.187 元/GB 中东/非洲 0.807 0.785 0.673 0.583 0.531 元/GB 大洋洲 0.845 0.785 0.732 0.68 0.673 元/GB 南美洲 0.785 0.747 0.643 0.426 0.411 元/GB 其中，海外分区说明如下所示： 亚太1：中国香港、中国澳门、中国台湾、日本、韩国 亚太2：印度 亚太3：亚太其他区域 本次价格调整生效日期为2024年2月1日，请您关注新的计费方式及余额变动，并及时做出业务调整。 若您有任何疑问，可直接联系客户经理或提交工单给我们。衷心感谢各位用户对本产品的信赖与支持！

响应示例 状态码： 200 成功响应。 { "count" : 2, "items" : [ { "id" : "394", "connect_type" : "2", "user_name" : "user001@wksapp***.huawei.com", "pre_conn_time" : "2023-06-05T03:34:43Z", "start_time" : "2023-06-05T06:37:47Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418", "machine_name" : "APS-XS1QJ3TA7T", "failed_reason" : "", "failed_code" : "", "client_mac" : "c8-d9-d2-02-3a-57", "client_name" : "Y002516E2p1", "client_ip" : "10.*73.108.206", "client_version" : "23.2.2.0", "client_type" : "Windows 10", "agent_version" : "23.2.2.0423", "vm_ip" : "10.*.248.130", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-06-05T06:37:47Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" }, { "id" : "112", "connect_type" : "2", "user_name" : "nas01@wksapp***.huawei.com", "pre_conn_time" : "2023-05-23T09:10:03Z", "start_time" : "2023-05-23T09:10:04Z", "end_time" : "2023-05-23T09:16:15Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1395", "machine_name" : "APS-Z5OV9E157G", "failed_reason" : "", "failed_code" : "", "client_mac" : "68-05-ca-ba-c7-98", "client_name" : "kdjhfkjhdghschd", "client_ip" : "10.**.**.151", "client_version" : "23.5.0.0", "client_type" : "Windows 10", "agent_version" : "23.5.0.0519", "vm_ip" : "10.*.83.5", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-05-23T09:16:15Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of UserConnectionInfo objects 应用使用记录列表。 表6 UserConnectionInfo 参数 参数类型 描述 id String 主键。 connect_type String 连接类型。 user_name String 登录用户。 desktop_group_name String 桌面组名。 pre_conn_time String 预连接时间。 start_time String 开始时间。 end_time String 结束时间。 machine_sid String 应用服务器sid。 machine_name String 应用服务器名称。 failed_reason String 连接失败原因。 failed_code String 连接失败状态码。 client_mac String 客户端Mac。 client_name String 客户端名称。 client_ip String 客户端ip。 client_version String 客户端版本。 client_type String 客户端操作系统类型。 agent_version String aps hda版本。 vm_ip String 应用服务器ip。 connect_flag String 连接标志。 wi_ip String 连接IP。 update_time String 更新时间。 tenant_id String 租户id。 virtual_ip String 会话虚拟ip。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 415 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 登录记录唯一标识ID。 connect_type 否 String 用户连接类别。 user_name 否 String 登录用户名称。 machine_sid 否 String 应用服务器sid。 machine_name 否 String 应用服务器名称。 failed_reason 否 String 连接失败原因。 failed_code 否 String 连接失败状态码。 client_name 否 String 客户端名称。 client_version 否 String 客户端版本。 client_type 否 String 客户端操作系统类型。 agent_version 否 String aps hda版本。 vm_ip 否 String 应用服务器ip。 connect_flag 否 String 连接标志，目前值为0。 wi_ip 否 String 连接IP。 update_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 tenant_id 否 String 租户id。 login_start_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 login_end_time 否 String 登录应用结束时间，格式 2022-10-31 08:07:39。 virtual_ip 否 String 会话虚拟ip。

URI GET /v2/{project_id}/desktops 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 桌面所属用户。 computer_name 否 String 桌面名。 desktop_ip 否 String 桌面IP地址。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，取值范围0-1000，默认值1000。 pool_id 否 String 桌面池ID,多个桌面池ID用逗号隔开。 enterprise_project_id 否 String 企业项目ID desktop_type 否 String 桌面类型，为空时查所有桌面。查询多个类型时用,隔开。 DEDICATED：普通桌面，包括专享桌面、专属桌面等。 SHARED: 多用户共享桌面。 subnet_id 否 String 桌面的子网ID。

响应示例 状态码： 200 查询云桌面列表响应 { "total_count" : 2, "desktops" : [ { "desktop_id" : "a6f6e2d1-cc62-46f3-865b-9ae6ae0afde0", "computer_name" : "ZRYUAN107", "created" : "2022-02-23 04:02:07", "ip_address" : "10.0.9.25", "user_name" : "zryuan1", "user_group" : "administrators", "sid" : "3db90102-d11d-4d13-9a96-104696d3c6a3", "in_maintenance_mode" : false, "share_resource_sku" : "workspace.collaborativedesktop.6party.standard" }, { "desktop_id" : "248077ea-bb64-4e58-b5e8-6b686600920e", "computer_name" : "CHENYC01", "created" : "2022-02-22 12:14:59", "ip_address" : "10.0.9.103", "user_name" : "chenyc", "user_group" : "administrators", "sid" : "352cf09d-ee15-4ef1-aa49-8d673972b4e6", "in_maintenance_mode" : true, "share_resource_sku" : "workspace.collaborativedesktop.6party.standard" } ] }

响应示例 状态码： 200 任务明细响应 { "total_count" : 2, "jobs" : [ { "status" : "RUNNING", "entities" : { "user_name" : "user-test-01", "product_id" : "workspace.c2.large.windows", "desktop_id" : "9d30c8ac-77b5-4453-80da-8f027223ee99" }, "job_id" : "0e2dae94-23ff-449a-bb9c-1b808cf2106d", "job_type" : "createDesktops", "begin_time" : "2020-04-10 06:45:14", "end_time" : "2020-04-10 07:06:10", "id" : "e43caef5-e478-4624-9e8c-b0b636331cbc" }, { "status" : "RUNNING", "entities" : { "user_name" : "user-test-01", "product_id" : "workspace.c2.large.windows", "desktop_id" : "14cccba0-12a6-4b66-9fd9-57290328f8da" }, "job_id" : "0e2dae94-23ff-449a-bb9c-1b808cf2106d", "job_type" : "createDesktops", "begin_time" : "2020-04-10 06:45:14", "end_time" : "2020-04-10 07:05:49", "id" : "cf5043e9-dd94-43be-9c07-6dba5d43c4d2" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 任务列表总数。 jobs Array of JobDetailInfo objects 任务列表。 表5 JobDetailInfo 参数 参数类型 描述 id String 任务id。 job_type String 任务类型。 entities JobEntities object Job对象信息。例如：桌面ID、产品ID、用户名。 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String 任务状态。 error_code String 任务执行失败时的错误码。 fail_reason String 任务失败原因。 message String 任务失败原因信息。 job_id String 任务ID。 desktop_name String 桌面名称。 ip_address String ip地址。 mac_address String mac地址。 process Integer 任务进度。 表6 JobEntities 参数 参数类型 描述 desktop_id String 桌面ID。 product_id String 套餐ID。 user_name String 用户名。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v2/{project_id}/workspace-sub-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 任务状态 SUCCESS：成功。 RUNNING：运行中。 FAILED：失败。 WAITING：等待。 job_id 否 String 任务ID。 job_type 否 String 任务类型 createDesktops：创建桌面任务。 applyWorkspace：开通云桌面服务。 cancelWorkspace：注销云桌面服务。 expandVolumes: 扩容磁盘。 addVolumes: 添加磁盘。 desktop_pool_id 否 String 桌面池ID。 limit 否 Integer 用于分页查询，取值范围0~1000，默认1000。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-server-groups { "name" : "APIExplore测试应用服务器组", "image_id" : "", "os_type" : "Windows", "image_type" : "private", "image_product_id" : "00301-2019002-0--0", "description" : "", "route_policy" : { "max_session" : 1 }, "product_id" : "workspace.appstream.general.xlarge.2", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "system_disk_type" : "SATA", "system_disk_size" : 60, "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175", "ip_virtual" : { "enable" : false }, "is_vdi" : false, "availability_zone" : "", "app_type" : "COMMON_APP", "extra_session_type" : "GPU", "extra_session_size" : 1 }

响应示例 状态码： 200 成功响应。 { "id" : "bc05da52-89df-45ba-8146-13fe3ce7c45a", "name" : "ApiExpirezSr5_20230606221433888186", "description" : "", "image_id" : "0fd6c925-6349-49d6-8788-48263b129854", "os_type" : "Windows", "product_id" : "workspace.appstream.general.xlarge.2", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "system_disk_type" : "SATA", "system_disk_size" : 60, "is_vdi" : false, "create_time" : "2023-06-06T14:14:36.416Z", "update_time" : "2023-06-06T14:14:36.416Z", "ou_name" : "", "extra_session_type" : "GPU", "extra_session_size" : 1, "app_type" : "COMMON_APP" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 id String 服务器组的唯一标识。 name String 服务器组名称。 description String 服务器组描述。 image_id String 服务器组关联的镜像ID，用于创建对应组下的云服务器。 os_type String 系统类型，当前仅支持Windows。 Linux - Windows - Other - product_id String 产品id。 subnet_id String 网卡对应的子网ID。 system_disk_type String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO system_disk_size Integer 磁盘容量，单位GB。 is_vdi Boolean 是否为vdi单会话模式。 extra_session_type String 付费会话类型： GPU - GPU规格会话。 CPU - 普通CPU规格会话。 extra_session_size Integer 付费会话个数。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app create_time String 服务器组创建时间 update_time String 服务器组更新时间 storage_mount_policy String 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 USER - 仅挂载个人目录。 SHARE - 仅挂载共享目录。 ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。 app_server_flavor_count Integer 服务器配置总数量。 app_server_count Integer 服务器总数量。 app_group_count Integer 关联应用组的总数量。 image_name String 镜像名称。 product_info ProductInfo object 产品规格信息。 subnet_name String 子网名称。 scaling_policy ScalingPolicy object 弹性伸缩策略。 ou_name String 默认组织名称。 表7 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型： BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 ADVANCED：表示产品高级套餐，套餐镜像中包括了一些商业软件。 architecture String 产品架构，当前仅支持x86。 x86 arm cpu String CPU。 cpu_desc String CPU描述。 memory String 内存大小，单位兆：M。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小。 gpu_desc String GPU描述。 descriptions String 产品描述。 charge_mode String 套餐标识。 1：表示包周期。 0：表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘。 resource_type String 资源类型。 cloud_service_type String 云服务类型。 volume_product_type String 磁盘产品类型。 sessions Integer 套餐默认支持的最大会话数。 status String 产品套餐在销售模式下的状态，取值自ECS的cond:operation:status。 不配置时等同于normal在售状态。 normal - 正常商用 abandon - 下线（即不显示） sellout - 售罄 obt - 公测 obt_sellout - 公测售罄 promotion - 推荐(等同normal，也是商用) cond_operation_az String 产品套餐在可用区的状态，配套status使用。 说明： 此参数是AZ级配置，优选取此参数的值，某个AZ没有在此参数中配置时默认使用status参数的取值。 配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。 例如：套餐在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： “status”设置为：“abandon” 。 “cond_operation_az”设置为：“az0(normal), az1(sellout), az2(obt), az3(normal)”。 说明：如果flavor在某个AZ下的状态与status配置状态不同，必须配置该参数。 sub_product_list Array of strings 专属主机的子产品。 domain_ids Array of strings 产品属于专有的domainId。 package_type String 套餐类型： general：表示产品通用套餐。 dedicated：表示产品专属主机套餐。 expire_time String 产品套餐过期时间，产品将在改时间点后逐步下架。 support_gpu_type String 产品套餐支持的GPU类型。 表8 ScalingPolicy 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表9 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到改阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 服务器组名称，名称需满足如下规则: 由中文，英文大小写，数字，_-组成，不能有空格。 长度范围1~64个字符。 image_id 是 String 服务器组关联的镜像ID，用于创建对应组下的云服务器。 image_product_id 否 String 服务器组的镜像产品ID，当镜像为云市场镜像时，该字段必填。 image_type 是 String 镜像类型： gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他 os_type 是 String 系统类型，当前仅支持Windows。 Linux - Windows - Other - description 否 String 服务器组描述。 route_policy 否 RoutePolicy object 路由策略。 product_id 是 String 产品ID。 说明： 获取方式详见产品套餐管理ListProduct："GET /v1/{project_id}/product"。 vpc_id 是 String 虚拟私有云ID。 subnet_id 是 String 网卡对应的子网ID。 system_disk_type 是 String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO system_disk_size 是 Integer 磁盘容量，单位GB。 ou_name 否 String 默认组织名称。 cluster_id 否 String 云服务器系统盘对应的存储池的ID。 availability_zone 否 String 可用分区。 说明： 将服务创建到指定的可用分区，如果不指定则使用系统随机的可用分区。 获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone"。 ip_virtual 否 IpVirtual object 虚拟IP功能选项。 is_vdi 否 Boolean 是否为vdi单会话模式。 app_type 否 String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app extra_session_type 否 String 付费会话类型： GPU - GPU规格会话。 CPU - 普通CPU规格会话。 extra_session_size 否 Integer 付费会话数，单位/个。 表4 RoutePolicy 参数 是否必选 参数类型 描述 max_session 否 Integer 单台服务器最大的链接会话数。 cpu_threshold 否 Integer cpu使用率阈值，单位为%。 mem_threshold 否 Integer 内存使用率阈值，单位为%。 表5 IpVirtual 参数 是否必选 参数类型 描述 enable 是 Boolean 是否启用虚拟IP功能。 启用虚拟IP功能将占用额外的ip地址，注意合理规划网络ip数量。 约束： 只支持windows镜像。 只支持在创建服务器组时设置功能开关，不支持更新功能开关。 只支持具备dhcp动态分配ip能力的网络。

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-groups/656582710889807872/apps { "items" : [ { "name" : "7-Zip File Manager", "version" : "19.0.0.0", "command_param" : "", "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "work_path" : "", "icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "icon_index" : 0, "description" : "", "publisher" : "Igor Pavlov", "source_image_ids" : [ "5d411710-98ac-47b5-af7c-3ecf6a0514b5" ], "imageInfo" : null, "source_type" : 2 } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of App objects 查发布的应用列表。 表6 App 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 version String 应用版本号。 command_param String 启动命令行参数。 execute_path String 执行路径。 work_path String 应用工作目录。 icon_path String 应用图标的路径。 icon_index Integer 应用图标的索引。 description String 应用描述。 app_group_id String 应用组标识Id。 state String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 tenant_id String 所在的租户ID。 publish_at String 发布时间。 source_type Integer 应用类型： '1':系统内置应用 '2':镜像应用 '3':自定义应用 publisher String 应用发布者。 icon_url String 图标url。 publishable Boolean 是否可发布应用： true: 可发布。 false: 不可发布。 sandbox_enable Boolean 是否使用沙箱模式运行，取值为： false: 表示不以沙箱模式运行。 true: 表示以沙箱模式运行。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 操作成功。 { "count" : 1, "items" : [ { "id" : "656599335839993860", "name" : "7-Zip File Manager", "version" : "19.0.0.0", "command_param" : "", "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "work_path" : "", "icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "icon_index" : 0, "description" : "", "app_group_id" : "656582710889807872", "state" : "NORMAL", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011", "publish_at" : "2024-01-15T08:39:56.265Z", "source_type" : 2, "publisher" : "Igor Pavlov", "sandbox_enable" : false } ] }

响应示例 状态码： 200 成功响应。 { "session_info_list" : [ { "id" : "a7db732e1ad511edaf56fa163ed8e03f", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-1358-zengweilong@wksapp.huawei.com-HDP-_1", "protocol_type" : "Hdp", "login_user" : "zengweilong@wksapp.huawei.com", "session_type" : "1", "pre_conn_time" : "2022-08-13 07:00:20", "start_time" : "2022-08-13 07:00:20", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-124560728-768171367-1358", "session_state" : "AppcInit", "client_mac" : "3c-7c-3f-12-e4-04", "client_name" : "proven", "client_ip" : "10.173.109.239", "client_version" : "22.4.2.12888", "client_type" : "Windows 10 Enterprise", "agent_version" : "21.12.0.11461", "vm_ip" : "172.30.164.26", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" }, { "id" : "9d123d5e0f36419c9b345efcd031a92e", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-3006-zengweilong@wksapp.huawei.com-HDP-2", "os_session_id" : "2", "protocol_type" : "Hdp", "login_user" : "zengweilong@wksapp.huawei.com", "session_type" : "2", "app_group_id" : "587004825166675968", "app_server_group_id" : "fb8a92be-ebc1-4dac-9a4c-1590518d140a", "pre_conn_time" : "2023-07-07 03:04:06", "start_time" : "2023-07-07 03:04:06", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-124560728-768171367-3006", "machine_name" : "APS-6NGU98Y4W4", "session_state" : "AppcInit", "app_name" : "HDTransmission,winlogon,HDTerminalExplorer,slui,HDTerminalAssist,fontdrvhost,TSTheme,ChsIME,ctfmon,csrss,HDTerminalSystem,dwm,ChsIME,sihost,HDTerminalDisplay,TabTip32,svchost,svchost,HDTerminalUser,taskhostw,TabTip", "client_mac" : "3c-7c-3f-12-e4-04", "client_name" : "proven", "client_ip" : "10.173.97.212", "client_version" : "23.2.2.0", "client_type" : "Windows 10 Enterprise", "agent_version" : "23.2.0.0314", "vm_ip" : "172.30.238.41", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 session_info_list Array of AppSession objects 会话信息列表。 表5 AppSession 参数 参数类型 描述 id String 主键ID。 session_stamp String 会话标识。 os_session_id String 会话在hda的os中会话id。 protocol_type String 协议类型。 login_user String 当前会话的登录用户。 session_type String 会话类型，1表示共享桌面，2表示应用。 app_group_id String App组ID。 app_server_group_id String AppServer组ID。 pre_conn_time String 预连接时间。 start_time String 会话开始时间。 end_time String 会话结束时间。 status_continue_time String 状态持续时间。 machine_sid String 服务器SID。。 machine_name String 服务器名称。 session_state String 会话状态。 app_name String 会话中的应用名称。 client_mac String 客户端Mac地址。 client_name String 客户端名称。 client_ip String 客户端IP。 client_version String 客户端版本。 client_type String 客户端类型。 agent_version String agent版本。 vm_ip String 服务器IP。 failed_reason String 错误原因消息。 failed_code String 错误原因码。 last_update_status_time String 状态最后变化时间。 tenant_id String 租户ID 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 415 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求示例 POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/resize { "desktops" : [ { "desktop_id" : "538946c2-7ff8-4444-b1bd-e9a1f8137b81" } ], "product_id" : "workspace.k.xlarge.2.linux", "mode" : "STOP_DESKTOP" }