华为云用户手册

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 待删除的桌面ID列表。 delete_users 否 Boolean 删除桌面后，如果当前用户没有其它桌面，可以删除桌面用户。true：删除用户，false：不删除用户，默认为false。 email_notification 否 Boolean 是否邮件通知，true：邮件通知，false：不通知，默认值true。 is_force_delete 否 Boolean 是否强制删除，true：强制删除，false：不强制删除

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 409 表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接口进行解密。

请求示例 POST /v2/fb2e5ec048384c8f9469d22db0037908/workspaces { "ad_domains" : { "domain_type" : "LITE_AS" }, "vpc_id" : "e8f985fa-5161-4cb8-bf5a-155058ea58c9", "subnet_ids" : [ { "subnet_id" : "067b30a9-1b73-4804-a808-699c5f6c4e09" } ], "access_mode" : "INTERNET", "is_send_email" : true } { "ad_domains" : { "domain_type" : "LOCAL_AD", "domain_admin_account" : "vdsadmin", "active_domain_ip" : "192.161.43.66", "standby_domain_ip" : "192.161.43.67", "domain_name" : "xxxx.xxxx.com", "domain_password" : "xxxxxxxxxx@", "active_domain_name" : "AD-xxx-0001.vdesktop.huawei.com", "active_dns_ip" : "192.161.43.66", "standby_domain_name" : "AD-xxx-0002.vdesktop.huawei.com", "standby_dns_ip" : "192.161.43.67" }, "vpc_id" : "27823fc4-5808-4f3b-a5bc-24c7a80742b8", "subnet_ids" : [ { "subnet_id" : "598d4599-059f-40ca-9cce-841b784d13e6" } ], "access_mode" : "INTERNET", "is_send_email" : true } { "ad_domains" : { "domain_type" : "LOCAL_AD", "domain_admin_account" : "vdsadmin", "active_domain_ip" : "192.161.43.66", "standby_domain_ip" : "192.161.43.67", "domain_name" : "xxxx.xxxx.com", "domain_password" : "xxxxxxxxxx@", "active_domain_name" : "AD-xxx-0001.vdesktop.huawei.com", "active_dns_ip" : "192.161.43.66", "standby_domain_name" : "AD-xxx-0002.vdesktop.huawei.com", "standby_dns_ip" : "192.161.43.67" }, "vpc_id" : "27823fc4-5808-4f3b-a5bc-24c7a80742b8", "subnet_ids" : [ { "subnet_id" : "598d4599-059f-40ca-9cce-841b784d13e6" } ], "access_mode" : "DEDICATED", "is_send_email" : true, "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 ad_domains 是 AdDomain object 域信息。 enterprise_id 否 String 企业ID。 企业ID是您在 云桌面 服务的唯一标识，终端用户登录时需要填写企业ID，若不自定义设置企业ID，系统将自动生成您的企业ID。格式为由半角数字、字母、_-组成，长度范围小于等于32个字符。 vpc_id 否 String VPC ID。 subnet_ids 否 Array of Subnet objects 指定业务子网的网络ID，子网不能与172.16.0.0/12冲突。 manage_subnet_cidr 否 String 管理子网网段。 注：不能与172.16.0.0/12以及subnet_ids参数下子网的网段冲突。 access_mode 否 String 接入方式。 INTERNET：表示Internet接入。 DEDICATED：表示专线接入。 BOTH：表示两种接入方式都支持。 apply_shared_vpc_dedicated_param 否 ApplySharedVpcDedicatedParam object 共享Vpc专线入参 dedicated_subnets 否 String 专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。 is_send_email 否 Boolean 桌面退订是否发送邮件通知。 表4 AdDomain 参数 是否必选 参数类型 描述 domain_type 是 String 域类型。 LITE_AS：本地认证。 LOCAL_AD：本地AD。 说明：域类型为“LOCAL_AD”时，请确保所选VPC网络与AD所属网络可连通。 domain_name 否 String 域名 称。域类型为LOCAL_AD时需要配置。 域名必须为AD服务器上已经存在的域名，且长度不超过55。 domain_admin_account 否 String 域管理员帐号。域类型为LOCAL_AD时需要配置。 必须为AD服务器上已经存在的域管理员帐号。 domain_password 否 String 域管理员账号密码。域类型为LOCAL_AD时需要配置。 active_domain_ip 否 String 主域控制器IP地址。域类型为LOCAL_AD时需要配置。 active_domain_name 否 String 主域控制器名称。域类型为LOCAL_AD时需要配置。 standby_domain_ip 否 String 备域控制器IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。 standby_domain_name 否 String 备域控制器名称。域类型为LOCAL_AD时且配置备节点时需要配置。 active_dns_ip 否 String 主DNS IP地址。域类型为LOCAL_AD时需要配置。 standby_dns_ip 否 String 备DNS IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。 delete_computer_object 否 Integer 是否在删除桌面的同时删除AD上对应的计算机对象，0代表不删除，1代表删除。 use_ldaps 否 Boolean 是否开启LDAPS。 tls_config 否 TlsConfig object TLS信息。 表5 TlsConfig 参数 是否必选 参数类型 描述 cert_pem 否 String pem内容, 有则更新，无则上传。查询不返回。 cert_start_time 否 String 证书生效开始时间，时间参考样例 2022-01-25T09:24:27。 cert_end_time 否 String 证书生效截止时间，时间参考样例 2022-01-25T09:24:27。 表6 Subnet 参数 是否必选 参数类型 描述 subnet_id 是 String 子网的网络ID。 表7 ApplySharedVpcDedicatedParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的共享Vpc专线地址 port 否 Integer 租户指定共享Vpc专线地址端口 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区

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

响应示例 状态码： 200 查询云办公服务详情响应。 { "id" : "8aa1908f74824d8701748bf039600065", "status" : "SUBSCRIBED", "config_status" : "0", "closable" : false, "ad_domains" : { "domain_type" : "LOCAL_AD", "domain_admin_account" : "vdsadmin", "active_domain_name" : "ecs-ad.vdesktop.com", "active_domain_ip" : "192.168.0.131", "standby_domain_name" : "", "standby_domain_ip" : "", "active_dns_ip" : "192.168.0.131", "standby_dns_ip" : "", "domain_name" : "vdesktop.com", "use_ldaps" : true, "tls_config" : { "cert_start_time" : "2022-01-25T09:24:27", "cert_end_time" : "2023-01-25T09:34:27" } }, "vpc_id" : "fd3b4069-ac1e-45d2-ba27-4c18cd692d26", "vpc_name" : "vpc-be75", "dedicated_access_address" : "https://192.168.0.53", "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16", "internet_access_address" : "https://172.16.25.134", "internet_access_port" : "443", "access_mode" : "BOTH", "subnet_ids" : [ { "subnet_id" : "5dee0216-2260-47c2-9368-98a27d910e55" } ], "management_subnet_cidr" : "192.168.0.0/24", "infrastructure_security_group" : { "id" : "ffba6eda-5170-4343-b8a3-c306e0f21c88", "name" : "WorkspaceManagerSecurityGroup" }, "desktop_security_group" : { "id" : "04abbdf6-e848-4c90-bdb1-6de856fa8a34", "name" : "WorkspaceUserSecurityGroup" }, "progress" : "100%", "access_status" : "openSuccess", "is_send_email" : true, "authorized_collect_log" : false, "authorized_hda_upgrade" : false, "vpc_config_infos" : [ { "vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc1", "subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet1" ], "default_access_vpc" : true }, { "vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc2", "subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet3" ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 唯一标识ID。 ad_domains AdInfo object 域信息。 vpc_id String VPC ID。 vpc_name String VPC名称。 access_mode String 接入方式。 INTERNET：表示互联网接入。 DEDICATED：表示专线接入。 BOTH：表示同时支持互联网接入和专线接入。 adn_conflict_network String ADN上网冲突网段列表，多个网段信息用分号隔开，列表长度不超过50。 dedicated_subnets String 专线接入网段，只有access_mode为“DEDICATED”或“BOTH”时才会返回该参数。 dedicated_access_address String 专线接入地址，只有access_mode为“DEDICATED”或“BOTH”时才会返回该参数。 internet_access_address String 互联网接入地址，只有access_mode为“INTERNET”或“BOTH”时才会返回该参数。 internet_access_port String 互联网接入端口。 status String 云办公服务的状态。 PREPARING：准备开通。 SUBSCRIBING：开通中。 SUBSCRIBED：已开通。 SUBSCRIPTION_FAILED：开通失败。 DEREGISTERING：销户中。 DEREGISTRATION_FAILED：销户失败。 RECYCLING：清理资源中。 RECYCLED：清理资源成功。 RECYCLE_FAILED：清理资源失败。 CLOSED：已销户未开通。 access_status String 互联网和专线切换任务的状态。 init： 初始化 - 开通服务后的初始状态。 available： 可用 - 执行过任务且成功后恢复的正常状态。 internetOpening： 开启中 - 开通互联网接入开启中。 dedicatedOpening： 开启中 - 开通专线接入开启中。 internetOpenFailed： 开启失败 - 开通互联网接入开启失败。 dedicatedOpenFailed： 开启失败 - 开通专线接入开启失败。 openSuccess： 开启成功 - 开通接入方式成功。 internetClosing： 关闭中 - 关闭互联网接入关闭中。 dedicatedClosing： 关闭中 - 关闭专线接入关闭中。 internetCloseFailed： 关闭失败 - 关闭互联网接入方式失败。 dedicatedCloseFailed： 关闭失败 - 关闭专线接入方式失败。 closeSuccess： 关闭成功 - 关闭接入方式成功。 internetAccessPortModifying： 互联网接入端口修改中。 internetAccessPortModifyFailed： 端口修改失败。 subnet_ids Array of SubnetInfo objects 业务子网，可以指定返回的网络ID订购桌面。 management_subnet_cidr String 管理组件的子网网段。 infrastructure_security_group SecurityGroup object 开通服务会在指定的VPC下创建管理组件的安全组。 desktop_security_group SecurityGroup object 开通服务会在指定的VPC下创建桌面的安全组。 closable Boolean 是否可以取消服务。 config_status String 配置状态。 "0"： 开通服务成功，且对接AD成功。 "1"： 开通服务成功，但AD配置失败。 "2"： 开通服务成功，但AD配置失败后存在其他错误。 "3"： 开通服务成功，AD未开启对接。 progress String 开通服务或注销服务的进度，格式为百分比，如：100%。 job_id String 开通服务或取消服务的任务ID。 fail_code Integer 失败错误码。 fail_reason String 失败原因。 enterprise_id String 企业ID。 enterprise_project_id String 企业项目ID。 is_send_email Boolean 桌面退订是否发送邮件通知。 authorized_collect_log Boolean 是否授权收集日志。 authorized_hda_upgrade Boolean 是否授权hda升级。 dc_vnc_ip String 自定义的专线VNC地址 is_authorized_install_agent Boolean 是否授权桌面自动安装agent插件。 is_support_ipv6 Boolean 是否支持ipv6。 enable_user_create_snapshot Boolean 是否授权最终租户创建快照。 表4 AdInfo 参数 参数类型 描述 domain_type String 域类型。 LITE_AS：本地认证。 LOCAL_AD：本地AD。 domain_name String 域名，域类型为LOCAL_AD时有值。 domain_admin_account String 域管理员帐号，域类型为LOCAL_AD时有值。 active_domain_name String 主域控制器名称，域类型为LOCAL_AD时有值。 active_domain_ip String 主域控制器IP地址，域类型为LOCAL_AD时有值。 standby_domain_name String 备域控制器名称，域类型为LOCAL_AD时有值。 standby_domain_ip String 备域控制器IP地址，域类型为LOCAL_AD时有值。 active_dns_ip String 主DNS IP地址，域类型为LOCAL_AD时有值。 standby_dns_ip String 备DNS IP地址，域类型为LOCAL_AD时有值。 delete_computer_object String 是否在删除桌面的同时删除AD上对应的计算机对象，'0'代表不删除，'1'代表删除。 use_ldaps Boolean 是否开启LDAPS。 tls_config TlsConfig object TLS信息。 表5 TlsConfig 参数 参数类型 描述 cert_pem String pem内容, 有则更新，无则上传。查询不返回。 cert_start_time String 证书生效开始时间，时间参考样例 2022-01-25T09:24:27。 cert_end_time String 证书生效截止时间，时间参考样例 2022-01-25T09:24:27。 表6 SubnetInfo 参数 参数类型 描述 subnet_id String 子网的网络ID。 表7 SecurityGroup 参数 参数类型 描述 id String 安全组ID。 name String 安全组名称。 状态码： 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接口进行解密。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 job_id String 重建系统盘总任务id。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 409 表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参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 计算机id列表。 image_type 是 String 镜像类型。 image_id 是 String 模板ID。 os_type 否 String os类型。 delay_time 否 Integer 立即重建时给用户预留的保存数据的时间（单位：分钟）。 message 否 String 下发重建系统盘任务时，给用户发送的提示信息。 order_id 否 String 订单ID，包周期桌面重建系统盘，涉及收费镜像时需传 enterprise_project_id 否 String 企业项目ID，默认"0"

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 op_type 是 String 操作类型，可选值为： LOCK：锁定用户。 UNLOCK：解锁用户。 RESET_PWD：重置用户密码。

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 computer_name String 桌面名称 computer_id String 桌面ID network_infos Array of NetworkInfo objects 桌面网络信息 表4 NetworkInfo 参数 参数类型 描述 vpc_info Vpc object vpc信息 subnet_info DesktopSubnet object 子网信息 port_info Port object 私有IP信息。 public_ip_info PublicIp object 弹性IP信息。 security_groups Array of SecurityGroup objects 桌面绑定的安全组列表 表5 Vpc 参数 参数类型 描述 id String 桌面所在vpcId name String 桌面所在vpc名称 cidr String 桌面所在vpc网段 表6 DesktopSubnet 参数 参数类型 描述 id String 桌面所在子网Id name String 桌面所在子网名称 cidr String 桌面所在子网网段 表7 Port 参数 参数类型 描述 id String 私有IP唯一标识 ip_address String 私有IP地址 表8 PublicIp 参数 参数类型 描述 id String 弹性IP唯一标识 public_ip_address String 弹性IP地址 表9 SecurityGroup 参数 参数类型 描述 id String 安全组ID。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 409 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求URI 请求URI由如下部分组成： {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“管理员创建IAM用户”接口的resource-path为“/v3.0/OS-USER/users”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint（比如“华北-北京四”区域的Endpoint：“iam.cn-north-4.myhuaweicloud.com”，并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 Authorization：签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考AK/SK认证。 X-Sdk-Date：请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考AK/SK认证。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID：子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID：账号ID，可选。AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。 对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码，并在Content-type中声明字符编码方式，例如：Content-Type: application/json; charset=utf-8。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policy_objects_list Array of AccessPolicyObject objects 查询接入策略应用对象响应。 total Integer 对象总数。 表5 AccessPolicyObject 参数 参数类型 描述 object_id String 黑名单中的对象id。 object_name String 对象名。 object_type String 对象类型。 USER： 用户 USERGROUP： 用户组 状态码： 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接口进行解密。

响应示例 状态码： 200 应用对象列表。 { "policy_objects_list" : [ { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_name" : "test1", "object_type" : "USER" }, { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_name" : "test2", "object_type" : "USER" } ], "total" : 2 }

URI GET /v2/{project_id}/access-policy/{access_policy_id}/objects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 access_policy_id 是 String 接入策略id。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页数量,范围0-2000,默认10。 offset 否 Integer 偏移量,范围0-1999,默认0。

响应参数 状态码： 400 表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参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 scheduled_type 否 String 执行周期类型，可选值为： FIXED_TIME：指定时间。 DAY：按天。 WEEK：按周。 MONTH：按月。 LIFE_CYCLE：指定场景下触发。 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。 scheduled_date 否 String 周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。 scheduled_time 否 String 指定的执行时间点，格式为HH:mm:ss。 expire_time 否 String 到期时间，格式为yyyy-MM-dd HH:mm:ss。 gray_count 否 Integer 灰度对象数量，优先级高于gray_desktop_ids。只支持脚本执行。 gray_desktop_ids 否 Array of strings 灰度执行的桌面id列表，优先级低于gray_count。只支持脚本执行。 gray_fail_threshold 否 Integer 灰度失败阈值，灰度执行失败次数达到该值时，不执行下一批任务。只支持脚本执行。 life_cycle_type 否 String 触发场景。POST_CREATE_DESKTOP_SUC CES S：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后，POST_DESKTOP_DISCONNECTED：桌面断开连接后。 time_zone 否 String 时区。 task_name 否 String 任务名称。 force_execute 否 Boolean 是否强制执行 description 否 String 描述。 enable 否 Boolean 是否启用 extra_params 否 String 扩展参数，json格式。 apply_objects 否 Array of ApplyObject objects 定时任务应用的对象列表。 priority 否 Integer 优先级。触发式任务使用。 is_gray 否 Boolean 任务是否灰度执行，供远程脚本使用。 wait_time 否 Integer 触发式任务触发后，等待时长。 表4 ApplyObject 参数 是否必选 参数类型 描述 object_id 否 String 对象ID。 object_type 否 String 对象类型，可选值为： DESKTOP：桌面。 DESKTOP_POOL：桌面池。 ALL_DESKTOPS: 所有桌面，仅供触发式任务使用。 DESKTOP_TAG：桌面标签

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

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于管理员创建IAM用户接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "Request body is invalid.", "error_code": "IAM.0011" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应参数 状态码： 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 用来匹配用户组的搜索关键字。例如根据组名模糊查询。

响应示例 状态码： 200 查询用户组响应。 { "total_count" : 2, "user_groups" : [ { "id" : "99558194716db7d601719f9b61850042", "sid" : "99558194716db7d601719f9b61850042", "name" : "group1", "realm_id" : "695581943266db7a601719f9e61850058", "domian" : "local.com", "description" : "for test", "platform_type" : "LOCAL", "create_time" : "2023-02-15T02:27:05.000Z", "user_quantity" : 10 }, { "id" : "99558194716db7d601719f9b61850000", "sid" : "99558194716db7d601719f9b61850000", "name" : "group2", "realm_id" : "453381943266db7a601719f9e61850044", "domian" : "local.com", "description" : "for test2", "platform_type" : "LOCAL", "create_time" : "2023-01-16T02:27:05.000Z", "user_quantity" : 20 } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 扩容磁盘任务ID。 状态码： 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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_volumes_expansion 否 Array of ExpandVolumesReq objects 扩容磁盘参数。 表4 ExpandVolumesReq 参数 是否必选 参数类型 描述 desktop_id 否 String 桌面ID。 volume_id 否 String 磁盘ID。 new_size 否 Integer 扩容后的磁盘大小，单位为GB。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 desktop_name_policy_infos Array of DesktopNamePolicyInfo objects 桌面名称策略信息。 total_count Integer 查询返回总条数。 表5 DesktopNamePolicyInfo 参数 参数类型 描述 policy_id String 策略id。 policy_name String 策略名称。 name_prefix String 策略前缀。 digit_number Integer 策略后缀有效位数。 start_number Integer 策略后缀起始数字。 single_domain_user_inc Integer 是否单用户名递增。 1 单用户名递增。 0 租户递增。 is_default_policy Boolean 是否为默认策略，true默认策略。 is_contain_user Boolean 是否包含用户名的桌面名称策略，true包含。 状态码： 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接口进行解密。