华为云用户手册

请求参数 表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 认证应用对象类型。 AC CES S_MODE：接入类型 rule 否 String 认证应用对象。 INTERNET：互联网接入，rule_type为ACCESS_MODE时可选该值 PRIVATE：专线接入，rule_type为ACCESS_MODE时可选该值

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 group_ids 是 Array of strings 用户组ID列表。

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

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

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

URI GET /v2/{project_id}/statistics/notify-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 metric_name 否 String 指标名称(精确匹配) rule_id 否 String 通知规则ID offset 否 Integer 查询的偏移量,默认值0 limit 否 Integer 单次查询的大小[1-100],默认值10

URI GET /v2/{project_id}/statistics/metrics/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 查询起始时间(0时区) end_time 是 String 查询截至时间(0时区) username 否 String 用户名(模糊匹配) usage_min_hours 否 Integer 使用时长最小值 usage_max_hours 否 Integer 使用时长最大值 usage_min_hours和usage_max_hours同时存在时,usage_max_hours必须大于等于usage_min_hours sort_field 否 String 按照指标进行排序 user_usage - 按照用户使用时长排序 sort_type 否 String 按照指标进行排序的方向;需配合sort_field一起使用 DESC - 降序返回数据 ASC - 升序返回数据 offset 否 Integer 查询的偏移量,默认值0 limit 否 Integer limit范围[1-100],默认值0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 items Array of UserMetric objects 用户统计指标 表5 UserMetric 参数 参数类型 描述 username String 用户名称 metric Array of Metric objects 桌面使用统计信息 user_usage - 用户使用时长(单位:秒)，同一时间登录多台PC的话;相应的时间会累加 user_login_count - 用户登录次数(单位:次) user_login_success_count - 用户登录成功次数(单位:次) user_login_fail_count - 用户登录失败次数(单位:次) 表6 Metric 参数 参数类型 描述 metric_name String 指标名称 metric_value Double 指标值 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 PUT /v2/fb2e5ec048384c8f9469d22db0037908/workspaces { "access_mode" : "BOTH" } { "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" : "vdesktop.huawei.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", "use_ldaps" : true, "tls_config" : { "cert_pem" : "-----BEGIN CERTIFICATE-----\\nMIIDiTCCAnGgAwIBAgIQQdj2u+x1LJ9Dc34un\\n-----END CERTIFICATE" } } } { "access_mode" : "DEDICATED", "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16" } { "is_send_email" : false }

响应参数 状态码： 200 表9 响应Body参数 参数 参数类型 描述 job_id String 修改云办公服务属性的任务ID enterprise_id String 企业ID dc_vnc_ip String 专线vnc访问的ip 状态码： 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接口进行解密。 状态码： 500 表14 响应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参数 参数 是否必选 参数类型 描述 ad_info 否 AdDomainInfo object 域信息。 ad_domains 否 AdDomain object 域信息。 access_mode 否 String 接入模式。 INTERNET：互联网接入。 DEDICATED：专线接入。 BOTH：代表两种接入方式都支持。 dedicated_subnets 否 String 专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。 adn_conflict_network 否 String ADN上网冲突网段列表，多个网段信息用分号隔开，列表长度不超过50。 subnet_ids 否 Array of strings 子网的网络ID列表。 internet_access_port 否 String 互联网接入端口。 enterprise_id 否 String 企业ID。 is_send_email 否 Boolean 桌面退订是否发送邮件通知。 dc_vnc_ip 否 String 开通专线访问VNC功能，如果传入的是default则自动创建，如果传入的自定义的dc_vnc_ip则直接使用，如果传入的是close表示关闭自定义VNC authorized_collect_log 否 Boolean 是否授权收集日志。 authorized_hda_upgrade 否 Boolean 是否授权hda升级。 apply_shared_vpc_dedicated_param 否 ApplySharedVpcDedicatedParam object 共享Vpc专线入参 apply_dedicated_standby_network_param 否 ApplyDedicatedStandbyNetworkParam object 开通专线备用线路入参 is_authorized_install_agent 否 Boolean 是否授权桌面自动安装agent插件。 enable_user_create_snapshot 否 Boolean 是否授权最终租户创建快照。 表4 AdDomainInfo 参数 是否必选 参数类型 描述 domain_type 是 String 域类型。 LITE_AS：LiteAS。 LOCAL_AD：本地AD。 说明：域类型为“LOCAL_AD”时，请确保所选VPC网络与“LOCAL_AD”所属网络可连通。 domain_admin_account 是 String 域管理员帐号。 domain_password 是 String 域管理员账号密码。 表5 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信息。 表6 TlsConfig 参数 是否必选 参数类型 描述 cert_pem 否 String pem内容, 有则更新，无则上传。查询不返回。 cert_start_time 否 String 证书生效开始时间，时间参考样例 2022-01-25T09:24:27。 cert_end_time 否 String 证书生效截止时间，时间参考样例 2022-01-25T09:24:27。 表7 ApplySharedVpcDedicatedParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的共享Vpc专线地址 port 否 Integer 租户指定共享Vpc专线地址端口 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区 表8 ApplyDedicatedStandbyNetworkParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的专线备用地址 port 否 Integer 租户指定的专线备用地址端口 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 user_detail UserDetail object 用户详情。 表4 UserDetail 参数 参数类型 描述 description String 用户描述。 id String 用户id。 user_name String 桌面用户名。 user_email String 用户邮箱。 user_phone String 手机号。 active_type String 激活类型，默认为用户激活。 USER_ACTIVATE： 用户激活 ADMIN_ACTIVATE： 管理员激活 object_sid String 用户sid。 sam_account_name String 登录名(windows以前版本)。 user_principal_name String 用户登录名。 full_name String 全名。 distinguished_name String 用户在域树上的唯一位置。 account_type Integer 帐号类型(0：用户；1：用户组)。 when_created String UTC时间毫秒数对应的字符，格式为：yyyy-MM-ddTHH:mm:ss.SSSZ。 account_expires Long 账号有效期最后一天对应的UTC时间，以毫秒为单位。 is_pre_user Boolean 是否是预创建的用户，true表示是预创建用户，false表示不是预创建用户 user_expired Boolean 账户是否过期，true表示过期，false表示未过期。 locked Boolean 账户是否被锁定，true表示被锁定，false表示未锁定。 enable_change_password Boolean 是否允许修改密码，true表示允许修改密码，false表示不允许。 password_never_expired Boolean 密码是否永不过期，true表示密码永不过期，false表示密码会过期。 next_login_change_password Boolean 下次登录是否需要重置密码，true表示需要重置密码，false表示不需要。 disabled Boolean 账户是否禁用，true表示被禁用，false表示未禁用。 group_names Array of strings 加入的组列表。 share_space_subscription Boolean 用户是否订阅协同，true表示已订阅，false表示未订阅 share_space_desktops Integer 用户已绑定协同桌面数 total_desktops Integer 用户绑定桌面云总数。 状态码： 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接口进行解密。

响应示例 状态码： 200 查询桌面用户详细信息响应。 { "user_detail" : { "description" : "api测试用户。", "id" : "8a2c3f9579d240820179d51e6caf0001", "user_name" : "api-test", "user_email" : "test@huawei.com", "object_sid" : "8a2c3f9579d240820179d51e6caf0001", "sam_account_name" : "api-test", "full_name" : "api-test", "distinguished_name" : "api-test", "account_type" : 0, "when_created" : "2021-06-03T19:43:31.000Z", "account_expires" : 0, "user_expired" : false, "locked" : false, "enable_change_password" : true, "password_never_expired" : false, "next_login_change_password" : true, "disabled" : false, "group_names" : [ "DomainUsers" ], "total_desktops" : 0 } }

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 待解绑EIP的桌面id。

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "bc05da52-89df-45ba-8146-13fe3ce7c45a", "name" : "ApiExpirezSr5_1HgOfh56", "description" : "", "image_id" : "6579b42e-f345-4452-ae3a-fa0687564943", "os_type" : "Windows", "product_id" : "workspace.appstream.general.xlarge.2", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "system_disk_type" : "SATA", "system_disk_size" : 60, "is_vdi" : false, "app_type" : "COMMON_APP", "create_time" : "2023-06-06T14:14:36.416Z", "update_time" : "2023-06-06T14:14:38.127Z", "app_server_flavor_count" : 0, "app_server_count" : 0, "app_group_count" : 0, "image_name" : "ApiExplore_Image_01", "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", "cond_operation_az" : "cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(normal)", "domain_ids" : [ ] }, "subnet_name" : "subnet-config", "ou_name" : "" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ServerGroup objects 服务器组列表，返回列表条目数量上限为分页的最大上限值。 表5 ServerGroup 参数 参数类型 描述 id String 服务器组的唯一标识。 name String 服务器组名称。 description String 服务器组描述。 image_id String 服务器组关联的镜像ID，用于创建对应组下的云服务器。 os_type String 系统类型，当前仅支持Windows。 Linux - Windows - Other - product_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。 is_vdi Boolean 是否为vdi单会话模式。 extra_session_type String 付费会话类型： GPU - GPU规格会话。 CPU - 普通CPU规格会话。 extra_session_size Integer 付费会话个数。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app create_time String 服务器组创建时间 update_time String 服务器组更新时间 storage_mount_policy String 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 USER - 仅挂载个人目录。 SHARE - 仅挂载共享目录。 ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。 enterprise_project_id String 企业项目ID(0表示默认企业项目Id) primary_server_group_ids Array of strings 主服务器组id列表。 secondary_server_group_ids Array of strings 备服务器组id列表。 server_group_status Boolean 服务器是否处于启用状态，true表示处于启用状态 false表示处于禁用状态。 site_type String 站点类型 - CENTER/IES site_id String 站点id app_server_flavor_count Integer 服务器配置总数量。 app_server_count Integer 服务器总数量。 app_group_count Integer 关联应用组的总数量。 image_name String 镜像名称。 product_info ProductInfo object 产品规格信息。 subnet_name String 子网名称。 scaling_policy ScalingPolicy object 弹性伸缩策略。 tags Array of TmsTag objects 标签信息 ou_name String 默认组织名称。 表6 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型： BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 ADVANCED：表示产品高级套餐，套餐镜像中包括了一些商业软件。 architecture String 产品架构，当前仅支持x86。 x86 arm cpu String CPU。 cpu_desc String CPU描述。 memory String 内存大小，单位兆：M。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小。 gpu_desc String GPU描述。 descriptions String 产品描述。 charge_mode String 套餐标识。 1：表示包周期。 0：表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘。 resource_type String 资源类型。 cloud_service_type String 云服务类型。 volume_product_type String 磁盘产品类型。 sessions Integer 套餐默认支持的最大会话数。 status String 产品套餐在销售模式下的状态，取值自E CS 的cond:operation:status。 不配置时等同于normal在售状态。 normal - 正常商用 abandon - 下线（即不显示） sellout - 售罄 obt - 公测 obt_sellout - 公测售罄 promotion - 推荐(等同normal，也是商用) cond_operation_az String 产品套餐在可用区的状态，配套status使用。 说明： 此参数是AZ级配置，优选取此参数的值，某个AZ没有在此参数中配置时默认使用status参数的取值。 配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。 例如：套餐在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： “status”设置为：“abandon” 。 “cond_operation_az”设置为：“az0(normal), az1(sellout), az2(obt), az3(normal)”。 说明：如果flavor在某个AZ下的状态与status配置状态不同，必须配置该参数。 sub_product_list Array of strings 专属主机的子产品。 domain_ids Array of strings 产品属于专有的domainId。 package_type String 套餐类型： general：表示产品通用套餐。 dedicated：表示产品专属主机套餐。 expire_time String 产品套餐过期时间，产品将在改时间点后逐步下架。 support_gpu_type String 产品套餐支持的GPU类型。 表7 ScalingPolicy 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表8 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到该阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 表9 TmsTag 参数 参数类型 描述 key String 键。最大长度128个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 两头不能有空白字符。 value String 值。每个值最大长度255个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/app-server-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_group_name 否 String 服务器组名称。 server_group_id 否 String 服务器组唯一标识。 app_type 否 String 应用组类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app tags 否 String 查询tag字段中包含该值的服务器组。 enterprise_project_id 否 String 企业项目ID(字段为空或者0表示使用默认default企业项目) is_secondary_server_group 否 String 是否为备服务器组，不传默认查所有： true : 是备服务器组。 false: 主服务器组，默认。

响应示例 状态码： 200 查询租户配额响应 { "quotas" : { "resources" : [ { "type" : "general_instances", "quota" : 10, "used" : 3 }, { "type" : "volumes", "quota" : 500, "used" : 33 }, { "type" : "volume_gigabytes", "quota" : 21500, "unit" : "GB", "used" : 2090 }, { "type" : "cores", "quota" : 80, "used" : 10 }, { "type" : "Memory", "quota" : 100, "unit" : "GB", "used" : 19 }, { "type" : "gpu_instances", "quota" : 10, "used" : 0 }, { "type" : "users", "quota" : 3000, "used" : 29 }, { "type" : "policy_groups", "quota" : 10, "used" : 0 }, { "type" : "Cores", "quota" : 80, "used" : 0 } ] }, "site_quotas" : [ { "site_id" : 147258369, "resources" : [ { "type" : "gpu_instances", "quota" : 50, "used" : 0 }, { "type" : "ies_instances", "quota" : 500, "used" : 0 } ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas QuotaNoLimit object 配额信息 site_quotas Array of SiteQuotaNoLimit objects 站点配额信息，暂不包括中心站点 表4 QuotaNoLimit 参数 参数类型 描述 resources Array of ResourceNoLimit objects 配额资源列表 表5 SiteQuotaNoLimit 参数 参数类型 描述 resources Array of ResourceNoLimit objects 配额资源列表 site_id String 站点ID 表6 ResourceNoLimit 参数 参数类型 描述 type String 资源类别。 general_instances：普通桌面 Memory：内存 cores：CPU volumes：磁盘数量 volume_gigabytes：磁盘容量 gpu_instances：GPU桌面 deh：云办公主机 users：用户 policy_groups: 策略组 Cores: CPU(配额工具使用) quota Integer 配额数 used Integer 配额已用值 unit String 配额单位 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表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接口进行解密。

请求示例 { "desktop_type" : "DEDICATED", "image_type" : "gold", "image_id" : "a866298d-67db-44b0-a1f1-9d09bdddc20f", "root_volume" : { "type" : "SAS", "size" : 80 }, "availability_zone" : "az3.manage.x86", "desktops" : [ { "user_name" : "ljh-002", "user_group" : "administrators", "user_email" : "aaaaa@huawei.com" } ], "nics" : [ { "subnet_id" : "5dee0216-2260-47c2-9368-98a27d910e55" } ], "product_id" : "workspace.c2.large.windows.2", "email_notification" : true }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 eips Array of Eips objects 桌面EIP。 total_count Integer 总数。 表5 Eips 参数 参数类型 描述 id String EIP的id。 address String Eip地址。 bandwidth_size Integer 带宽大小。 eip_charge_mode String traffic（按流量计费），bandwidth（按带宽计费）。 create_time String 创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ。 attached_desktop_id String 绑定的桌面id。 attached_desktop_name String 绑定的桌面名称。 enterprise_project_id String 企业项目ID 状态码： default 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/eips 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID desktop_id 否 String 桌面ID。 desktop_name 否 String 桌面名称。 user_name 否 String 桌面所属用户。 address 否 String EIP地址。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 否 Integer 用于分页查询，返回桌面数量限制。如果不指定，则返回所有符合条件的记录。 state 否 String EIP绑定状态。 bind：表示已绑定的EIP。 unbind：表示未绑定的EIP。

URI GET /v2/{project_id}/statistics/notification-records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 metric_name 否 String 指标名称(精确匹配) (metric_name和rule_id不允许同时为空) rule_id 否 String 通知规则ID (metric_name和rule_id不允许同时为空) offset 否 Integer 查询的偏移量,默认值0 limit 否 Integer 单次查询的大小[1-100],默认值10

响应示例 状态码： 200 正常 { "desktop" : [ { "desktop_id" : "21616aa6-061d-4b2f-bd83-b230d7a9a14c", "computer_name" : "CHENMIN01", "addresses" : [ { "addr" : "172.16.253.204", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:2e:41:55", "OS-EXT-IPS:type" : "fixed" }, { "addr" : "10.0.9.55", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:d5:b3:02", "OS-EXT-IPS:type" : "fixed" } ], "ip_addresses" : [ "172.16.253.204", "10.0.9.55" ], "desktop_type" : "DEDICATED", "metadata" : { "image_name" : "copy_uos-hjg1", "metering.resourcespeccode" : "rs3.large.2.linux", "charging_mode" : "0", "metering.image_id" : "39efed30-a0db-4520-8134-19a086e14c7e", "metering.resourcetype" : "1", "os_type" : "Linux", "os_bit" : "64", "desktop_os_version" : "20" }, "flavor" : { "id" : "rs3.large.2", "links" : [ ] }, "status" : "ACTIVE", "task_status" : "", "created" : "2022-01-21T06:57:47.459Z", "login_status" : "REGISTERED", "user_name" : "chenmin", "product_id" : "workspace.k.large2.uosv20pro", "share_resource_sku" : "workspace.collaborativedesktop.6party.standard", "root_volume" : { "type" : "SAS", "size" : 90, "device" : "/dev/vda", "id" : "e4406c227a8711ecaf56fa163ed8e03f", "volume_id" : "91b9457c-ef61-4058-9e82-c86b35f15934", "create_time" : "2022-03-28T00:00:00Z", "display_name" : "workspace002" }, "data_volumes" : [ { "type" : "SATA", "size" : 10, "device" : "/dev/vdc", "id" : "fd4597cb80b311ecaf56fa163ed8e03f", "volume_id" : "230432f1-44a4-47a1-862e-cd0b65c04bd1", "create_time" : "2022-03-28T00:00:00Z", "display_name" : "workspace001" } ], "user_group" : "default", "availability_zone" : "cn-north-5a", "product" : { "product_id" : "workspace.k.large2.uosv20pro", "flavor_id" : "rs3.large.2", "type" : "BASE", "cpu" : "2", "memory" : "3072", "descriptions" : "CPU:2vCPUs,Memory:4GB", "charge_mode" : "0" }, "os_version" : "20", "sid" : "1f60adc1-941c-48b8-b5c8-64948329b7cb", "order_id" : "CS2201211457G0PUY", "tags" : [ ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务id。 状态码： default 表5 响应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列表。 eip_type 是 String 支持的类型请参考EIP服务支持的类型。可通过调用如下链接的接口查询，https://support.huaweicloud.com/api-eip/ShowPublicIpType.html。 eip_charge_mode 是 String eip带宽计费模式 TRAFFIC：按流量计费。 BANDW IDT H：按带宽计费。 bandwidth_size 是 Integer 带宽大小，单位Mbit/s。默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 enterprise_project_id 否 String 企业项目ID，默认"0" count 否 Integer 需要购买EIP的数量，当desktop_ids为空时需要填，兼容单独购买EIP场景。