华为云用户手册

自定义冷热分离数据存储策略 使用clickhouse client客户端命令连接ClickHouseServer节点，具体请参考ClickHouse客户端使用实践。 创建配置冷热存储TTL策略的ReplicatedMergeTree表。 ClickHouse支持表级别的TTL表达式，允许您设置基于时间的规则，从而能够自动的在指定的磁盘或者卷之间移动数据，以实现了数据在不同的存储层之间的分层存储。 具体建表语句参考如下： CREATE TABLE example_table on cluster default_cluster ( d DateTime, a Int ) ENGINE = ReplicatedMergeTree('/clickhouse/tables/{shard}/default/example_table', '{replica}') PARTITION BY toYYYYMM(d) ORDER BY d TTL d + INTERVAL 3 YEAR, d + INTERVAL 1 YEAR TO VOLUME 'cold_obs_volume' SETTINGS storage_policy = 'hot_cold_separation_policy'; 以上示例，加粗部分为TTL配置。该示例将example_table表中d时间列三年后的冷数据删除，d时间列一年后的冷数据转存到OBS。 TTL表达式只是一个简单的SQL表达式，里边包含了时间以及时间的间隔，例如： 数据存活的时间为date_time时间的3天之后。 TTL date_time + INTERVAL 3 DAY 数据存活的时间为date_time时间的1年之后。 TTL date_time + INTERVAL 1 YEAR INTERVAL支持的操作：second，minute，hour，day，week，month，quarter，year。 storage_policy：指定自定义存储策略配置。当前示例为3“_clickhouse.storage_configuration.disks”参数中自定义的策略名。

导入数据ClickHouse测试验证 执行以下命令插入验证数据： insert into example_table values('2023-12-27','10086'); -- hot data insert into example_table values('2023-12-26','10086'); -- hot data insert into example_table values('2022-12-24','10086'); -- cold data insert into example_table values('2022-11-24','10086'); -- cold data insert into example_table values('2018-10-01','10086'); -- deleted data insert into example_table values('2017-10-01','10086'); -- deleted data 查询表数据。 tesspmrB0002.mrs-dviw.com :) select * from example_table FORMAT CS V; SELECT * FROM example_table FORMAT CSV Query id: 3d6bfcb4-f082-4e97-8d95-f885e22ae689 "2023-12-27 00:00:00",10086 "2023-12-26 00:00:00",10086 "2022-11-24 00:00:00",10086 "2022-12-24 00:00:00",10086 4 rows in set. Elapsed: 0.037 sec. 当前系统时间为2024年4月份，根据TTL策略规则example_table表d列为'2018-10-01'和'2017-10-01'的数据已被删除。 执行以下查询hot data和cold data的存储路径。 select name, partition, active, path from system.parts where database = '数据库名' and table= '表名' and active = 1; 图10 冷热数据查询结果 当前系统时间为2024年4月份，example_table表d列为'202211'和'202212'超过一年的数据存储到了名disk_s3的OBS下。

操作场景 ClickHouse基于开源ClickHouse的multi-volume storage特性，允许将ClickHouse表存储在包含多个设备的卷当中。通过在volume中定义不同类型的磁盘，根据数据的“冷”、“热”程度将数据存放在不同类型的磁盘上，即冷数据存储在OBS，热数据存储在ClickHouse中。实现了ClickHouse集群在提供查询性能的同时又能以低成本的方式实现数据的长期存放。 配置ClickHouse数据冷热分离存储的整体流程如下： 创建OBS并行文件系统 创建云服务委托并绑定集群 创建普通账号委托并绑定集群 ClickHouse集群添加OBS磁盘信息 配置磁盘存储策略 自定义冷热分离数据存储策略 导入数据ClickHouse测试验证

使用 CTS 审计 DLI 服务 通过 云审计 服务，您可以记录与DLI服务相关的操作事件，便于日后的查询、审计和回溯。 表1 云审计服务支持的DLI操作列表 操作名称 资源类型 事件名称 创建数据库 database createDatabase 删除数据库 database deleteDatabase 修改数据库所有者 database alterDatabaseOwner 创建表 table createTable 删除表 table deleteTable 导出表数据 table exportData 导入表数据 table importData 修改表的所有者 table alterTableOwner 创建队列 queue createQueue 删除队列 queue deleteQueue 队列授权 queue queueAuthorize 修改队列网段 queue replaceQueue 重启队列 queue queueActions 扩容/缩容队列 queue queueActions 提交作业（SQL） queue submitJob 取消作业（SQL） jobs cancelJob 授权obs桶给DLI服务 obs authorizeObsBucketsForStream 检查SQL语法 jobs checkSQL 删除作业 jobs deleteStreamJob 创建Flink opensource sql作业 jobs createStreamSqlJob 更新Flink opensource sql作业 jobs updateStreamSqlJob 批量删除Flink作业 jobs deleteStreamJobs 停止Flink作业 jobs stopStreamJobs 提交Flink作业 jobs submitStreamJobs 创建Flink jar作业 jobs createStreamJarJob 更新Flink jar作业 jobs updateStreamJarJob 查看flink作业 jobs checkStreamJob 导入保存点 jobs dealSavepoint 购买cu时套餐包 order orderPackage 数据授权 authorization dataAuthorize 跨项目数据授权 authorization projectDataAuthorize 导出查询结果 jobs storeJobResult 保存SQL模板 template createTemplate 更新SQL模板 template updateTemplate 删除SQL模板 template deleteTemplates 新建Flink模板 template createStreamTemplate 更新Flink模板 template updateStreamTemplate 查看Flink模板 template checkStreamTemplate 删除Flink模板 template deleteStreamTemplate 创建认证信息并上传证书 datasourceauth uploadAuthInfo 更新跨源认证信息 datasourceauth updateAuthInfo 删除跨源认证信息 datasourceauth deleteAuthInfo 上传资源包 resource uploadResources 删除资源包 resource deleteResource 创建增强型跨源连接 edsconnection createConnection 删除增强型跨源连接 edsconnection deleteConnection 创建经典型跨源连接 edsconnection createConnection 删除经典型跨源连接 edsconnection deleteConnection 绑定队列 edsconnection associateQueueToConnection 解绑队列 edsconnection disassociateQueueToConnection 修改主机信息 edsconnection updateHostInfo 添加路由 edsconnection addRoute 删除路由 edsconnection deleteRoute 创建批处理作业 jobs createBatch 取消批处理作业 jobs cancelBatch 创建全局变量 variable createGlobalVariable 删除全局变量 variable deleteGlobalVariable 修改全局变量 variable updateGlobalVariable 关于如何开通云审计服务以及如何查看追踪事件，请参考《云审计服务快速入门》中的相关章节。 关于云审计服务事件结构的关键字段详解，请参见《云审计服务用户指南》中的事件结构和事件样例。

Lite Server使用流程 ModelArts Lite Server提供多样化的xPU裸金属服务器，赋予用户以root账号自主安装和部署AI框架、应用程序等第三方软件的能力，为用户打造专属的云上物理服务器环境。用户只需轻松选择服务器的规格、镜像、网络配置及密钥等基本信息，即可迅速创建弹性裸金属服务器，获取所需的云上物理资源，充分满足算法工程师在日常训练和推理工作中的需求。 本文旨在帮助您了解Lite Server的基本使用流程，帮助您快速上手，使用流程包含以下步骤。 图1 使用流程 资源开通 由于Server为一台裸金属服务器，因此需要先购买资源后才能使用。 首先请联系客户经理确认Server资源方案，部分规格为受限规格，因此需要申请开通您所需的资源规格。 Server所需资源可能会超出华为云默认提供的资源配额（如ECS、EIP、SFS），因此需要提交工单提升资源配额。 为子用户账号开通Server功能所需的基础权限。 由于ModelArts服务在使用过程中会访问其他依赖服务，因此需要给ModelArts进行委托授权。 购买Server资源时，需要选择虚拟私有云用于网络通信，您可以使用已有的虚拟私有云或新创建的虚拟私有云。 若使用密钥对作为登录裸金属服务器的鉴权方式，您可以使用已有的密钥对或新创建的密钥对。 在ModelArts控制台购买Server资源。 资源配置 完成资源购买后，需要对网络、存储、软件环境进行相关配置。 资源使用 完成资源配置后，您可以登录到服务器进行训练和推理，具体案例可参考Lite Server资源使用。 资源管理 Lite Server提供启动、停止、切换操作系统等管理手段，您可在ModelArts控制台上对资源进行管理。 表1 相关名词解释 名词 含义 裸金属服务器 裸金属服务器是一款兼具虚拟机弹性和物理机性能的计算类服务，为您和您的企业提供专属的云上物理服务器，为核心数据库、关键应用系统、高性能计算、大数据等业务提供卓越的计算性能以及数据安全。 由于Server是一台裸金属服务器，在ModelArts管理控制台购买Server后，会在BMS管理控制台上创建一台与Server对应的裸金属服务器，后续挂载磁盘、绑定弹性网络IP等操作可在BMS服务控制台上完成。 更多裸金属服务器的介绍请见虚拟私有云 VPC。 xPU xPU泛指GPU和NPU。 GPU，即图形处理器，主要用于加速深度学习模型的训练和推理。 NPU，即神经网络处理器，是专门为加速神经网络计算而设计的硬件。与GPU相比，NPU在神经网络计算方面具有更高的效率和更低的功耗。 密钥对 弹性裸金属支持SSH密钥对的方式进行登录，用户无需输入密码就可以登录到弹性裸金属服务器，因此可以防止由于密码被拦截、破解造成的账户密码泄露，从而提高弹性裸金属服务器的安全性。 说明： 为保证云服务器安全，未进行私钥托管的私钥只能下载一次，请妥善保管。 虚拟私有云 虚拟私有云（Virtual Private Cloud，VPC）为裸金属服务器构建隔离的、用户自主配置和管理的虚拟网络环境，提升用户云中资源的安全性，简化用户的网络部署。您可以在VPC中定义安全组、VPN、IP地址段、带宽等网络特性。用户可以通过VPC方便地管理、配置内部网络，进行安全、快捷的网络变更。同时，用户可以自定义安全组内与组间的访问规则，加强裸金属服务器的安全保护。更多VPC介绍请见虚拟私有云 VPC。 父主题： Lite Server使用前必读

步骤3：基础权限开通 基础权限开通需要登录管理员账号，为子用户账号开通Server功能所需的基础权限（ModelArts FullAccess/BMS FullAccess/ECS FullAccess/VPC FullAccess/VPC Administrator/VPCEndpoint Administrator）。 登录 统一身份认证 服务管理控制台。 单击目录左侧“用户组”，然后在页面右上角单击“创建用户组”。 填写“用户组名称”并单击“确定”。 在操作列单击“用户组管理”，将需要配置权限的用户加入用户组中。 单击用户组名称，进入用户组详情页。 在权限管理页签下，单击“授权”。 图2 “配置权限” 在搜索栏输入“ModelArts FullAccess”，并勾选“ModelArts FullAccess”。 图3 ModelArts FullAccess 以相同的方式，依次添加：BMS FullAccess、ECS FullAccess、VPC FullAccess、VPC Administrator、VPCEndpoint Administrator。（Server Administrator、DNS Administrator为依赖策略，会自动被勾选）。 单击“下一步”，授权范围方案选择“所有资源”。 单击“确认”，完成基础权限开通。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result_list Array of DeleteTerminalsBindingDesktopsResult objects 需删除的策略ID列表 表5 DeleteTerminalsBindingDesktopsResult 参数 参数类型 描述 id String 需删除的策略ID delete_result_code String 删除操作的结果码 delete_result_msg String 删除操作的结果信息 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 id_list 否 Array of strings 绑定策略ID列表

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 users Array of UserInGroup objects 组关联的用户列表。 total_count Integer 用户列表中用户总数。 表5 UserInGroup 参数 参数类型 描述 id String 用户ID。 user_name String 桌面用户名。 user_email String 用户邮箱。 user_phone String 用户手机号。 total_desktops Integer 用户桌面数。 description String 用户描述。

响应示例 状态码： 200 组关联的用户列表响应。 { "total_count" : 2, "users" : [ { "user_name" : "user1", "user_email" : "xx1@mail.com", "user_phone" : "18818008887", "id" : "8357fd328c62447d94e452bf49xxxx" }, { "user_name" : "user2", "user_email" : "xx2@mail.com", "user_phone" : "18818008888", "id" : "8357fd328c62447d94e452bf495xxxx" } ] }

URI GET /v2/{project_id}/groups/{group_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 group_id 是 String 用户组ID。 表2 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名支持模糊查询。 description 否 String 用户描述支持模糊查询。 active_type 否 String 激活类型。 USER_ACTIVATE：用户激活 ADMIN_ACTIVATE：管理员激活 limit 否 String 用于分页查询，返回桌面数量限制。如果不指定或为0，默认2000，最大2000。 offset 否 String 用于分页查询，查询的起始记录序号，从0开始。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 用户组名称。 platform_type 是 String 用户组类型。 AD： AD域用户组 LOCAL： 本地liteAs用户组 description 否 String 用户组描述。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 策略id mac 是 String 终端MAC地址 desktop_name 是 String 虚拟机名称 description 否 String 描述

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 desktop_used_info_list Array of DesktopUsedHoursInfo objects 桌面使用信息（以桌面Id划分）。 total_count Integer 总数。 表5 DesktopUsedHoursInfo 参数 参数类型 描述 desktop_id String 桌面Id。 desktop_username String 使用的用户。 used_info_list Array of DesktopUsedInfo objects 桌面使用时间列表。 表6 DesktopUsedInfo 参数 参数类型 描述 date String 日期，格式：yyyy-MM-dd（UTC时间）。 use_time String 总共在线时间单位:小时数（h）,精确到两位小数，如：1.32。 状态码： default 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 查询使用桌面的时长响应。 { "desktop_used_info_list" : [ { "desktop_id" : "c6e6dbd7-c950-471d-a6a7-01d0fb62f450", "used_info_list" : [ { "date" : "2022-12-09", "use_time" : 12.62 }, { "date" : "2022-12-10", "use_time" : 2.62 }, { "date" : "2022-12-11", "use_time" : 1.02 }, { "date" : "2022-12-12", "use_time" : 0 }, { "date" : "2022-12-13", "use_time" : 0 }, { "date" : "2022-12-14", "use_time" : 3.87 }, { "date" : "2022-12-15", "use_time" : 3.56 } ] }, { "desktop_id" : "d5367f84-1d64-498e-9b92-093002ac6ce9", "used_info_list" : [ { "date" : "2022-12-09", "use_time" : 10.56 }, { "date" : "2022-12-10", "use_time" : 1.38 }, { "date" : "2022-12-11", "use_time" : 0 }, { "date" : "2022-12-12", "use_time" : 0 }, { "date" : "2022-12-13", "use_time" : 0 }, { "date" : "2022-12-14", "use_time" : 3.87 }, { "date" : "2022-12-15", "use_time" : 3.56 } ] } ], "total_count" : 2 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 桌面id集合。 start_time 否 String 开始时间，格式：yyyy-MM-dd（UTC时间，不传查默认最近15天）最多查31天数据。 end_time 否 String 结束时间，格式：yyyy-MM-dd（UTC时间，不传查默认最近15天）最多查31天数据。 group_by_type 否 String 统计方式，不传则默认按天。可选值为： DAY: 按天。 HOUR: 按小时。 desktop_username 否 String 若传桌面的用户名，则查询使用时间只有该用户的使用时间。 offset 否 Integer 从查询结果中的第几条数据开始返回,用于分页查询，取值范围0-2147483647，默认从0开始。 limit 否 Integer 查询结果中想要返回的信息条目数量,用于分页查询，取值范围0-100，默认值100。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 otp_config_info OtpConfigInfo object OTP辅助认证方式配置 表4 OtpConfigInfo 参数 参数类型 描述 enable Boolean 是否启用 receive_mode String 验证码接收模式 VMFA：虚拟MFA设备 HMFA：硬件MFA设备 auth_url String 辅助认证服务器地址 app_id String 认证服务接入账号 app_secret String 认证服务接入密码 auth_server_access_mode String 辅助认证服务接入模式 INTERNET：互联网接入 DEDICATED：专线接入 SYSTEM_DEFAULT：系统默认 cert_content String pem格式证书内容 apply_rule ApplyRuleInfo object 认证应用对象信息，为null时代表对所有应用对象生效。 表5 ApplyRuleInfo 参数 参数类型 描述 rule_type String 认证应用对象类型。 AC CES S_MODE：接入类型 rule String 认证应用对象。 INTERNET：互联网接入，rule_type为ACCESS_MODE时可选该值 PRIVATE：专线接入，rule_type为ACCESS_MODE时可选该值 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 password String 密码。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/users/{user_id}/random-password 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 user_id 是 String 用户ID。 表2 Query参数 参数 是否必选 参数类型 描述 notification_type 否 String 通知用户类型，现在有“email”和“phone”两种，用","分开，用户为用户激活模式时必须要带上通知类型，以便接收到密码通知。

修订记录 发布日期 修订记录 2024-12-12 第二十五次正式发布。 新增： 协同配置 协同配置 桌面名称策略 磁盘 连接信息 产品套餐 报表统计 任务 终端与桌面绑定 2024-09-05 第二十四次正式发布。 新增： 应用仓库管理 镜像管理 获取VNC远程登录地址 2024-03-20 第二十三次正式发布。 新增： 解绑用户 分配用户 配额 可用分区 2024-01-11 第二十二次正式发布。 新增： 桌面池。 2023-12-18 第二十一次正式发布。 修改： 批量注销桌面接口中的请求示例。 2023-11-29 第二十次正式发布。 修改： 设置终端与桌面绑定的开关配置接口中tc_bind_switch参数的描述。 2023-11-16 第十九次发布。 新增： 批量添加多个桌面标签。 批量删除多个桌面标签。 2023-11-10 第十八次正式发布。 新增： 查询桌面网络。 2023-11-06 第十七次正式发布。 新增： 重建桌面。 2023-10-09 第十六次正式发布。 新增： 订单。 2023-09-15 第十五次正式发布。 新增： 切换桌面网络。 2023-07-04 第十四次正式发布。 新增： 批量注销桌面、查询在指定时间段未使用的桌面、查询使用桌面的时长、查询用户列表、创建用户组、批量删除用户组、删除用户组、修改用户组信息、操作用户组、查询用户组中的用户接口。 2023-06-20 第十三次正式发布。 新增： 云应用APIAPI参考指导。 云应用错误码。 2023-06-06 第十二次正式发布。 修改： 创建桌面章节中email_notification参数的描述。 2022-12-23 第十一次正式发布。 修改： 策略组下各接口新增请求及响应示例。 2022-12-20 第十次正式发布。 新增： 组织单元。 2022-12-08 第九次正式发布。 修改： 云办公服务中新增查询云办公服务是否被锁定、解除云办公服务锁定状态接口。 新增 查询OTP设备、解绑OTP设备接口。 删除桌面数据盘接口。 桌面名称策略。 用户组。 策略组。 2022-11-29 第八次正式发布。 修改： 终端节点中新增“西南-贵阳一”和“拉美-圣地亚哥”的终端节点信息。 2022-11-17 第七次正式发布。 删除： 删除“历史API”节点。 2022-11-14 第六次正式发布。 修改： 根据产品规划调整增加桌面磁盘中新增磁盘参数名称，由“addDesktopVolumesReq”变更为“desktop_volumes”。 根据产品规划调整扩容桌面磁盘中扩容磁盘参数名称，由“expandVolumesReq”变更为“desktop_volumes_expansion”。 优化创建用户和查询用户详情信息中时间格式。 新增： 新增“历史API”节点。将原参数名称的“增加桌面磁盘”、“扩容桌面磁盘”API接口归档至历史API节点下。 新增操作用户接口。 2022-10-27 第五次正式发布。 修改： 优化 云桌面 错误码。 2022-09-29 第四次正式发布。 修改： 优化查询产品套餐列表和查询可用分区列表参数描述。 优化云桌面错误码。 2022-09-15 第三次正式发布。 修改： 优化桌面中的示例。 2022-09-02 第二次正式发布。 新增： 变更规格。 2022-08-27 第一次正式发布。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 桌面id,不能为空 shutoff_after_detach 否 Boolean 解绑后是否关机。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 failed_operation_list Array of VmOperateResult objects 操作失败桌面列表 job_id String 任务ID 表5 VmOperateResult 参数 参数类型 描述 desktop_id String 桌面ID。 desktop_name String 桌面名称。 error_code String 操作失败的错误码。 error_msg String 操作失败的原因描述。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/desktops/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 桌面状态。 ACTIVE：运行中。 SHUTOFF：关机。 ERROR：异常。 HIBERNATED：休眠。 user_name 否 String 桌面所属用户，当传user_names时，本字段不生效。 user_names 否 Array of strings 桌面所属用户，批量筛选，最多不超过100个用户。 sort_field 否 String 排序字段名称，需要结合sort_type字段一起使用。 created 创建时间。 computer_name 桌面名称。 sort_type 否 String 排序类型，默认升序，需要结合sort_field字段一起使用。 ASC 升序。 DESC 降序。 computer_name 否 String 桌面名。 desktop_ip 否 String 桌面IP地址。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，取值范围0-500，默认值500。 desktop_id 否 Array of strings 桌面ID。 desktop_type 否 String 桌面类型，为空时查所有桌面。 DEDICATED：普通桌面，包括专享桌面、专属桌面等 POOLED：池桌面，即桌面池里的桌面 tag 否 String 桌面的标签。样例： key1=value1。 key1=value1，key2=value2。 pool_id 否 String 桌面池ID,多个桌面池ID用逗号隔开。 user_attached 否 Boolean 是否分配了用户。 enterprise_project_id 否 String 企业项目ID image_id 否 String 镜像ID charge_mode 否 String 计费模式，0：包周期，1：按需。 in_maintenance_mode 否 Boolean 按照维护模式过滤 is_share_desktop 否 Boolean 是否为协同桌面 subnet_id 否 String 桌面的子网ID。 is_support_internet 否 Boolean 是否支持上网。 availability_zone 否 String 查询可用区

响应示例 状态码： 200 查询云桌面详情列表响应。 { "desktops" : [ { "desktop_id" : "21616aa6-061d-4b2f-bd83-b230d7a9a14c", "computer_name" : "CHENMIN01", "addresses" : [ { "addr" : "172.16.253.204", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:2e:41:55", "OS-EXT-IPS:type" : "fixed" }, { "addr" : "10.0.9.55", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:d5:b3:02", "OS-EXT-IPS:type" : "fixed" } ], "ip_addresses" : [ "172.16.253.204", "10.0.9.55" ], "desktop_type" : "DEDICATED", "metadata" : { "image_name" : "copy_uos-hjg1", "metering.resourcespeccode" : "rs3.large.2.linux", "charging_mode" : "0", "metering.image_id" : "39efed30-a0db-4520-8134-19a086e14c7e", "metering.resourcetype" : "1", "os_type" : "Linux", "os_bit" : "64", "desktop_os_version" : "20" }, "flavor" : { "id" : "rs3.large.2", "links" : [ ] }, "status" : "ACTIVE", "task_status" : "", "created" : "2022-01-21T06:57:47.459Z", "login_status" : "REGISTERED", "user_name" : "chenmin", "product_id" : "workspace.k.large2.uosv20pro", "share_resource_sku" : "workspace.collaborativedesktop.6party.standard", "root_volume" : { "type" : "SAS", "size" : 90, "device" : "/dev/vda", "id" : "e4406c227a8711ecaf56fa163ed8e03f", "volume_id" : "91b9457c-ef61-4058-9e82-c86b35f15934", "create_time" : "2022-03-28T00:00:00Z", "display_name" : "workspace002" }, "data_volumes" : [ { "type" : "SATA", "size" : 10, "device" : "/dev/vdc", "id" : "fd4597cb80b311ecaf56fa163ed8e03f", "volume_id" : "230432f1-44a4-47a1-862e-cd0b65c04bd1", "create_time" : "2022-03-28T00:00:00Z", "display_name" : "workspace001" } ], "user_group" : "default", "availability_zone" : "cn-north-5a", "site_type" : "IES", "site_name" : "边缘小站", "product" : { "product_id" : "workspace.k.large2.uosv20pro", "flavor_id" : "rs3.large.2", "type" : "BASE", "cpu" : "2", "memory" : "3072", "descriptions" : "CPU:2vCPUs,Memory:4GB", "charge_mode" : "0" }, "os_version" : "20", "sid" : "1f60adc1-941c-48b8-b5c8-64948329b7cb", "order_id" : "CS2201211457G0PUY", "tags" : [ ], "in_maintenance_mode" : false }, { "desktop_id" : "e7a27bad-323f-4ec8-9afe-e53d00171ba9", "computer_name" : "HJG01", "addresses" : [ { "addr" : "172.16.242.253", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:20:14:00", "OS-EXT-IPS:type" : "fixed" }, { "addr" : "10.0.5.247", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:29:c4:3f", "OS-EXT-IPS:type" : "fixed" } ], "ip_addresses" : [ "172.16.242.253", "10.0.5.247" ], "desktop_type" : "DEDICATED", "metadata" : { "image_name" : "UOS_20_PRO_chenmin", "metering.resourcespeccode" : "rs3.xlarge.2.linux", "charging_mode" : "0", "metering.image_id" : "6fe1cd9e-e997-4c02-8257-395c28de49b3", "metering.resourcetype" : "1", "os_type" : "Linux", "os_bit" : "64", "desktop_os_version" : "20" }, "flavor" : { "id" : "rs3.xlarge.2", "links" : [ ] }, "status" : "ACTIVE", "task_status" : "", "created" : "2022-01-18T07:53:25.815Z", "login_status" : "REGISTERED", "user_name" : "hjg", "product_id" : "workspace.k.large4.uosv20pro", "root_volume" : { "type" : "SAS", "size" : 80, "device" : "/dev/vda", "id" : "1791c183783411ecaf56fa163ed8e03f", "volume_id" : "703b49d6-794e-4474-a256-fb695fb46466" }, "user_group" : "sudo", "availability_zone" : "cn-north-5a", "site_type" : "CENTER", "site_name" : "北京四中心站", "product" : { "product_id" : "workspace.k.large4.uosv20pro", "flavor_id" : "rs3.xlarge.2", "type" : "BASE", "cpu" : "4", "memory" : "7168", "descriptions" : "CPU:4vCPUs,Memory:7GB", "charge_mode" : "0" }, "os_version" : "20", "sid" : "3f5cdbd5-9652-4339-9aab-70d0644f8abc", "order_id" : "CS220118155365RYV", "tags" : [ ], "in_maintenance_mode" : true } ], "total_count" : 2 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_name 是 String 策略名称，由数字、字母、中文、下划线组成，必须以字母或下划线开头，长度范围为1~30个字符。 name_prefix 是 String 策略前缀。 digit_number 是 Integer 策略后缀有效位数。 start_number 是 Integer 策略后缀起始数字。 single_domain_user_inc 是 Integer 是否单用户名递增。 1 单用户名递增。 0 租户递增。 is_default_policy 否 Boolean 是否为默认策略，true默认策略。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policy_id String 策略id。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK既可以使用永久访问密钥中的AK/SK，也可以使用临时访问密钥中的AK/SK，但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段，字段值为临时访问密钥的security_token。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。 您也可以通过这个视频教程了解AK/SK认证的使用：https://bbs.huaweicloud.com/videos/100697 。