华为云用户手册

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 job_id String 增加磁盘任务ID 状态码： 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 错误描述。 状态码： 409 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg 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 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 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" } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 auth_type 否 String 认证类型。 OTP：OTP辅助认证 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时可选该值

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 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的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 users 是 Array of CreateUserRequest objects 创建单个用户请求。 表4 CreateUserRequest 参数 是否必选 参数类型 描述 user_name 是 String 用户名称。 user_email 否 String 用户邮箱。 account_expires 否 String 账户过期时间，0表示永远不过期。时间格式：yyyy-MM-ddTHH:mm:ssZ或yyyy-MM-ddTHH:mm:ss.SSSZ。 active_type 否 String 激活类型，默认为用户激活。 USER_ACTIVATE： 用户激活 ADMIN_ACTIVATE： 管理员激活 user_phone 否 String 用户手机号。 password 否 String 用户初始密码。管理员激活模式需要输入。 enable_change_password 否 Boolean 是否允许用户更改密码，缺省值为true，后续此字段无效，创建时都为true。 next_login_change_password 否 Boolean 下次登录是否必须更改密码，缺省值为true。后续此字段无效，创建时都为true。 group_ids 否 Array of strings 用户组的专有ID列表。 description 否 String 用户描述，字符串长度区间[0, 255]。 alias_name 否 String 别名。

请求参数 表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列表。

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

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

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 tc_bind_switch 是 String 绑定开关,只取值on或off

响应示例 状态码： 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 }

响应参数 状态码： 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：表示同时支持互联网接入和专线接入。 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：销户失败。 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。 is_send_email Boolean 桌面退订是否发送邮件通知。 authorized_collect_log Boolean 是否授权收集日志。 authorized_hda_upgrade Boolean 是否授权hda升级。 dc_vnc_ip String 自定义的专线VNC地址 表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 错误描述。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表12 响应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 表8 响应Body参数 参数 参数类型 描述 job_id String 修改云办公服务属性的任务ID enterprise_id String 企业ID dc_vnc_ip String 专线vnc访问的ip 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 ad_info 否 AdDomainInfo object 域信息。 ad_domains 否 AdDomain object 域信息。 access_mode 否 String 接入模式。 INTERNET：互联网接入。 DEDICATED：专线接入。 BOTH：代表两种接入方式都支持。 dedicated_subnets 否 String 专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。 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_dedicated_standby_network_param 否 ApplyDedicatedStandbyNetworkParam object 开通专线备用线路入参 表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 ApplyDedicatedStandbyNetworkParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的专线备用地址 port 否 Integer 租户指定的专线备用地址端口 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 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 错误描述

请求参数 表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 查询桌面用户详细信息响应。 { "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, "enabled_change_password" : true, "password_never_expired" : false, "next_login_change_password" : true, "disabled" : false, "group_names" : [ "DomainUsers" ], "total_desktops" : 0 } }

响应参数 状态码： 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表示未锁定。 enabled_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 加入的组列表。 total_desktops 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 错误描述

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

URI GET /v2/{project_id}/connections/desktops/export 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 查询的起始时间。指定该参数后，返回的结果为此时间之后的所有登录记录。时间格式如：“2016-08-20T21:11Z”。终止时间不为空时，起始时间为必填参数。 end_time 否 String 查询的终止时间。指定该参数后，返回的结果为此时间之前的所有登录记录。时间格式如：“2016-08-20T21:11Z”。起始时间不为空时，终止时间为必填参数。 user_name 否 String 登录桌面的用户名。 computer_name 否 String 计算机名（操作系统信息中可见）。 terminal_type 否 String 登录桌面的终端系统类型。 language 否 String 导出语言，默认英文。 zh_CN：中文 en_US：英文

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 - File 导出用户登录信息文件。 状态码： 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的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 待解绑EIP的桌面id。

响应示例 状态码： 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 } ] }

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 表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。 状态码： 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 错误描述

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 扩容磁盘任务ID。 状态码： 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 错误描述。 状态码： 409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。