华为云用户手册

URI GET /v2/{project_id}/connect-desktops 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 user_names 否 Array of strings 桌面所属用户，批量筛选，最多不超过100个用户。 connect_status 否 String 桌面的连接状态。 UNREGISTER：表示桌面未注册时的状态（桌面启动后，会自动注册）。关机后也会出现未注册的状态。 REGISTERED：表示桌面注册以后，等待用户连接的状态。 CONNECTED：表示用户已经成功连接，正在使用桌面。 DISCONNECTED：表示桌面与客户端断开会话后显示的状态，可能为关闭客户端窗口，或客户端与桌面网络断开引起。 offset 否 Integer 从查询结果中的第几条数据开始返回,用于分页查询，取值范围0-2000，默认从0开始。 limit 否 Integer 查询结果中想要返回的信息条目数量,用于分页查询，取值范围0-2000，默认值100。

响应示例 状态码：200 成功响应。 { "count" : 1, "authorizations" : [ { "account" : "user000", "app_id" : "", "app_name" : "", "app_group_id" : "575772274859184146", "app_group_name" : "开放性API创建应用组测试", "authorization_type" : "APP_GROUP", "account_type" : "USER", "domain" : "wksapp***.huawei.com", "create_at" : "2023-06-06T14:14:05.576Z" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 authorizations Array of Authorization objects 授权信息。 表5 Authorization 参数 参数类型 描述 id String 授权ID。 account_id String 用户ID(或用户组ID)。 account String 用户名(或用户组名)。 app_id String 应用ID (按照组授权时,该字段为空)。 app_name String 应用名称 (按照组授权时,该字段为空)。 app_group_id String 应用组ID。 app_group_name String 应用组名称。 authorization_type String 授权类型，基于应用(组)授权，默认为APP_GROUP授权。 APP - 按照应用授权（尚未支持）。 APP_GROUP - 按照应用组授权。 account_type String 用户类型： USER - 用户 USER_GROUP - 用户组 platform_type String 平台类型： AD - AD域 LOCAL - LiteAs SYSTEM - 系统内置 domain String 域名 城。 create_at String 发布时间。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/app-groups/actions/list-authorizations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]，默认值10。 offset 否 Integer 查询的偏移量，默认值0。 app_group_id 否 String 应用组ID。 account_id 否 String 应用授权的用户(组)ID，精确查询。 account 否 String 应用授权的用户(组)名称，精确查询。 account_type 否 String 应用授权的用户(组)类型： 'USER' - 用户 'USER_GROUP' - 用户组

响应示例 状态码：200 成功响应。 { "count" : 0, "items" : [ { "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "task_name" : "定时开机任务", "last_status" : "WAITING", "task_type" : "RESTART_SERVER", "task_cron" : "*/10 * * * * ?", "next_execution_time" : "2022-12-23 09:00:00", "schedule_task_policy" : { "enforcement_enable" : false }, "scheduled_type" : "day", "day_interval" : 1, "week_list" : "1,2,7", "month_list" : "1,3,12", "date_list" : "1,2,28,L", "time_zone" : "Asia/Shanghai", "scheduled_date" : "2022-12-23", "scheduled_time" : "09:00:00", "expire_time" : "2022-03-07T10:40:43.858Z", "description" : "用于开关机。", "is_enable" : false, "create_time" : "2022-03-07T10:40:43.858Z", "update_time" : "2024-12-25T12:49:02.230Z" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ScheduleTask objects 定时任务列表，返回列表条目数量上限为分页的最大上限值。 表5 ScheduleTask 参数 参数类型 描述 id String 定时任务主键id。 task_name String 任务名称。 last_status String job状态： WAITING - 等待 RUNNING - 运行中 SUC CES S - 完成 FAILED - 失败 task_type String 定时任务类型： RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 task_cron String 定时任务表达式。 next_execution_time String 下一次执行时间。 schedule_task_policy ScheduleTaskPolicy object 定时任务策略。 scheduled_type String 执行周期： FIXED_TIME - 指定时间 DAY - 按天 WEEK - 按周 MONTH - 按月 day_interval Integer 周期按天时：按x天间隔执行。 week_list String 周期按周时：取值1~7，英文逗号分隔，如1,2,7。 month_list String 周期按月时：取值1~12，英文逗号分隔，如1,3,12。 date_list String 周期按月时：取值1~31及L(代表当月最后一天)，英文逗号分隔，如1,2,28,L。 time_zone String 时区。 scheduled_date String 周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。 scheduled_time String 指定的执行时间点，格式为HH:mm:ss。 expire_time String 到期时间。 description String 任务描述。 is_enable Boolean 是否是开启状态。 create_time String 创建时间。 update_time String 更新时间。 表6 ScheduleTaskPolicy 参数 参数类型 描述 enforcement_enable Boolean 当存在会话的时候，是否强制执行，强制执行开关。取值为： false：表示关闭。 true：表示开启。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/schedule-task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量，默认值0。 limit 否 Integer 查询的数量，值区间[1-100]，默认值10。 task_name 否 String 定时任务名称。 task_type 否 String 任务类型： RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 share_space_id String 协同空间ID。 status String 协同空间状态 OPEN 协同空间已创建 CLOSE 协同空间已关闭 WAIT_USER_CONFIRM 等待用户确认进入远程协助 WAIT_USER_ACCESS 等待用户进入远程协助 desktop_id String 桌面的desktopId。 initiator_type String 发起方类型 ADMIN_INITIATE 管理员发起 ENDUSER_INITIATE 终端用户发起 状态码：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接口进行解密。 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 校验结果。 { "ports" : [ { "id" : "string", "status" : "string", "network_id" : "string", "fixed_ips" : [ { "subnet_id" : "string", "ip_address" : "string" } ] } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 ports Array of NeutronPort objects 端口列表。 表5 NeutronPort 参数 参数类型 描述 id String 端口唯一标识。 status String 私有ip状态。 network_id String 端口所属网络的ID。 fixed_ips Array of FixedIp objects 端口IP。 表6 FixedIp 参数 参数类型 描述 subnet_id String 所属子网ID。 ip_address String 端口IP地址。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/ports 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始资源ID。 limit 否 Integer 分页查询每页返回的记录个数。 ip_address 否 String ip地址。 subnet_id 否 String 子网ID。 is_used 否 Boolean 是否被使用。

响应参数 状态码：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 获取云市场镜像列表响应。 { "images" : [ { "image_id" : "string", "min_disk" : 0, "created_at" : "2023-09-21T01:12:11Z", "image_size" : "string", "updated_at" : "2023-09-21T12:00:44Z", "product_code" : "string", "max_ram" : "string", "market_resource_type_code" : "string", "min_ram" : 0, "os_type" : "string", "image_type" : "string", "tags" : [ "string" ], "platform" : "string", "os_bit" : "string", "os_version" : "string", "name" : "string", "market_service_type_code" : "string", "status" : "string" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 images Array of Image objects 镜像信息列表。 表5 Image 参数 参数类型 描述 image_id String 镜像id。 min_disk Integer 镜像运行需要的最小磁盘容量，单位为GB。取值为40～1024GB。 created_at String 创建时间，格式为UTC时间，yyyy-MM-ddTHH:mm:ssZ。 image_size String 镜像文件的大小，单位为字节。 updated_at String 更新时间，格式为UTC时间，yyyy-MM-ddTHH:mm:ssZ。 product_code String 市场镜像的产品ID。 max_ram String 镜像支持的最大内存，单位为MB。取值可以参考云服务器规格限制，一般不设置。 market_resource_type_code String 云市场资源类型编码。 min_ram Integer 镜像运行需要的最小内存，单位为MB。参数取值依据弹性云服务器的规格限制，默认设置为0。 os_type String 操作系统类型，目前取值Linux， Windows，Other。 image_type String 镜像类型，目前支持以下类型： 公共镜像：gold 私有镜像：private 共享镜像：shared。 tags Array of strings 镜像标签列表。 platform String 镜像平台分类。 os_bit String 操作系统位数，一般取值为“32”或者“64”。 os_version String 操作系统具体版本。 name String 镜像名称。 market_service_type_code String 云市场服务类型编码。 status 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接口进行解密。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 校验本次订单提交资源是否足额响应类。 { "is_enough" : true, "quota_remainder" : [ { "type" : "INSTANCES", "remainder" : 490, "need" : 1 }, { "type" : "VOLUME_GIGABYTES", "remainder" : 69360, "need" : 60 }, { "type" : "VOLUMES", "remainder" : 9990, "need" : 1 }, { "type" : "CORES", "remainder" : 39980, "need" : 2 }, { "type" : "MEMORY", "remainder" : 99959040, "need" : 4096 } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 is_enough Boolean 配额是否足够true：足够 false：不足。 quota_remainder Array of QuotaRemainderData objects 配额剩余数量信息。 表5 QuotaRemainderData 参数 参数类型 描述 type String 配额-资源类型： GPU_INSTANCES：GPU资源实例数，单位个。 INSTANCES：普通实例数，单位个。 VOLUME_GIGABYTES：磁盘总容量，单位GB。 VOLUMES：磁盘数量，单位个。 CORES：CPU数量，单位个。 MEMORY：内存容量，单位MB。 remainder Integer 剩余配额。 need Integer 所需配额。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/check/quota 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 是 String 产品id。 flavor_id 否 String 规格id。 subscription_num 是 Integer 订单需要创建总实例数、订购数量。 disk_size 是 Integer 单台实例所需的磁盘大小（最大系统盘1块1024、数据盘10块32768）。 disk_num 是 Integer 单台实例所需的磁盘数量（最大系统盘1块、数据盘10块）。 is_period 否 Boolean 是否包周期。 deh_id 否 String 主机id。 cluster_id 否 String 云专属分布式存储池id。

请求示例 PUT /v2/fb2e5ec048384c8f9469d22db0037908/assist-auth-config/method-config { "auth_type" : "OTP", "otp_config_info" : { "enable" : true, "receive_mode" : "VMFA", "apply_rule" : { "rule_type" : "ACCESS_MODE", "rule" : "INTERNET" } } } PUT /v2/fb2e5ec048384c8f9469d22db0037908/assist-auth-config/method-config { "auth_type" : "OTP", "otp_config_info" : { "enable" : true, "receive_mode" : "HMFA", "auth_url" : "https://10.0.0.128:8443/api/um/login", "app_id" : 123, "app_secret" : 123, "auth_server_access_mode" : "DEDICATED", "cert_content" : "cert_content", "apply_rule" : { "rule_type" : "ACCESS_MODE", "rule" : "INTERNET" } } }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 auth_type 否 String 认证类型。 OTP：OTP辅助认证 RADIUS: RADIUS认证 otp_config_info 否 OtpConfigInfo object OTP辅助认证方式配置。 表4 OtpConfigInfo 参数 是否必选 参数类型 描述 enable 否 Boolean 是否启用。 receive_mode 否 String 验证码接收模式 VMFA：虚拟MFA设备 HMFA：硬件MFA设备 auth_url 否 String 辅助认证服务器地址。 app_id 否 String 认证服务接入账号。 app_secret 否 String 认证服务接入密码。 auth_server_access_mode 否 String 辅助认证服务接入模式 INTERNET：互联网接入 DEDICATED：专线接入 SYSTEM_DEFAULT：系统默认 cert_content 否 String pem格式证书内容。 apply_rule 否 ApplyRuleInfo object 认证应用对象信息，为null时代表对所有应用对象生效。 表5 ApplyRuleInfo 参数 是否必选 参数类型 描述 rule_type 否 String 认证应用对象类型。 ACCESS_MODE：接入类型 rule 否 String 认证应用对象。 INTERNET：互联网接入，rule_type为ACCESS_MODE时可选该值 PRIVATE：专线接入，rule_type为ACCESS_MODE时可选该值

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 job_id String 分配桌面总任务id。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例 { "desktops" : [ { "desktop_id" : "b41a8cc1-4813-47a0-bf3a-7800fcd5b581" }, { "desktop_id" : "5f4ed564-14eb-44fd-8ff7-0483725a532b" }, { "desktop_id" : "dfdddcf4-f943-43b4-987b-e5785022d6c5" } ], "users" : [ { "user_id" : "3f6cc4c5d1ff4a79ab826b7964e9ff5d", "user_name" : "user1" }, { "user_id" : "21bb9f13e6ff42fb96cd62489c446935", "user_name" : "user2" } ], "assign_model" : { "assign_dimension" : "USER", "priority_strategy" : "USER_NO_DESKTOP", "desktop_assigin_user_num" : 2 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktops 否 Array of AttachInstancesDesktopInfo objects 桌面信息列表。 users 否 Array of AttachInstancesUserInfo objects 用户信息列表。 assign_model 否 AssignModelInfo object 批量分配桌面策略。 表4 AttachInstancesDesktopInfo 参数 是否必选 参数类型 描述 desktop_id 否 String 待分配的桌面ID。 user_name 否 String 桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-32]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。用户名不能与分配的机器名重名。 attach_user_infos为空时,必填,attach_user_infos优先级更高 user_email 否 String 合法用户邮箱，桌面分配成功后系统会通过发送邮件的方式通知用户。 user_group 否 String 桌面用户所属的用户组,attach_user_infos为空时,必填,attach_user_infos优先级更高。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 computer_name 否 String 桌面名，桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）；以字母开头且不允许以中划线（-）结尾；长度范围为[1-15]。 is_clear_data 否 Boolean 该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据，true：清理，false：不清理，默认值为true。 attach_user_infos 否 Array of AttachInstancesUserInfo objects 待分配的用户信息列表,只有多用户桌面分配多人时有效。 表5 AttachInstancesUserInfo 参数 是否必选 参数类型 描述 user_id 否 String 当type字段为USER时，填写用户id；当type字段为GROUP时，填写用户组id，后端服务会校验组id是否存在； user_name 否 String 桌面分配对象的名称，当type类型USER时填写用户名字；当type类型GROUP时填写用户组名称。 当type类型USER时：桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-64]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在，并且用户名不能与机器名重复。 当type类型GROUP时：只能为中文、字母、数字及特殊符号-_。 user_group 否 String 桌面用户所属的用户组。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 type 否 String 对象类型，可选值为： USER：用户。 GROUP：用户组。 表6 AssignModelInfo 参数 是否必选 参数类型 描述 assign_dimension 否 String 分配的维度，当前支持 USER: “用户为维度” DESKTOP:“桌面为维度”两种。 priority_strategy 否 String 优先分配的策略，策略名为规则为{维度}_{子策略} USER_NO_DESKTOP: 用户维度-无桌面 USER_FIXED_DESKTOP_NUM: 用户维度-桌面个数固定 DESKTOP_ASSIGN_USER_PRIORITY： 桌面维度-用户优先 DESKTOP_ASSIGN_FIXED_USER： 桌面维度-固定用户 DESKTOP_ASSIGN_USERS_OR_GROUPS： 桌面维度-为每台桌面分配所选的所有用户（组） FIXED_RELATION: 使用参数中的固定分配关系 desktop_assigin_user_num 否 Integer 每个桌面自动分配的用户数，当子策略为 DESKTOP_ASSIGN_FIXED_USER 必填。 user_assigin_desktop_num 否 Integer 每个用户自动分配桌面数，当子策略为 USER_NO_DESKTOP、USER_FIXED_DESKTOP_NUM必填。 desktop_name_policy_id 否 String 策略id，用于指定生成桌面名称策略，如果指定了桌面名称则优先使用指定的桌面名称。

响应示例 状态码：200 查询策略组中的策略项的响应。 { "policies" : { "session" : { "vdi" : { "auto_lock_enable" : true, "auto_lock_options" : { "auto_lock_minutes" : 10, "auto_disconnect" : "DISABLED", "options" : { "auto_disconnect_minutes" : 1440 } }, "disconnect_logout_enable" : 0, "disconnect_logout_options" : { "disconnect_logout_minutes" : 10 } }, "self_help_console" : true } } }

URI GET /v2/{project_id}/policy-groups/{policy_group_id}/policies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 policy_group_id 是 String 策略组id。 表2 Query参数 参数 是否必选 参数类型 描述 policy_type 否 String 根据策略类型过滤结果，不传则查询所有策略。 可选类型: 外设：Peripherals; 音频：Audio; 客户端：Client; 显示：Display; 文件与剪切板：FileAndClip; 接入控制：ClientAccessControl; 会话：SessionAutoDisconnect; 虚拟通道：VirtualChannel 水印：Watermark; 键盘鼠标：KeyboardAndMouse; 通用音视频旁路：Seamless。

响应参数 状态码：202 表3 响应Body参数 参数 参数类型 描述 job_id String 注销云办公服务的任务ID。 状态码：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接口进行解密。 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 config_infos Array of CorpConfigInfo objects 批量配置项列表。 表5 CorpConfigInfo 参数 参数类型 描述 config_key String 查询的配置configKey。 config_value String 根据configKey查到的configValue。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 tc_bind_switch 是 String 绑定开关，只取值ON或OFF。 tc_auto_bind_switch 否 String 自动绑定开关，只取值ON或OFF。 tc_auto_bind_max 否 Integer 最大绑定数量，默认值为1。

响应示例 状态码：200 OK。 { "total_count" : 2, "desktop_snapshots" : [ { "snapshot_id" : "eed156d9-02a5-46f5-8eb1-54f09ab9fbae", "snapshot_name" : "sys0420_xzx03_1713602176593", "desktop_id" : "7163a7ba-fc09-4238-ab73-0689ea7f54c3", "desktop_name" : "xzx03", "desktop_sid" : "22ad6780-3236-4838-b509-8068d254e9de", "is_system_disk" : true, "status" : "create_success", "description" : "description。", "create_time" : "2024-04-20T08:36:16Z", "create_type" : "MANUALLY" }, { "snapshot_id" : "a7e996da-20db-4de8-8aff-4c8e4c6d5ed3", "snapshot_name" : "AUTOCREATED_AA_1713595811910", "desktop_id" : "a3e8d0d0-79df-413d-a327-d702a4fb2e15", "desktop_name" : "AA", "desktop_sid" : "1346b13d-d3e4-4965-bfb4-5bb880bf7dbf", "is_system_disk" : false, "status" : "create_success", "description" : "description。", "create_time" : "2024-04-20T06:50:11Z", "create_type" : "AUTO" } ] }