华为云用户手册

支持的消息类型 分布式消息服务RocketMQ版支持4种消息类型。 普通消息：没有特殊功能的消息，区别于延迟消息、顺序消息和事务消息。 延迟消息/定时消息：生产者生产消息到分布式消息服务RocketMQ版后，消息不会立即被消费，而是延迟到特定时间后才会发送给消费者进行消费。 顺序消息：消费者按照消息发送的顺序来消费消息。 事务消息：提供类似X/Open XA的分布事务功能，通过事务消息能达到分布式事务的最终一致。

支持的高级特性 分布式消息服务RocketMQ版支持4种高级特性。 消息过滤：消费者根据分布式消息服务RocketMQ版设置的标签对已订阅Topic中的消息进行过滤，达到只消费需要的消息的目的。 消息重试：消费者消费某条消息失败后，分布式消息服务RocketMQ版根据重试机制将消息重新发送给消费者进行消费。如果重试次数到达设定的最大值时，消息尚未被成功消费，此消息将被发送到死信队列。 分布式消息服务RocketMQ版的重试机制如表1所示。 表1 消息重试机制 消费类型 重试时间间隔 最大重试次数 顺序消费 通过suspendTimeMillis设置重试时间间隔。 默认值为1000ms，即1s。 通过消费者的setMaxReconsumeTimes函数配置最大重试次数。若未设置参数值，默认为无限重试。 普通消费 重试时间间隔根据重试次数阶梯变化，如表2所示。 创建消费组时设置。 取值范围：1-16。 表2 普通消费重试时间间隔 重试次数 与上次的间隔时间 重试次数 与上次的间隔时间 1 10s 9 7min 2 30s 10 8min 3 1min 11 9min 4 2min 12 10min 5 3min 13 20min 6 4min 14 30min 7 5min 15 1h 8 6min 16 2h 延时消息：生产者生产消息到分布式消息服务RocketMQ版后，消息不会立即被消费，而是延迟固定时间后才会发送给消费者进行消费。生产者可以指定18个延时等级，每个延时等级对应的时间如表3所示。 表3 延时等级 延时等级 延时时间 延时等级 延时时间 1 1s 10 6min 2 5s 11 7min 3 10s 12 8min 4 30s 13 9min 5 1min 14 10min 6 2min 15 20min 7 3min 16 30min 8 4min 17 1h 9 5min 18 2h 定时消息：生产者生产消息到分布式消息服务RocketMQ版后，消息不会立即被消费，而是延迟到设定的时间点后才会发送给消费者进行消费。分布式消息服务RocketMQ版支持任意时间的定时消息，最大推迟时间可达到1年。同时也支持定时消息的取消。 2022年3月30日及以后购买的实例支持定时消息功能，在此之前购买的实例不支持此功能。

身份认证 无论用户通过控制台还是API访问DMS for RocketMQ，都会要求访问请求方出示身份凭证，并进行身份合法性校验，同时提供登录保护和登录验证策略加固身份认证安全。DMS for RocketMQ基于统一身份认证服务（Identity and Access Management，简称IAM），支持三种身份认证方式：用户名密码、访问密钥、临时访问密钥。同时还提供登录保护及登录验证策略。

数据保护技术 DMS for RocketMQ通过多种数据保护手段和特性，保障DMS for RocketMQ的数据安全可靠。 表1 DMS for RocketMQ的数据保护手段和特性 数据保护手段 简要说明 详细介绍 容灾和多活 根据对数据与服务的不同可靠性要求，您可以选择在单可用区内（单机房）部署RocketMQ实例，或跨可用区（同城灾备）部署。 在单可用区或多可用区中部署实例 副本冗余 使用一主两备架构，备节点通过数据同步的方式保持数据一致。当网络发生异常或节点故障时，通过Raft协议自动切换主备关系，保持数据一致性。 - 数据持久化 业务系统日常运行中可能出现一些小概率的异常事件。部分可靠性要求非常高的业务系统，除了要求实例高可用，还要求数据安全、可恢复，以便在实例发生异常后能够使用备份数据进行恢复，保障业务正常运行。 - 父主题： 安全

产品优势 分布式消息服务RocketMQ版具有如下产品优势，旨在打造一个即开即用、全托管、低延迟、弹性高可靠、动态扩展、便捷管理和多样功能的消息队列。 即开即用：简单几步即可在云上构建自己专属的消息服务，RocketMQ实例创建完成后，使用实例提供的访问地址即可快速接入。兼容开源RocketMQ，业务代码无需改造，即可上云。 全托管服务：分布式消息服务RocketMQ版提供自动部署与完备的运维系统和售后服务，提供包括监控告警在内的多种运维手段，业务无需过多关注分布式消息服务RocketMQ版的部署与运维工作，可以专注于自身业务的开发。 低延迟：基于华为云网络部署，在内网访问可达微秒级时延。 弹性高可靠：基于Raft协议实现集群内部节点的管理，及时发现故障节点并进行流量迁移，保证业务的连续性可靠。 动态扩展：提供业务集群动态扩容的能力，根据业务需要动态扩容集群规模。 便捷管理：提供监控告警、消息追踪和链路诊断等多样的监控定位手段，方便问题定位和日常维护。 多样功能：提供顺序延迟、定时、重投、死信、过滤和事务消息等多样的业务功能，适配多样化的业务场景。

系统解耦 以电商秒杀、抢购等流量短时间内暴增场景为例，传统做法是，用户下单后，订单系统发送查询请求到库存系统，等待库存系统返回请求结果给订单系统。如果库存系统发生故障，订单系统获取不到数据，订单失败。这种情况下，订单系统和库存系统两个子系统高耦合。 图4 系统高耦合 引入RabbitMQ消息队列，当用户下单后，将消息写入到RabbitMQ消息队列中，然后返回用户下单成功。 库存系统订阅下单的消息，消费下单消息，然后进行库操作。即使库存系统出现故障，也不影响用户下单。 图5 系统解耦

高可用 普通队列，由于队列以及队列内容仅存储在单代理上，当该代理故障后，对应的队列不可用。 RabbitMQ引入镜像队列机制，镜像队列是开源RabbitMQ 2.6.0版本新增的一个功能，允许集群将队列镜像到其他代理上，当集群某一代理宕机后，队列能自动切换到镜像中的其他代理，保证服务的可用性。 RabbitMQ引入仲裁队列机制，仲裁队列是开源RabbitMQ 3.8版本新增的一个功能，提供队列复制的能力，当集群某一代理宕机后，队列依旧可以正常运行，保证服务的可用性。

错峰流控与流量削峰 在电子商务系统或大型网站中，上下游系统处理能力存在差异，处理能力高的上游系统的突发流量可能会对处理能力低的某些下游系统造成冲击，需要提高系统的可用性的同时降低系统实现的复杂性。电商大促销等流量洪流突然来袭时，可以通过队列服务堆积缓存订单等信息，在下游系统有能力处理消息的时候再处理，避免下游订阅系统因突发流量崩溃。消息队列提供亿级消息堆积能力，3天的默认保留时长，消息消费系统可以错峰进行消息处理。 另外，在商品秒杀、抢购等流量短时间内暴增场景中，为了防止后端应用被压垮，可在前后端系统间使用RabbitMQ消息队列传递请求。 图3 消息队列应对秒杀大流量场景

异步通信 将业务中属于非核心或不重要的流程部分，使用消息异步通知的方式发给目标系统，这样主业务流程无需同步等待其他系统的处理结果，从而达到系统快速响应的目的。 如网站的用户注册场景，在用户注册成功后，还需要发送注册邮件与注册短信，这两个流程使用RabbitMQ消息服务通知邮件发送系统与短信发送系统，从而提升注册流程的响应速度。 图1 串行发送注册邮件与短信流程 图2 借助消息队列异步发送注册邮件与短信流程

产品优势 华为云分布式消息服务RabbitMQ版完全兼容开源社区版本，旨在为您提供便捷高效的消息队列。业务无需改动即可快速迁移上云，为您节省维护和使用成本。 一键式部署，免去集群搭建烦恼 只需要在实例管理界面选好规格配置，提交订单，后台将自动创建部署完成一整套RabbitMQ实例。 兼容开源，业务零改动迁移上云 兼容社区版RabbitMQ的API，具备原生RabbitMQ的所有消息处理特性。 业务系统基于开源的RabbitMQ进行开发，只需加入少量认证安全配置，即可使用华为云分布式消息服务RabbitMQ版，做到无缝迁移。 RabbitMQ实例兼容开源社区RabbitMQ 3.8.35版本。 独占式体验 RabbitMQ实例采用物理隔离的方式部署，租户独占RabbitMQ实例，每个RabbitMQ之间互不影响。 高性能 单队列性能最高可达10万TPS（默认配置），增加队列可获得更高性能。 数据安全 独有的安全加固体系，提供业务操作云端审计，消息存储加密等有效安全措施。 在网络通信方面，除了提供SSL认证，还借助虚拟私有云（VPC）和安全组等加强网络访问控制。 无忧运维 华为云提供一整套完整的监控告警等运维服务，故障自动发现和告警，避免7*24小时人工值守。RabbitMQ实例自动上报相关监控指标，如分区数、主题数、堆积消息数等，并支持配置监控数据发送规则，您可以在第一时间通过短信、邮件等获得业务消息队列的运行使用和负载状态。 支持多语言客户端 RabbitMQ是一款基于AMQP协议的开源服务，用于在分布式系统中存储转发消息，服务器端用Erlang语言（支持高并发、分布式以及健壮的容错能力等特点）编写，支持多种语言的客户端，如：Python、Ruby、.NET、Java、JMS、C、PHP、ActionScript、XMPP、STOMP和AJAX等。

计费项 华为云分布式消息服务RabbitMQ版对您选择的RabbitMQ实例和RabbitMQ存储收费。RabbitMQ实例规格当前存在2种，一种为除拉美-墨西哥城一以外区域显示的规格，另一种为拉美-墨西哥城一区域显示的规格。 表1 RabbitMQ服务计费项 计费项 计费说明 实例 对您选择的实例规格计费，具体请参见表2和表3。 实例提供包年包月和按需（小时）计费方式。 存储 对您选择的实例存储空间计费（每个实例规格您都可以选择高IO和超高IO两种不同的云硬盘类型以满足您的业务需求）。 实例存储可选择不同副本，如：实际队列容量为100GB，3副本，则应购买100GB*3=300GB存储容量。 存储空间范围见表2和表3，步长100G。 实例存储提供包年包月和按需（小时）计费方式。 表2 RabbitMQ实例规格（拉美-墨西哥城一区域） 型号 代理数 存储空间范围 TPS参考值 单个代理最大消费者数 2U4G 1 1*100GB~90000GB 10000 20000 4U8G 1 1*100GB~90000GB 20000 30000 8U16G 1 1*100GB~90000GB 35000 50000 16U32G 1 1*100GB~90000GB 45000 80000 4U8G 3 3*100GB~90000GB 45000 30000 4U8G 5 5*100GB~90000GB 70000 30000 4U8G 7 7*100GB~90000GB 80000 30000 8U16G 3 3*100GB~90000GB 85000 50000 8U16G 5 5*100GB~90000GB 110000 50000 8U16G 7 7*100GB~90000GB 120000 50000 16U32G 3 3*100GB~90000GB 130000 80000 16U32G 5 5*100GB~90000GB 160000 80000 16U32G 7 7*100GB~90000GB 180000 80000 表3 RabbitMQ实例规格 型号 代理数 存储空间范围 TPS参考值 单个代理最大消费者数 单个代理建议队列数 单个代理最大连接数 rabbitmq.2u4g.single 1 100GB~30000GB 10000 20000 200 3000 rabbitmq.4u8g.single 1 100GB~30000GB 20000 30000 400 4500 rabbitmq.8u16g.single 1 100GB~30000GB 35000 50000 800 7500 rabbitmq.16u32g.single 1 100GB~30000GB 45000 80000 1600 12000 rabbitmq.24u48g.single 1 100GB~30000GB 50000 100000 2400 15000 rabbitmq.2u4g.cluster 3/5/7 3/5/7*100GB~30000GB 30000~70000 20000 200 3000 rabbitmq.4u8g.cluster 3/5/7 3/5/7*100GB~30000GB 45000~80000 30000 400 4500 rabbitmq.8u16g.cluster 3/5/7 3/5/7*100GB~30000GB 85000~120000 50000 800 7500 rabbitmq.12u24g.cluster 3/5/7 3/5/7*100GB~30000GB 100000~150000 60000 1200 10000 rabbitmq.16u32g.cluster 3/5/7 3/5/7*100GB~30000GB 130000~180000 80000 1600 12000 rabbitmq.24u48g.cluster 3/5/7 3/5/7*100GB~30000GB 150000~200000 100000 2400 15000

新老规格对应关系 2种RabbitMQ实例规格的对应关系如表4所示。 表4 RabbitMQ实例新老规格对应关系 老规格 TPS（老规格） 对应的新规格 TPS（新规格） 2U4G*1 10000 rabbitmq.2u4g.single*1 10000 4U8G*1 20000 rabbitmq.4u8g.single*1 20000 8U16G*1 35000 rabbitmq.8u16g.single*1 35000 16U32G*1 45000 rabbitmq.16u32g.single*1 45000 4U8G*3 45000 rabbitmq.4u8g.cluster*3 45000 4U8G*5 70000 rabbitmq.4u8g.cluster*5 70000 4U8G*7 80000 rabbitmq.4u8g.cluster*7 80000 8U16G*3 85000 rabbitmq.8u16g.cluster*3 85000 8U16G*5 110000 rabbitmq.8u16g.cluster*5 110000 8U16G*7 120000 rabbitmq.8u16g.cluster*7 120000 16U32G*3 130000 rabbitmq.16u32g.cluster*3 130000 16U32G*5 160000 rabbitmq.16u32g.cluster*5 160000 16U32G*7 180000 rabbitmq.16u32g.cluster*7 180000 例如：客户业务实际TPS为10000，考虑到峰值流量比平时流量多，假设预留30%的流量，建议选择rabbitmq.4u8g.single*1的实例规格。如果业务要求高可用，建议使用rabbitmq.4u8g.cluster*3的实例规格。

数据保护技术 DMS for RabbitMQ通过多种数据保护手段和特性，保障DMS for RabbitMQ的数据安全可靠。 表1 DMS for RabbitMQ的数据保护手段和特性 数据保护手段 简要说明 详细介绍 容灾和多活 根据对数据与服务的不同可靠性要求，您可以选择在单可用区内（单机房）部署RabbitMQ实例，或跨可用区（同城灾备）部署。 在单可用区或多可用区中部署实例 副本冗余 副本通过数据同步的方式保持数据一致，当网络发生异常或节点故障时，通过冗余副本自动故障切换，并且故障恢复后会从leader副本进行数据同步，保持数据一致性。 设置实例镜像队列 设置实例仲裁队列 数据持久化 业务系统日常运行中可能出现一些小概率的异常事件。部分可靠性要求非常高的业务系统，除了要求实例高可用，还要求数据安全、可恢复，以便在实例发生异常后能够使用备份数据进行恢复，保障业务正常运行。 消息持久化 父主题： 安全

身份认证 无论用户通过控制台还是API访问DMS for RabbitMQ，都会要求访问请求方出示身份凭证，并进行身份合法性校验，同时提供登录保护和登录验证策略加固身份认证安全。DMS for RabbitMQ基于统一身份认证服务（Identity and Access Management，简称IAM），支持三种身份认证方式：用户名密码、访问密钥、临时访问密钥。同时还提供登录保护及登录验证策略。

审计与日志 云审计服务（Cloud Trace Service，简称CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后，CTS可记录DMS for RabbitMQ的管理事件用于审计。 CTS的详细介绍和开通配置方法，请参见CTS快速入门。 CTS支持追踪的DMS for RabbitMQ管理事件列表，请参见云审计服务支持的DMS for RabbitMQ操作列表。 图1 云审计服务 父主题： 安全

服务韧性 DMS for RabbitMQ提供了3级可靠性架构，通过跨AZ容灾、AZ内实例容灾、实例数据多副本技术方案，保障服务的持久性和可靠性。 表1 DMS for RabbitMQ可靠性架构 可靠性方案 简要说明 跨AZ容灾 DMS for RabbitMQ提供跨AZ类型实例，支持跨AZ容灾，当一个AZ异常时，不影响RabbitMQ实例持续提供服务。 AZ内实例容灾 RabbitMQ集群提供镜像队列，通过镜像在其他节点同步数据。单节点宕机时，仍可通过唯一的访问地址对外提供服务。 数据容灾 通过支持数据多副本方式实现数据容灾。 父主题： 安全

支持的操作系统 数据采集的Agent目前仅支持运行在EulerOS的Linux系统x86_64架构的主机上，支持版本如下所示： 表1 支持的EulerOS版本 版本 购买ECS时，可选择的版本 EulerOS 2.5 EulerOS 2.5 64bit for Tenant 20210227(40GB) EulerOS 2.5 64bit for Tenant 20220321 base 2.5.11(40GB) EulerOS 2.5 64bit for Tenant 20220906 base 2.5.12(40GB) EulerOS 2.5 64bit for Tenant 20221130 base 2.5.13(40GB) Public-CAD-EulerOS-BaseTemplate-2.5.9-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.5.11-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.5.12-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.5.13-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.5.14-x86_64-Standard（制作资源专用不支持密码注入）(20GB) EulerOS 2.9 Public-CAD-EulerOS-BaseTemplate-2.9.6-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.9.7-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.9.8-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.9.9-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.9.10-x86_64-Standard（制作资源专用不支持密码注入）(20GB) EulerOS 2.10 Public-CAD-EulerOS-BaseTemplate-2.10.5-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.10.6-x86_64-Standard（制作资源专用不支持密码注入）(20GB) Public-CAD-EulerOS-BaseTemplate-2.10.7-x86_64-Standard（制作资源专用不支持密码注入）(20GB)

场景说明 安全云脑除默认支持的云服务日志接入外，还具备采集管理功能，使用该功能可对日志进行采集、解析、转出、可视化查询、威胁建模等。 在此过程中，需要安装Agent组件，打通安全云脑与ECS通道。还需要安装Logstash组件，用于数据接入、解析、转出等操作。 本场景将介绍以下两种接入操作指导： 使用默认解析方式快速接入数据：使用安全云脑数据采集中默认的解析方式快速接入数据。 使用自定义解析方式接入数据：根据您的需要通过自定义解析方式接入数据。 父主题： 数据转入转出操作指导

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式：项目级服务和全局级服务。 项目级服务需要获取项目级别的Token，此时请求body中auth.scope的取值为project。 全局级服务需要获取全局级别的Token，此时请求body中auth.scope的取值为domain。 调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用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不同，使用时请注意。

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户（IAM） 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 父主题： 使用前必读

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

状态码 状态码如表1所示。 表1 状态码 状态码 编码 状态码说明 200 OK 成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

概述 欢迎使用云桌面（Workspace）。云桌面（Workspace）是一种基于云计算的桌面服务。与传统PC和VDI不同，企业无需投入大量的资金和花费数天的部署时间，即可快速构建桌面办公环境。云桌面支持多种登录方式，可让您灵活存取文件及使用应用，实现移动办公。 您可以使用本文档提供的API对云桌面进行相关操作，如创建、查询、删除等。支持的全部操作请参见API概览。 在调用云桌面服务的API之前，请确保已经充分了解云桌面服务的相关概念，详细信息请参见《云桌面产品介绍》。 父主题： 使用前必读

响应示例 状态码： 200 查询所有策略组的详细信息的响应。 { "count" : 31, "items" : [ { "id" : "574141368704696320", "name" : "updatePolicy_20230601144442564522", "priority" : 1, "description" : "策略组description01271237542", "targets" : [ { "target_id" : "1010101012", "target_name" : "user0012", "target_type" : "USER" } ], "policies" : { "peripherals" : { "usb_port_redirection" : { "usb_enable" : true, "options" : { "usb_image_enable" : true, "usb_video_enable" : true, "usb_printer_enable" : true, "usb_storage_enable" : false, "wireless_devices_enable" : false, "network_devices_enable" : false, "usb_smart_card_enable" : true, "other_usb_devices_enable" : false, "usb_redirection_customization_policy" : "", "usb_redirection_mode" : "Classical mode" } }, "device_redirection" : { "printer_redirection" : { "printer_enable" : true, "options" : { "sync_client_default_printer_enable" : true, "universal_printer_driver" : "Default" } }, "session_printer" : { "session_printer_enable" : false, "options" : { "session_printer_customization_policy" : "" } }, "camera_redirection" : { "video_compress_enable" : true, "options" : { "camera_frame_rate" : 15, "camera_max_width" : 3000, "camera_max_heigth" : 3000, "camera_compression_method" : "H.264" } }, "twain_redirection_enable" : true, "image_compression_level" : "medium" }, "usb_device_common" : { "pcsc_smart_card_enable" : "Disable", "common_options" : { "remove_smart_card_disconnect_enable" : false } }, "serial_port_redirection" : { "serial_port_enable" : false, "options" : { "auto_connect_enable" : false } } }, "audio" : { "audio_redirection_enable" : true, "play_redirection_enable" : true, "play_classification" : "Music Play", "record_redirection_enable" : true, "record_classification" : "Speech Call" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180, "forbid_screen_capture" : false }, "display" : { "display_level" : "LEVEL4", "options" : { "display_bandwidth" : 20000, "frame_rate" : 25, "video_frame_rate" : 30, "min_image_cache" : 200, "smoothing_factor" : 60, "lossless_compression_mode" : "Basic Compression", "deep_compression_options" : { "deep_compression_level" : "Compression grade 0" }, "lossy_compression_quality" : 85, "color_enhancement_enable" : false, "quality_bandwidth_first" : "Quality First", "video_bit_rate_options" : { "average_video_bit_rate" : 18000 }, "peak_video_bit_rate" : 18000, "video_quality_options" : { "average_video_quality" : 15, "lowest_video_quality" : 25, "highest_video_quality" : 7 }, "gop_size" : 100, "encoding_preset" : "Preset 1" }, "rendering_acceleration_enable" : false, "rendering_acceleration_options" : { "video_acceleration_enhancement_enable" : true, "video_optimization_enable" : false, "gpu_color_optimization_enable" : false }, "video_card_memory_size" : 64, "driver_delegation_mode_enable" : false, "driver_delegation_latency" : 80, "video_latency" : 80, "change_resolution_vm" : false }, "file_and_clipboard" : { "bypass_in_remote_app_enable" : true, "file_redirection" : { "redirection_mode" : "DISABLED", "options" : { "fluid_control_switch_enable" : false, "fluid_control_options" : { "good_network_latency" : 30, "normal_network_latency" : 70, "poor_network_latency" : 100, "reducing_step" : 20, "slow_increasing_step" : 10, "quick_increasing_step" : 20, "start_speed" : 1024, "test_block_size" : 64, "test_time_gap" : 10000 }, "compression_switch_enable" : false, "compression_switch_options" : { "compression_threshold" : 512, "minimum_compression_rate" : 900 }, "linux_file_size_supported_enable" : true, "linux_file_size_supported_options" : { "linux_file_size_supported_threshold" : 100 }, "linux_root_mount_switch_enable" : true, "linux_root_dir_list" : "\\\\\\\\var\\\\\\\\log", "linux_file_mount_path" : "\\\\\\\\media|\\\\\\\\Volumes|\\\\\\\\swdb\\\\\\\\mnt|\\\\\\\\home|\\\\\\\\storage|\\\\\\\\tmp|\\\\\\\\run\\\\\\\\media", "linux_fixed_drive_file_system_format" : "", "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir", "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf", "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs", "path_separator" : "|", "fixed_drive_enable" : true, "removable_drive_enable" : true, "cd_rom_drive_enable" : true, "network_drive_enable" : true }, "vm_send_file_client" : false, "redirection_send_file_options" : { "read_write_speed" : 0 } }, "fd_mobile_client_redir_enable" : true, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "rich_text_clipboard_redirection" : "DISABLED", "clipboard_file_redirection_enable" : true, "file_clipboard_redirection" : "DISABLED" } }, "session" : { "sbc" : { "sbc_automatic_disconnection" : "DISABLED", "sbc_automatic_disconnection_options" : { "disconnection_waiting_time" : 10, "sbc_auto_logout" : false, "auto_logout_options" : { "sbc_logout_waiting_time" : 1440 } } } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "", "virtual_channel_plugin_details" : "", "third_party_plugin_name" : "" } }, "keyboard_mouse" : { "mouse_feedback" : "SELFADAPTION", "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : false }, "bandwidth" : { "intelligent_data_transport_flag" : "DISABLE", "total_bandwidth_control_enable" : false, "options" : { "total_bandwidth_control_value" : 30000, "display_bandwidth_percentage_enable" : false, "display_bandwidth_percentage_options" : { "display_bandwidth_percentage_value" : 65 }, "multimedia_bandwidth_percentage_enable" : false, "multimedia_bandwidth_percentage_options" : { "multimedia_bandwidth_percentage_value" : 50 }, "usb_bandwidth_percentage_enable" : false, "usb_bandwidth_percentage_options" : { "usb_bandwidth_percentage_value" : 100 }, "pcsc_bandwidth_percentage_enable" : false, "pcsc_bandwidth_percentage_options" : { "pcsc_bandwidth_percentage_value" : 5 }, "twain_bandwidth_percentage_enable" : false, "twain_bandwidth_percentage_options" : { "twain_bandwidth_percentage_value" : 15 }, "printer_bandwidth_percentage_enable" : false, "printer_bandwidth_percentage_options" : { "printer_bandwidth_percentage_value" : 5 }, "com_bandwidth_percentage_enable" : false, "com_bandwidth_percentage_options" : { "com_bandwidth_percentage_value" : 3 }, "file_redirection_bandwidth_percentage_enable" : false, "file_redirection_bandwidth_percentage_options" : { "file_redirection_bandwidth_percentage_value" : 30 }, "clipboard_bandwidth_percentage_enable" : false, "clipboard_bandwidth_percentage_options" : { "clipboard_bandwidth_percentage_value" : 3 }, "secure_channel_bandwidth_percentage_enable" : false, "secure_channel_bandwidth_percentage_options" : { "secure_channel_bandwidth_percentage_value" : 30 }, "camera_bandwidth_percentage_enable" : false, "camera_bandwidth_percentage_options" : { "camera_bandwidth_percentage_value" : 30 }, "virtual_channel_bandwidth_percentage_enable" : false, "virtual_channel_bandwidth_percentage_options" : { "virtual_channel_bandwidth_percentage_value" : 65 } }, "display_bandwidth_control_enable" : false, "display_bandwidth_control_options" : { "display_bandwidth_control_value" : 20000 }, "multimedia_bandwidth_control_enable" : false, "multimedia_bandwidth_control_options" : { "multimedia_bandwidth_control_value" : 15000 }, "usb_bandwidth_control_enable" : false, "usb_bandwidth_control_options" : { "usb_bandwidth_control_value" : 30000 }, "pcsc_bandwidth_control_enable" : false, "pcsc_bandwidth_control_options" : { "pcsc_bandwidth_control_value" : 2000 }, "twain_bandwidth_control_enable" : false, "twain_bandwidth_control_options" : { "twain_bandwidth_control_value" : 5000 }, "printer_bandwidth_control_enable" : false, "printer_bandwidth_control_options" : { "printer_bandwidth_control_value" : 2000 }, "com_bandwidth_control_enable" : false, "com_bandwidth_control_options" : { "com_bandwidth_control_value" : 1000 }, "file_redirection_bandwidth_control_enable" : false, "file_redirection_bandwidth_control_options" : { "file_redirection_bandwidth_control_value" : 10000 }, "clipboard_bandwidth_control_enable" : false, "clipboard_bandwidth_control_options" : { "clipboard_bandwidth_control_value" : 1000 }, "secure_channel_bandwidth_control_enable" : false, "secure_channel_bandwidth_control_options" : { "secure_channel_bandwidth_control_value" : 10000 }, "camera_bandwidth_control_enable" : false, "camera_bandwidth_control_options" : { "camera_bandwidth_control_value" : 10000 }, "virtual_channel_bandwidth_control_enable" : false, "virtual_channel_bandwidth_control_options" : { "virtual_channel_bandwidth_control_value" : 20000 } }, "custom" : { "custom_configuration1_enable" : true, "options" : { "custom_configuration1_rule" : "" } } }, "create_time" : "2023-06-01T14:45:21.566Z", "update_time" : "2023-06-01T14:45:21.566Z" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 items Array of PolicyGroup objects 策略组列表，返回列表条目数量上限为分页的最大上限值 表5 PolicyGroup 参数 参数类型 描述 id String 策略组的唯一标识 name String 策略组名称 priority Integer 优先级 description String 服务器组描述 targets Array of Target objects 应用对象列表。 policies Policies object 策略。 create_time String 策略组创建时间 update_time String 策略组更新时间 表6 Target 参数 参数类型 描述 target_id String 对象ID。 target_name String 对象名称。 target_type String 对象类型。 USER：表示用户。 target_id：为用户ID。 target_name：为用户name。 USERGROUP：表示用户组。 target_id：为用户组ID。 target_name：为用户组name。 APPGROUP：应用组。 target_id：应用组id。 target_name：应用组名称。 OU：组织单元。 target_id：OUID。 target_name：OU名称。 ALL：表示所有。 target_id：default-apply-all-targets。 target_name：All-Targets。 表7 Policies 参数 参数类型 描述 peripherals peripherals object 外设。 audio audio object 音频。 client client object 客户端。 display display object 显示。 file_and_clipboard file_and_clipboard object 文件和剪切板。 session Session object 会话 virtual_channel VirtualChannel object 虚拟通道 keyboard_mouse keyboard_mouse object 键盘鼠标。 bandwidth Bandwidth object 带宽 custom custom object 自定义策略 表8 peripherals 参数 参数类型 描述 usb_port_redirection usb_port_redirection object USB端口重定向。 device_redirection device_redirection object 设备重定向。 usb_device_common usb_device_common object USB和设备智能卡控制选项。 serial_port_redirection serial_port_redirection object 串口重定向。 表9 usb_port_redirection 参数 参数类型 描述 usb_enable Boolean 是否开启USB端口重定向。 false：表示关闭。 true：表示开启。 options options object USB端口重定向控制的选项。 表10 options 参数 参数类型 描述 usb_image_enable Boolean 是否开启图像设备（如: 扫描仪）。取值为： false：表示关闭。 true：表示开启。 usb_video_enable Boolean 是否开启视频设备（如: 摄像头）。取值为： false：表示关闭。 true：表示开启。 usb_printer_enable Boolean 是否开启打印设备（如: 打印机）。取值为： false：表示关闭。 true：表示开启。 usb_storage_enable Boolean 是否开启存储设备（如: U盘）。取值为： false：表示关闭。 true：表示开启。 wireless_devices_enable Boolean 是否开启无线设备（如：蓝牙）。取值为： false：表示关闭。 true：表示开启。 network_devices_enable Boolean 是否开启网路设备（如：无线网卡）。取值为： false：表示关闭。 true：表示开启。 usb_smart_card_enable Boolean 是否开启智能卡设备（如：Ukey）。取值为： false：表示关闭。 true：表示开启。 other_usb_devices_enable Boolean 是否开启其他USB设备重定向。取值为： false：表示关闭。 true：表示开启。 usb_redirection_customization_policy String USB端口重定向自定义策略。 usb_redirection_mode String USB 重定向模式。取值为： Classical mode：经典模式。 Common mode：通用模式。 表11 device_redirection 参数 参数类型 描述 printer_redirection printer_redirection object 打印机重定向。 session_printer session_printer object 会话打印机。 camera_redirection camera_redirection object 摄像头重定向。 twain_redirection_enable Boolean 是否开启TWAIN设备重定向。取值为： false：表示关闭。 true：表示开启。 image_compression_level String 图形压缩级别。取值为： 不压缩：none。 低（速度最快）：low。 中（速度适中）：medium。 高（速度最慢）：high。 无损（无损压缩）：lossless。 低损（低损压缩）：low-loss。 中损（中损压缩）：medium-loss。 高损（高损压缩）：high-loss。 表12 printer_redirection 参数 参数类型 描述 printer_enable Boolean 是否开启打印机设备重定向。取值为： false：表示关闭。 true：表示开启。 options options object 打印机设备重定向控制的选项。 表13 options 参数 参数类型 描述 sync_client_default_printer_enable Boolean 是否开启同步客户端默认打印机。取值为： false：表示关闭。 true：表示开启。 universal_printer_driver String 通用打印机驱动。取值为：- Default：linux客户端选择Universal Printing- PS，windows客户端选择HDP XPSDrv Driver。- HDP XPSDrv Driver。- Universal Printing PCL 5。- Universal Printing PCL 6。- Universal Printing PS。 表14 session_printer 参数 参数类型 描述 session_printer_enable Boolean 是否开启会话打印机。取值为： false：表示关闭。 true：表示开启。 options options object 会话打印机控制选项。 表15 options 参数 参数类型 描述 session_printer_customization_policy String 会话打印机自定义策略。 表16 camera_redirection 参数 参数类型 描述 video_compress_enable Boolean 是否开启摄像头设备重定向。取值为： false：表示关闭。 true：表示开启。 options options object 摄像头设备重定向控制的选项。 表17 options 参数 参数类型 描述 camera_frame_rate Integer 摄像头帧率（fps）。取值范围为[1-30]。默认：15。 camera_max_width Integer 摄像头最大宽度（pixel）。取值范围为[1-9999]。默认：3000。 camera_max_heigth Integer 摄像头最大高度（pixel）。取值范围为[1-9999]。默认：3000。 camera_compression_method String 摄像头数据压缩方式。取值为：H.264。 表18 usb_device_common 参数 参数类型 描述 pcsc_smart_card_enable String 是否开启PC/SC智能卡重定向。取值为： Enable：表示已启动。 Closed：表示已关闭。 Disable：表示已禁用。 common_options common_options object USB和设备智能卡共同控制的选项。 表19 common_options 参数 参数类型 描述 remove_smart_card_disconnect_enable Boolean 是否移除智能卡断开用户会话。取值为： false：表示关闭。 true：表示开启。 表20 serial_port_redirection 参数 参数类型 描述 serial_port_enable Boolean 是否开启串口重定向。取值为： false：表示关闭。 true：表示开启。 options options object 串口重定向控制的选项。 表21 options 参数 参数类型 描述 auto_connect_enable Boolean 是否自动连接客户端串口。取值为： false：表示关闭。 true：表示开启。 表22 audio 参数 参数类型 描述 audio_redirection_enable Boolean 是否开启音频重定向。取值为： false：表示关闭。 true：表示开启。 play_redirection_enable Boolean 是否开启播音重定向。取值为： false：表示关闭。 true：表示开启。 play_classification String 播音场景。取值为： 无损播音：LossLess。 语音通话：Speech Call。 音乐播音：Music Play。 自动识别：Automatic Identification。 record_redirection_enable Boolean 是否开启录音重定向。取值为： false：表示关闭。 true：表示开启。 record_classification String 录音场景。取值为： 无损录音：LossLess。 语音通话：Speech Call。 音乐录音：Music Record。 自动识别：Automatic Identification。 表23 client 参数 参数类型 描述 automatic_reconnection_interval Integer 自动重连间隔（秒）。取值范围为[1-50]。默认：5。 session_persistence_time Integer 自动重连会话保持时长（秒）。取值范围为[0-180]。默认：180。 forbid_screen_capture Boolean 防截屏策略开关。 false：表示关闭。 true：表示开启。 表24 display 参数 参数类型 描述 display_level String 显示级别。取值为： LEVEL1：表示等级1。 LEVEL2：表示等级2。 LEVEL3：表示等级3。 LEVEL4：表示等级4（默认/推荐）。 LEVEL5：表示等级5。 options options object 显示级别共同控制的选项。 rendering_acceleration_enable Boolean 是否开启渲染加速。取值为： false：表示关闭。 true：表示开启。 rendering_acceleration_options rendering_acceleration_options object 渲染加速控制选项。 video_card_memory_size Integer 显卡缓存（MB）。取值范围为[0-64]。默认：64。 driver_delegation_mode_enable Boolean 是否开启驱动托管模式。取值为： false：表示关闭。 true：表示开启。 driver_delegation_latency Integer 驱动托管延时（*30ms）。取值范围为[1-100]。默认：80。 video_latency Integer 驱动托管视频延时（*30ms）。取值范围为[1-100]。默认：80。 change_resolution_vm Boolean 计算机修改分辨率：取值为： false：表示关闭。 true：表示开启。 表25 options 参数 参数类型 描述 display_bandwidth Integer 带宽（Kbps）。取值范围为[256-25000]。默认：20000。 frame_rate Integer 帧率（fps）。取值范围为[1-60]。默认：25。 video_frame_rate Integer 视频帧率（fps）。取值范围为[1-60]。默认：30。 min_image_cache Integer 图像缓存最低容量（MB）。取值范围[0-300]，默认：200。 smoothing_factor Integer 有损压缩识别阈值。取值范围为[0-255]。默认：60。 lossless_compression_mode String 无损压缩模式。取值为： Basic Compression：表示初级压缩。 Deep Compression：表示深度压缩。 deep_compression_options deep_compression_options object 深度压缩控制选项。 lossy_compression_quality Integer 有损压缩质量。取值范围为[20-100]。默认：85。 color_enhancement_enable Boolean 办公场景色彩增强：取值为： false：表示关闭。 true：表示开启。 quality_bandwidth_first String 质量或带宽优先。取值为： Quality First：表示初级压缩。 Bandwidth First：表示深度压缩。 video_bit_rate_options video_bit_rate_options object 视频码率控制选项。 peak_video_bit_rate Integer 视频峰值码率（Kbps）。取值范围为[256-100000]。默认：18000。 video_quality_options video_quality_options object 视频质量控制选项。 gop_size Integer GOP大小。取值范围为[0-65535]。默认：100。 encoding_preset String 编码预置。取值为： 预置1：Preset 1。 预置2：Preset 2。 预置3：Preset 3。 预置4：Preset 4。 预置5：Preset 5。 预置6：Preset 6。 预置7：Preset 7。 表26 deep_compression_options 参数 参数类型 描述 deep_compression_level String 深度压缩级别。取值为： 压缩级别0：Compression grade 0 压缩级别1：Compression grade 1 压缩级别2：Compression grade 2 压缩级别3：Compression grade 3 压缩级别4：Compression grade 4 压缩级别5：Compression grade 5 压缩级别6：Compression grade 6 压缩级别7：Compression grade 7 压缩级别8：Compression grade 8 压缩级别9：Compression grade 9 表27 video_bit_rate_options 参数 参数类型 描述 average_video_bit_rate Integer 视频平均码率（Kbps）。取值范围为[256-100000]。默认：18000。 表28 video_quality_options 参数 参数类型 描述 average_video_quality Integer 视频平均质量。取值范围为[5-59]。默认：15。 lowest_video_quality Integer 视频最低质量。取值范围为[5-69]。默认：25。 highest_video_quality Integer 视频最高质量。取值范围为[1-59]。默认：7。 表29 rendering_acceleration_options 参数 参数类型 描述 video_acceleration_enhancement_enable Boolean 视频加速增强配置。取值为： false：表示关闭。 true：表示开启。 video_optimization_enable Boolean 是否开启视频场景优化。取值为： false：表示关闭。 true：表示开启。 gpu_color_optimization_enable Boolean 是否开启GPU色彩优化。取值为： false：表示关闭。 true：表示开启。 表30 file_and_clipboard 参数 参数类型 描述 bypass_in_remote_app_enable Boolean 应用聚合场景下是否双向放通：取值为： false：表示不放通。 true：表示放通。 file_redirection file_redirection object 文件重定向。 fd_mobile_client_redir_enable Boolean 移动客户端文件重定向：取值为： false：表示关闭。 true：表示开启。 clipboard_redirection String 剪切板重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_redirection_options clipboard_redirection_options object 剪切板重定向控制的选项。 表31 file_redirection 参数 参数类型 描述 redirection_mode String 文件重定向。取值为： DISABLED：表示禁用。（默认） READ_ONLY：表示只读。 READ_AND_WRITE：表示读写。 options options object 文件重定向控制的选项。 vm_send_file_client Boolean 是否开启发送文件（虚机到客户端）。取值为： false：表示关闭。 true：表示开启。 redirection_send_file_options redirection_send_file_options object 重定向和发送文件共同控制项。 表32 options 参数 参数类型 描述 fluid_control_switch_enable Boolean 是否开启流控开关。取值为： false：表示关闭。 true：表示开启。 fluid_control_options fluid_control_options object 流控控制项。 compression_switch_enable Boolean 是否开启压缩开关。取值为： false：表示关闭。 true：表示开启。 compression_switch_options compression_switch_options object 压缩开关控制项。 linux_file_size_supported_enable Boolean 是否开启Linux支持设置文件大小。取值为： false：表示关闭。 true：表示开启。 linux_file_size_supported_options linux_file_size_supported_options object Linux支持设置文件大小控制项。 linux_root_mount_switch_enable Boolean 是否开启Linux根目录挂载开关。取值为： false：表示关闭。 true：表示开启。 linux_root_dir_list String Linux根目录挂载路径。默认："\home"。 linux_file_mount_path String Linux文件系统挂载路径。默认："\media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media"。 linux_fixed_drive_file_system_format String Linux固定驱动器文件系统格式。 linux_removable_drive_file_system_format String Linux可移动驱动器文件系统格式。默认："vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir"。 linux_cdrom_drive_file_system_format String Linux光盘驱动器文件系统格式。默认："cd9660|iso9660|udf"。 linux_network_drive_file_system_format String Linux网络驱动器文件系统格式。默认："smbfs|afpfs|cifs"。 path_separator String 路径分隔符。默认："|"。 fixed_drive_enable Boolean 是否开启固定驱动器（如: 本地磁盘）。取值为： false：表示关闭。 true：表示开启。 removable_drive_enable Boolean 是否开启可移除驱动器（如: U盘）。取值为： false：表示关闭。 true：表示开启。 cd_rom_drive_enable Boolean 是否开启光盘驱动器。取值为： false：表示关闭。 true：表示开启。 network_drive_enable Boolean 是否开启网络驱动器。取值为： false：表示关闭。 true：表示开启。 表33 fluid_control_options 参数 参数类型 描述 good_network_latency Integer 网络优的延时阈值（ms）。取值范围为[1-1000]。默认：30。 normal_network_latency Integer 网络一般的延时阈值（ms）。取值范围为[1-1000]。默认：70。 poor_network_latency Integer 网络差的延时阈值（ms）。取值范围为[1-1000]。默认：100。 reducing_step Integer 降速步伐（KB）。取值范围为[1-100]。默认：20。 slow_increasing_step Integer 慢增速步伐（KB）。取值范围为[1-100]。默认：10。 quick_increasing_step Integer 快增速步伐（KB）。取值范围为[1-100]。默认：20。 start_speed Integer 传输初始速度（KB/s）。取值范围为[1-10240]。默认：1024。 test_block_size Integer 测速块大小（KB）。取值范围为[64-1024]。默认：64。 test_time_gap Integer 测速块时间间隔（ms）。取值范围为[1000-100000]。默认：10000。 表34 compression_switch_options 参数 参数类型 描述 compression_threshold Integer 压缩阈值（Byte）。取值范围为[0-10240]。默认：512。 minimum_compression_rate Integer 最小压缩率。取值范围为[0-1000]。默认：900。 表35 linux_file_size_supported_options 参数 参数类型 描述 linux_file_size_supported_threshold Integer Linux设置文件大小阈值（Byte）。取值范围为[0-4096]。默认：100。 表36 redirection_send_file_options 参数 参数类型 描述 read_write_speed Integer 读写速度（Kbps）。取值范围为[0-2147483647]。默认：0。 表37 clipboard_redirection_options 参数 参数类型 描述 rich_text_redirection_enable Boolean 是否开启剪切板富文本重定向。取值为： false：表示关闭。 true：表示开启。 rich_text_clipboard_redirection String 剪切板富文本重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_file_redirection_enable Boolean 是否开启剪切板文件重定向。取值为： false：表示关闭。 true：表示开启。 file_clipboard_redirection String 剪切板文件重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 表38 Session 参数 参数类型 描述 sbc Sbc object SBC 表39 Sbc 参数 参数类型 描述 sbc_automatic_disconnection String 连接策略。 DISABLED：已禁用 AUTO_DISCONNECT：自动断开 AUTO_LOCK：自动锁屏 sbc_automatic_disconnection_options SbcAutomaticDisconnectionOptions object 自动连接选项 表40 SbcAutomaticDisconnectionOptions 参数 参数类型 描述 disconnection_waiting_time Integer 等待时间（分钟） sbc_auto_logout Boolean 是否自动注销。取值为：false：表示是。true：表示否。 auto_logout_options AutoLogoutOptions object 自动注销 表41 AutoLogoutOptions 参数 参数类型 描述 sbc_logout_waiting_time Integer 会话断连保留时长（分钟） 表42 VirtualChannel 参数 参数类型 描述 virtual_channel_control_enable Boolean 是否开启虚拟通道策略设置。取值为：false：表示关闭。true：表示开启。 options VirtualChannelOptions object 虚拟通道策略控制的选项。 表43 VirtualChannelOptions 参数 参数类型 描述 custom_virtual_channel_name String 自定义虚拟通道注册名。 virtual_channel_plugin_details String 虚拟通道下载配置信息，需Base64加密。 third_party_plugin_name String 第三方插件名称。 表44 keyboard_mouse 参数 参数类型 描述 mouse_feedback String 虚拟机鼠标回馈。取值为： SELFADAPTION：自适应鼠标回馈。 FORCE：强制鼠标回馈。 CLOSE：关闭鼠标回馈。 mouse_simulation_mode String 虚拟机鼠标模拟方式。取值为： ABSOLUTE_POSITION：绝对位置模拟。 RELATIVE_POSITION：相对位置模拟。 external_cursor_feedback Boolean 虚拟机外部光标反馈。取值为： false：表示关闭。 true：表示开启。 表45 Bandwidth 参数 参数类型 描述 intelligent_data_transport_flag String 智能显示传输。取值为：DISABLE：表示关闭。ENABLE：表示开启。DIAGNOSTIC：诊断模式 total_bandwidth_control_enable Boolean 是否开启总带宽控制。取值为：false：表示关闭。true：表示开启。 options TotalBandwidthControlOptions object 总带宽控制的选项。 display_bandwidth_control_enable Boolean 是否开启显示带宽控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_control_options DisplayBandwidthControlOptions object 显示带宽控制的选项。 multimedia_bandwidth_control_enable Boolean 是否开启多媒体带宽控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_control_options MultimediaBandwidthControlOptions object 多媒体带宽控制的选项 usb_bandwidth_control_enable Boolean 是否开启USB带宽控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_control_options UsbBandwidthControlOptions object USB带宽控制的选项。 pcsc_bandwidth_control_enable Boolean 是否开启PCSC控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_control_options PcscBandwidthControlOptions object PCSC带宽控制的选项。 twain_bandwidth_control_enable Boolean 是否开启TWAIN带宽控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_control_options TwainBandwidthControlOptions object TWAIN带宽控制的选项。 printer_bandwidth_control_enable Boolean 是否开启打印机带宽控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_control_options PrinterBandwidthControlOptions object 打印机带宽控制的选项 com_bandwidth_control_enable Boolean 是否开启串口带宽控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_control_options ComBandwidthControlOptions object 串口带宽控制的选项。 file_redirection_bandwidth_control_enable Boolean 是否开启文件重定向带宽控制。取值为：false：表示关闭。true：表示开启 file_redirection_bandwidth_control_options FileRedirectionBandwidthControlOptions object 文件重定向带宽控制的选项 clipboard_bandwidth_control_enable Boolean 是否开启剪切板带宽控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_control_options ClipboardBandwidthControlOptions object 剪切板带宽控制的选项。 secure_channel_bandwidth_control_enable Boolean 是否开启安全通道带宽控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_control_options SecureChannelBandwidthControlOptions object 安全通道带宽控制的选项。 camera_bandwidth_control_enable Boolean 是否开启摄像头带宽控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_control_options CameraBandwidthControlOptions object 摄像头带宽控制的选项。 virtual_channel_bandwidth_control_enable Boolean 是否开启虚拟通道带宽控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_control_options VirtualChannelBandwidthControlOptions object 虚拟通道带宽控制的选项。 表46 TotalBandwidthControlOptions 参数 参数类型 描述 total_bandwidth_control_value Integer 总带宽控制量（Kbps）。取值范围为[10000-1000000]。默认：30000。 display_bandwidth_percentage_enable Boolean 显示带宽百分比控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_percentage_options DisplayBandwidthPercentageOptions object 显示带宽百分比控制的选项。 multimedia_bandwidth_percentage_enable Boolean 多媒体带宽百分比控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_percentage_options MultimediaBandwidthPercentageOptions object 多媒体带宽百分比控制的选项。 usb_bandwidth_percentage_enable Boolean USB带宽百分比控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_percentage_options UsbBandwidthPercentageOptions object USB带宽百分比控制的选项。 pcsc_bandwidth_percentage_enable Boolean PCSC带宽百分比控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_percentage_options PcscBandwidthPercentageOptions object PCSC带宽百分比控制的选项。 twain_bandwidth_percentage_enable Boolean TWAIN带宽百分比控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_percentage_options TwainBandwidthPercentageOptions object TWAIN带宽百分比控制的选项。 printer_bandwidth_percentage_enable Boolean 打印机带宽百分比控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_percentage_options PrinterBandwidthPercentageOptions object 打印机带宽百分比控制的选项。 com_bandwidth_percentage_enable Boolean 串口带宽百分比控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_percentage_options ComBandwidthPercentageOptions object 串口带宽百分比控制的选项。 file_redirection_bandwidth_percentage_enable Boolean 文件重定向带宽百分比控制。取值为：false：表示关闭。true：表示开启。 file_redirection_bandwidth_percentage_options FileRedirectionBandwidthPercentageOptions object 文件重定向带宽百分比控制的选项。 clipboard_bandwidth_percentage_enable Boolean 剪切板带宽百分比控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_percentage_options ClipboardBandwidthPercentageOptions object 剪切板带宽百分比控制的选项。 secure_channel_bandwidth_percentage_enable Boolean 安全通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_percentage_options SecureChannelBandwidthPercentageOptions object 安全通道带宽百分比控制的选项。 camera_bandwidth_percentage_enable Boolean 摄像头带宽百分比控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_percentage_options CameraBandwidthPercentageOptions object 摄像头带宽百分比控制的选项。 virtual_channel_bandwidth_percentage_enable Boolean 虚拟通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_percentage_options VirtualChannelBandwidthPercentageOptions object 虚拟通道带宽百分比控制的选项。 表47 DisplayBandwidthPercentageOptions 参数 参数类型 描述 display_bandwidth_percentage_value Integer 显示带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表48 MultimediaBandwidthPercentageOptions 参数 参数类型 描述 multimedia_bandwidth_percentage_value Integer 多媒体带宽百分比控制量（%）。取值范围为[0-100]。默认：50。 表49 UsbBandwidthPercentageOptions 参数 参数类型 描述 usb_bandwidth_percentage_value Integer USB带宽百分比控制量（%）。取值范围为[0-100]。默认：100。 表50 PcscBandwidthPercentageOptions 参数 参数类型 描述 pcsc_bandwidth_percentage_value Integer PCSC带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表51 TwainBandwidthPercentageOptions 参数 参数类型 描述 twain_bandwidth_percentage_value Integer TWAIN带宽百分比控制量（%）。取值范围为[0-100]。默认：15。 表52 PrinterBandwidthPercentageOptions 参数 参数类型 描述 printer_bandwidth_percentage_value Integer 打印机带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表53 ComBandwidthPercentageOptions 参数 参数类型 描述 com_bandwidth_percentage_value Integer 串口带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表54 FileRedirectionBandwidthPercentageOptions 参数 参数类型 描述 file_redirection_bandwidth_percentage_value Integer 文件重定向带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表55 ClipboardBandwidthPercentageOptions 参数 参数类型 描述 clipboard_bandwidth_percentage_value Integer 剪切板带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表56 SecureChannelBandwidthPercentageOptions 参数 参数类型 描述 secure_channel_bandwidth_percentage_value Integer 安全通道带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表57 CameraBandwidthPercentageOptions 参数 参数类型 描述 camera_bandwidth_percentage_value Integer 摄像头带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表58 VirtualChannelBandwidthPercentageOptions 参数 参数类型 描述 virtual_channel_bandwidth_percentage_value Integer 虚拟通道带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表59 DisplayBandwidthControlOptions 参数 参数类型 描述 display_bandwidth_control_value Integer 显示带宽控制量（Kbps）。取值范围为[500-50000]。默认：20000。 表60 MultimediaBandwidthControlOptions 参数 参数类型 描述 multimedia_bandwidth_control_value Integer 多媒体带宽控制量（Kbps）。取值范围为[5000-20000]。默认：15000。 表61 UsbBandwidthControlOptions 参数 参数类型 描述 usb_bandwidth_control_value Integer USB带宽控制量（Kbps）。取值范围为[1000-30000]。默认：30000。 表62 PcscBandwidthControlOptions 参数 参数类型 描述 pcsc_bandwidth_control_value Integer PCSC带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表63 TwainBandwidthControlOptions 参数 参数类型 描述 twain_bandwidth_control_value Integer TWAIN带宽控制量（Kbps）。取值范围为[2000-10000]。默认：5000。 表64 PrinterBandwidthControlOptions 参数 参数类型 描述 printer_bandwidth_control_value Integer 打印机带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表65 ComBandwidthControlOptions 参数 参数类型 描述 com_bandwidth_control_value Integer 串口带宽控制量（Kbps）。取值范围为[500-2000]。默认：1000。 表66 FileRedirectionBandwidthControlOptions 参数 参数类型 描述 file_redirection_bandwidth_control_value Integer 文件重定向带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表67 ClipboardBandwidthControlOptions 参数 参数类型 描述 clipboard_bandwidth_control_value Integer 剪切板带宽控制量（Kbps）。取值范围为[100-2000]。默认：1000。 表68 SecureChannelBandwidthControlOptions 参数 参数类型 描述 secure_channel_bandwidth_control_value Integer 安全通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表69 CameraBandwidthControlOptions 参数 参数类型 描述 camera_bandwidth_control_value Integer 摄像头带宽控制量（Kbps）。取值范围为[0-10000]。默认：10000。 表70 VirtualChannelBandwidthControlOptions 参数 参数类型 描述 virtual_channel_bandwidth_control_value Integer 虚拟通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：20000。 表71 custom 参数 参数类型 描述 custom_configuration1_enable Boolean 自定义策略配置项1： false: 表示关闭 true: 表示开启 options options object 自定义策略设置项 表72 options 参数 参数类型 描述 custom_configuration1_rule String 配置项1内容 状态码： 400 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述 状态码： 401 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述 状态码： 403 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述 状态码： 404 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述 状态码： 405 表77 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述 状态码： 500 表78 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述 状态码： 503 表79 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述

URI GET /v1/{project_id}/policy-groups/actions/list-policy-group-detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 查询的偏移量 limit 是 Integer 查询的数量，值区间[1-100] policy_group_name 否 String 根据策略组名字过滤结果。 policy_group_type 否 Integer 根据策略组类型名字过滤结果。

响应参数 状态码： 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 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 operate_type 否 String 解除项目锁定操作类型。