华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 用户描述。 user_email 否 String 用户邮箱。 user_phone 否 String 手机号。 active_type 否 String 激活类型，默认为用户激活。 USER_ACTIVATE： 用户激活 ADMIN_ACTIVATE： 管理员激活 account_expires 否 String 账户过期时间，0表示永远不过期。 enable_change_password 否 Boolean 是否允许修改密码，true表示允许，false表示不允许。 next_login_change_password 否 Boolean 下次登录是否需要重置密码，true表示需要重置密码，false表示不需要。 password_never_expired 否 Boolean 密码是否永不过期，true表示密码永不过期，false表示密码会过期。 disabled 否 Boolean 账户是否禁用，true表示被禁用，false表示未禁用。

响应示例 状态码： 200 操作成功。 { "id" : "575772274859184144", "name" : "开放性API创建应用组测试", "app_server_group_id" : "", "description" : "开放性API测试。", "authorization_type" : "APP_GROUP", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "create_at" : "2023-06-06T14:13:58.671Z" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 应用组ID。 name String 应用组名称。 app_server_group_id String 应用服务器组ID。 app_server_group_name String 应用服务器组名称。 description String 应用组描述。 authorization_type String 授权类型，基于应用(组)授权，默认为APP_GROUP授权。 APP - 按照应用授权（尚未支持）。 APP_GROUP - 按照应用组授权。 tenant_id String 租户ID。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app。 COMMON_APP - 普通app。 create_at String 发布时间。 app_count Integer 应用数量。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表11 响应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个字符。 app_server_group_id 否 String 应用服务器组ID。 description 否 String 应用组描述。 authorization_type 否 String 授权类型，基于应用(组)授权，默认为APP_GROUP授权。 APP - 按照应用授权（尚未支持）。 APP_GROUP - 按照应用组授权。 app_type 否 String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app。 COMMON_APP - 普通app。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 满足条件的用户组总数。 user_groups Array of UserGroupInfo objects 用户组列表。 表5 UserGroupInfo 参数 参数类型 描述 name String 用户组名。 id String 用户组ID。 create_time String 用户组对应的创建时间，UTC时间：yyyy-MM-ddTHH:mm:ss.SSSZ。 description String 用户组描述。 user_quantity Integer 用户列表中用户数。 parent UserGroupInfo object 用户组上级用户组。 realm_id String 用户组域Id。 platform_type String 用户组类型。 AD： AD域用户组 LOCAL： 本地liteAs用户组 group_dn String 用户组专有名。 domain String 用户组 域名 。 sid String 用户组sid。 total_desktops Integer 用户列表中用户数。 状态码： 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接口进行解密。 状态码： 405 表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接口进行解密。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 用于分页查询，返回用户组数量限制。如果不指定或为0，则使用默认值100，从1开始，最大100。 offset 否 String 用于分页查询，查询的起始记录序号，从0开始，默认值0，必须与limit同时使用。 keyword 否 String 用来匹配用户组的搜索关键字。例如根据组名模糊查询。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 image_id 是 String 镜像id，要求与服务器原有镜像id不相同。 image_type 是 String 镜像类型： gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他 os_type 是 String 系统类型，当前仅支持Windows。 Linux - Windows - Other - image_product_id 否 String 镜像的产品id，当镜像是市场镜像时候，该字段必传。 update_access_agent 否 Boolean 是否自动升级hda版本。

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-servers/35998d9a-14f2-48fc-832b-6fc0074dc8f8/actions/change-image { "image_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8", "image_type" : "private", "os_type" : "Windows", "image_product_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8", "update_access_agent" : true }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

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

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "94b8e5c7-008f-40d7-b59a-084de3638286", "name" : "user-file-persistent", "storage_metadata" : { "storage_handle" : "sfs-tmp", "storage_class" : "sfs", "name" : "sfs-tmp", "region" : "cn-north-5", "export_location" : "https://sfs3.cn-****myhuaweicloud.com:443" }, "create_time" : "2023-06-08T07:08:09.412Z", "user_claim_count" : 0, "share_claim_count" : 0 } ] }

URI GET /v1/{project_id}/persistent-storages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 否 String WKS存储ID。 name 否 String 查询名称，模糊匹配。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PersistentStorage objects 存储列表。 表5 PersistentStorage 参数 参数类型 描述 id String WKS存储ID。 name String 名称。 storage_metadata StorageMetadata object 存储定义。 create_time String 创建时间。 user_claim_count Integer 个人目录声明数量。 share_claim_count Integer 共享目录声明数量。 表6 StorageMetadata 参数 参数类型 描述 storage_handle String SFS文件系统名称。 storage_class String 存储类型： sfs - sfs3.0存储。 name String 名称。 region String 所在区域。 export_location String 访问地址:protocol://[bucket-name].sfs3.[region-name].myhuaweicloud.com:port。 状态码： 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 错误描述。

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

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "573548db-9a6f-4b31-a5cb-d7aa40975466", "name" : "APS-20230509102837-IVTU6S27OY", "machine_name" : "APS-PR6KRMAL00", "description" : "", "server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "flavor" : { "id" : "s2.large.2", "links" : [ { "rel" : "self" }, { "rel" : "bookmark" } ] }, "status" : "REGISTERED", "create_time" : "2023-05-09T10:28:38.755Z", "update_time" : "2023-05-09T10:39:03.484Z", "image_id" : "ca8be629-112e-4865-b4fb-bbbca257f1d9", "availability_zone" : "cn-north-7a", "domain" : "wksapp***.huawei.com", "ou_name" : "", "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1399", "instance_id" : "4fa75b74-56bc-4a6b-b965-f2f139e17b5e", "os_version" : "Windows Server 2019 Datacenter 64bit", "os_type" : "Windows", "order_id" : "", "maintain_status" : false, "scaling_auto_create" : false, "resource_pool_id" : "10dd1a4f-ff85-4953-aa0f-2a37f28b6beb", "resource_pool_type" : "private", "server_group_name" : "Nas", "product_info" : { "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "s2.large.2", "type" : "BASE", "architecture" : "x86", "cpu" : "2", "memory" : "4096", "is_gpu" : false, "system_disk_type" : "SAS", "system_disk_size" : "80", "descriptions" : "s2.large.2 云应用通用型|2核|4GB内存", "charge_mode" : "0", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 1, "status" : "abandon" }, "metadata" : { "charging_mode" : "0", "metering.resourcespeccode" : "s2.large.2.win", "metering.resourcetype" : "1" }, "session_count" : 1, "vm_status" : "ACTIVE", "task_status" : "null", "freeze" : [ ], "host_address" : [ { "addr" : "192.*.*.145", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:75:06", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "257f2ff5-fe85-4b9a-86c2-5dacb64ac78f", "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "tenant_type" : "tenant" }, { "addr" : "10.*.*.79", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:02:88", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "c6fc6fcc-c99e-4604-b0e0-04e48246c7cd", "vpc_id" : "82f75215-9ae6-4e69-882c-fe4088324839", "subnet_id" : "e851a83c-8696-48ea-b078-466fe9d361ae", "tenant_type" : "resource_tenant" } ] } ] }

URI GET /v1/{project_id}/app-servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_group_id 否 String 服务器组唯一标识。 server_name 否 String 服务器名称，支持部分匹配。 machine_name 否 String 机器名称，支持部分匹配。 ip_addr 否 String ip地址，支持部分匹配。 server_id 否 String 服务器唯一标识。 maintain_status 否 String 服务器维护状态： true : 维护态的实例。 false: 非维护态的实例。 scaling_auto_create 否 String 是否是弹性创建： true : 通过弹性伸缩创建。 false: 不是通过弹性伸缩创建。

响应参数 状态码： 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 错误描述。 状态码： 415 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求示例 put /v2/0e973a948e8091232f25c00673f168b7/access-policy/20b726affecc4411bcdc49a66e3e8f63/objects { "policy_objects_list" : [ { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_type" : "USER" }, { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_type" : "USER" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_objects_list 否 Array of AccessPolicyObjectInfo objects 更新策略应用对象列表请求。 表4 AccessPolicyObjectInfo 参数 是否必选 参数类型 描述 object_id 是 String 黑名单中的对象id。 object_type 是 String 对象类型。 USER： 用户 USERGROUP： 用户组 object_name 否 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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 操作的桌面ID列表。 op_type 是 String 操作类型。 -os-start 启动。 -reboot 重启。 -os-stop 关机。 -os-hibernate 休眠。 type 否 String SOFT：普通操作；HARD：强制操作。例如type为HARD，op_type为os-stop代表强制关机。

响应参数 状态码： 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接口进行解密。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_ids 是 Array of strings 要添加或移除的用户Id列表。 op_type 是 String 操作类型。 ADD： 添加 DELETE： 删除

响应示例 状态码： 200 响应成功。 { "rule_id" : "xxxx-xxxx-xxxx", "metric_name" : "desktop_idle_duration", "threshold" : 30, "comparison_operator" : "", "interval" : 1, "enable" : true, "notify_object" : "urn:smn:REGION_ID:XXX-XXX-XXX:topicName" }

响应示例 状态码： 200 查询策略组策略项信息的响应。 { "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" : "string", "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" : "string" } }, "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" : false, "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" : "\\\\home", "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media", "linux_fixed_drive_file_system_format" : "string", "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" : true, "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" : "AUTO_DISCONNECT", "sbc_automatic_disconnection_options" : { "disconnection_waiting_time" : 15, "sbc_auto_logout" : true, "auto_logout_options" : { "sbc_logout_waiting_time" : 480 } } } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "string", "virtual_channel_plugin_details" : "string", "third_party_plugin_name" : "string" } }, "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" : "string" } } } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 policies Policies object 策略类。 表4 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 自定义策略。 表5 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 串口重定向。 表6 usb_port_redirection 参数 参数类型 描述 usb_enable Boolean 是否开启USB端口重定向。取值为： false：表示关闭。 true：表示开启。 options UsbPortRedirectionOptions object USB端口重定向控制的选项。 表7 UsbPortRedirectionOptions 参数 参数类型 描述 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：通用模式。 表8 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。 表9 printer_redirection 参数 参数类型 描述 printer_enable Boolean 是否开启打印机设备重定向。取值为： false：表示关闭。 true：表示开启。 options PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表10 PrinterRedirectionOptions 参数 参数类型 描述 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。 表11 session_printer 参数 参数类型 描述 session_printer_enable Boolean 是否开启会话打印机。取值为： false：表示关闭。 true：表示开启。 options SessionPrinterOptions object 会话打印机控制选项。 表12 SessionPrinterOptions 参数 参数类型 描述 session_printer_customization_policy String 会话打印机自定义策略。 表13 camera_redirection 参数 参数类型 描述 video_compress_enable Boolean 是否开启摄像头设备重定向。取值为： false：表示关闭。 true：表示开启。 options CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表14 CameraRedirectionOptions 参数 参数类型 描述 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。 表15 usb_device_common 参数 参数类型 描述 pcsc_smart_card_enable String 是否开启PC/SC智能卡重定向。取值为： Enable：表示已启动。 Closed：表示已关闭。 Disable：表示已禁用。 common_options common_options object USB和设备智能卡共同控制的选项。 表16 common_options 参数 参数类型 描述 remove_smart_card_disconnect_enable Boolean 是否移除智能卡断开用户会话。取值为： false：表示关闭。 true：表示开启。 表17 serial_port_redirection 参数 参数类型 描述 serial_port_enable Boolean 是否开启串口重定向。取值为： false：表示关闭。 true：表示开启。 options SerialPortRedirectionOptions object 串口重定向控制的选项。 表18 SerialPortRedirectionOptions 参数 参数类型 描述 auto_connect_enable Boolean 是否自动连接客户端串口。取值为： false：表示关闭。 true：表示开启。 表19 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。 表20 client 参数 参数类型 描述 automatic_reconnection_interval Integer 自动重连间隔（秒）。取值范围为[1-50]。默认：5。 session_persistence_time Integer 自动重连会话保持时长（秒）。取值范围为[0-180]。默认：180。 forbid_screen_capture Boolean 防截屏策略开关。 false：表示关闭。 true：表示开启。 表21 display 参数 参数类型 描述 display_level String 显示级别。取值为： LEVEL1：表示等级1。 LEVEL2：表示等级2。 LEVEL3：表示等级3。 LEVEL4：表示等级4（默认/推荐）。 LEVEL5：表示等级5。 options DisplayOptions 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：表示开启。 表22 DisplayOptions 参数 参数类型 描述 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。 表23 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 表24 video_bit_rate_options 参数 参数类型 描述 average_video_bit_rate Integer 视频平均码率（Kbps）。取值范围为[256-100000]。默认：18000。 表25 video_quality_options 参数 参数类型 描述 average_video_quality Integer 视频平均质量。取值范围为[5-59]。默认：15。 lowest_video_quality Integer 视频最低质量。取值范围为[5-69]。默认：25。 highest_video_quality Integer 视频最高质量。取值范围为[1-59]。默认：7。 表26 rendering_acceleration_options 参数 参数类型 描述 video_acceleration_enhancement_enable Boolean 视频加速增强配置。取值为： false：表示关闭。 true：表示开启。 video_optimization_enable Boolean 是否开启视频场景优化。取值为： false：表示关闭。 true：表示开启。 gpu_color_optimization_enable Boolean 是否开启GPU色彩优化。取值为： false：表示关闭。 true：表示开启。 表27 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 剪切板重定向控制的选项。 表28 file_redirection 参数 参数类型 描述 redirection_mode String 文件重定向。取值为： DISABLED：表示禁用。（默认） READ_ONLY：表示只读。 READ_AND_WRITE：表示读写。 options FileRedirectionOptions object 文件重定向控制的选项。 vm_send_file_client Boolean 是否开启发送文件（虚机到客户端）。取值为： false：表示关闭。 true：表示开启。 redirection_send_file_options redirection_send_file_options object 重定向和发送文件共同控制项。 表29 FileRedirectionOptions 参数 参数类型 描述 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：表示开启。 表30 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。 表31 compression_switch_options 参数 参数类型 描述 compression_threshold Integer 压缩阈值（Byte）。取值范围为[0-10240]。默认：512。 minimum_compression_rate Integer 最小压缩率。取值范围为[0-1000]。默认：900。 表32 linux_file_size_supported_options 参数 参数类型 描述 linux_file_size_supported_threshold Integer Linux设置文件大小阈值（Byte）。取值范围为[0-4096]。默认：100。 表33 redirection_send_file_options 参数 参数类型 描述 read_write_speed Integer 读写速度（Kbps）。取值范围为[0-2147483647]。默认：0。 表34 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：表示开启双向。 clipboard_length_limit_cts_enable Boolean 本地到虚拟机长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_cts Integer 本地到虚拟机长度限制。 clipboard_length_limit_stc_enable Boolean 虚拟机到本地到长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_stc Integer 虚拟机到本地长度限制。 表35 Session 参数 参数类型 描述 sbc Sbc object SBC结构体。 表36 Sbc 参数 参数类型 描述 sbc_automatic_disconnection String 连接策略： DISABLED：已禁用 AUTO_DISCONNECT：自动断开 AUTO_LOCK：自动锁屏 sbc_automatic_disconnection_options SbcAutomaticDisconnectionOptions object 自动连接选项。 表37 SbcAutomaticDisconnectionOptions 参数 参数类型 描述 disconnection_waiting_time Integer 等待时间（分钟）。 sbc_auto_logout Boolean 是否自动注销。取值为：false：表示是。true：表示否。 auto_logout_options AutoLogoutOptions object 自动注销。 表38 AutoLogoutOptions 参数 参数类型 描述 sbc_logout_waiting_time Integer 会话断连保留时长（分钟）。 表39 VirtualChannel 参数 参数类型 描述 virtual_channel_control_enable Boolean 是否开启虚拟通道策略设置。取值为：false：表示关闭。true：表示开启。 options VirtualChannelOptions object 虚拟通道策略控制的选项。 表40 VirtualChannelOptions 参数 参数类型 描述 custom_virtual_channel_name String 自定义虚拟通道注册名。 virtual_channel_plugin_details String 虚拟通道下载配置信息，需Base64加密。 third_party_plugin_name String 第三方插件名称。 表41 keyboard_mouse 参数 参数类型 描述 mouse_feedback String 虚拟机鼠标回馈。取值为： SELFADAPTION：自适应鼠标回馈。 FORCE：强制鼠标回馈。 CLOSE：关闭鼠标回馈。 mouse_simulation_mode String 虚拟机鼠标模拟方式。取值为： ABSOLUTE_POSITION：绝对位置模拟。 RELATIVE_POSITION：相对位置模拟。 external_cursor_feedback Boolean 虚拟机外部光标反馈。取值为： false：表示关闭。 true：表示开启。 表42 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 是否开启P CS C控制。取值为：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 虚拟通道带宽控制的选项。 表43 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 虚拟通道带宽百分比控制的选项。 表44 DisplayBandwidthPercentageOptions 参数 参数类型 描述 display_bandwidth_percentage_value Integer 显示带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表45 MultimediaBandwidthPercentageOptions 参数 参数类型 描述 multimedia_bandwidth_percentage_value Integer 多媒体带宽百分比控制量（%）。取值范围为[0-100]。默认：50。 表46 UsbBandwidthPercentageOptions 参数 参数类型 描述 usb_bandwidth_percentage_value Integer USB带宽百分比控制量（%）。取值范围为[0-100]。默认：100。 表47 PcscBandwidthPercentageOptions 参数 参数类型 描述 pcsc_bandwidth_percentage_value Integer PCSC带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表48 TwainBandwidthPercentageOptions 参数 参数类型 描述 twain_bandwidth_percentage_value Integer TWAIN带宽百分比控制量（%）。取值范围为[0-100]。默认：15。 表49 PrinterBandwidthPercentageOptions 参数 参数类型 描述 printer_bandwidth_percentage_value Integer 打印机带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表50 ComBandwidthPercentageOptions 参数 参数类型 描述 com_bandwidth_percentage_value Integer 串口带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表51 FileRedirectionBandwidthPercentageOptions 参数 参数类型 描述 file_redirection_bandwidth_percentage_value Integer 文件重定向带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表52 ClipboardBandwidthPercentageOptions 参数 参数类型 描述 clipboard_bandwidth_percentage_value Integer 剪切板带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表53 SecureChannelBandwidthPercentageOptions 参数 参数类型 描述 secure_channel_bandwidth_percentage_value Integer 安全通道带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表54 CameraBandwidthPercentageOptions 参数 参数类型 描述 camera_bandwidth_percentage_value Integer 摄像头带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表55 VirtualChannelBandwidthPercentageOptions 参数 参数类型 描述 virtual_channel_bandwidth_percentage_value Integer 虚拟通道带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表56 DisplayBandwidthControlOptions 参数 参数类型 描述 display_bandwidth_control_value Integer 显示带宽控制量（Kbps）。取值范围为[500-50000]。默认：20000。 表57 MultimediaBandwidthControlOptions 参数 参数类型 描述 multimedia_bandwidth_control_value Integer 多媒体带宽控制量（Kbps）。取值范围为[5000-20000]。默认：15000。 表58 UsbBandwidthControlOptions 参数 参数类型 描述 usb_bandwidth_control_value Integer USB带宽控制量（Kbps）。取值范围为[1000-30000]。默认：30000。 表59 PcscBandwidthControlOptions 参数 参数类型 描述 pcsc_bandwidth_control_value Integer PCSC带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表60 TwainBandwidthControlOptions 参数 参数类型 描述 twain_bandwidth_control_value Integer TWAIN带宽控制量（Kbps）。取值范围为[2000-10000]。默认：5000。 表61 PrinterBandwidthControlOptions 参数 参数类型 描述 printer_bandwidth_control_value Integer 打印机带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表62 ComBandwidthControlOptions 参数 参数类型 描述 com_bandwidth_control_value Integer 串口带宽控制量（Kbps）。取值范围为[500-2000]。默认：1000。 表63 FileRedirectionBandwidthControlOptions 参数 参数类型 描述 file_redirection_bandwidth_control_value Integer 文件重定向带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表64 ClipboardBandwidthControlOptions 参数 参数类型 描述 clipboard_bandwidth_control_value Integer 剪切板带宽控制量（Kbps）。取值范围为[100-2000]。默认：1000。 表65 SecureChannelBandwidthControlOptions 参数 参数类型 描述 secure_channel_bandwidth_control_value Integer 安全通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表66 CameraBandwidthControlOptions 参数 参数类型 描述 camera_bandwidth_control_value Integer 摄像头带宽控制量（Kbps）。取值范围为[0-10000]。默认：10000。 表67 VirtualChannelBandwidthControlOptions 参数 参数类型 描述 virtual_channel_bandwidth_control_value Integer 虚拟通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：20000。 表68 custom 参数 参数类型 描述 custom_configuration1_enable Boolean 自定义策略配置项1： false: 表示关闭 true: 表示开启 options CustomOptions object 自定义策略设置项。 表69 CustomOptions 参数 参数类型 描述 custom_configuration1_rule String 配置项1内容。 状态码： 400 表70 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表71 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表72 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 config_name String 配置名称。 config_value String 配置值，使用Json字符串,'{"share_space_name":“协同空间”, "use_share_password":是否使用协同密码：true/false, "allow_anonymous":是否匿名加入协同:true/false, "audio_and_video":是否使用音频,"AUDIO"/"NONE"/"AUDIO_AND_VIDEO","keyboard_mouse_ctl": 云桌面 是否可用键鼠true/false,"anonymous_input_ctrl":是否开启匿名用户键鼠输入权限true/false, "is_user_confirm_enabled":是否需要用户应答true/false,"wait_confirm_time":等待时间30-180s}。' 状态码： 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接口进行解密。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 正常。 { "config_name" : "share-space-user-conf", "config_value" : "'{\"share_space_name\":\"协同空间\", \"use_share_password\":true, \"allow_anonymous\":true, \"audio_and_video\":\"AUDIO\",\"keyboard_mouse_ctl\":false, \"anonymous_input_ctrl\":false, \"is_user_confirm_enabled\":false,\"wait_confirm_time\":30}'", "if_show_share_space" : true }