# 导入用户列表 - ImportUserList
#### 功能介绍
该接口用于导入用户列表。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ImportUserList)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                        | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:users:importUser | Write | user \*     | -   | -  | -      |
     
  
 
#### URI
POST /v2/{project_id}/users/desktop-users/action/import
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
表2Query参数 
| 参数        | 是否必选 | 参数类型   | 描述       |
|:---|:---|:---|:---|
| vpc_id    | 否    | String | 虚拟私有云ID。 |
| subnet_id | 否    | String | 子网id。    |
   
#### 请求参数
表3FormData参数 
| 参数   | 是否必选 | 参数类型 | 描述      |
|:---|:---|:---|:---|
| file | 否    | File | 导入用户文件。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数                            | 参数类型                                                                              | 描述                                                           |
|:---|:---|:---|
| error_code                    | String                                                                            | 错误码。                                                         |
| error_msg                     | String                                                                            | 错误描述。                                                        |
| error_detail                  | String                                                                            | 错误详情。                                                        |
| encoded_authorization_message | String                                                                            | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
| user_detail_list              | Array of [DesktopUserDetail] objects | 成功列表。                                                        |
| failed_detail_list            | Array of [DesktopUserDetail] objects | 失败列表。                                                        |
| total_count                   | Integer                                                                           | 用户列表数量。                                                      |
   
 表5DesktopUserDetail 
| 参数               | 参数类型   | 描述                    |
|:---|:---|:---|
| id               | String | 用户id。                 |
| user_name        | String | 用户名。                  |
| domain           | String | 用户所属域，domain为空时，默认主域。 |
| user_email       | String | 邮箱。                   |
| permission_group | String | 权限组。                  |
| desktop_name     | String | 桌面名称。                 |
| desktop_ip       | String | 桌面ip。                 |
| description      | String | 描述。                   |
   
**状态码：400**
表6响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：401**
表7响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：403**
表8响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：404**
表9响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：405**
表10响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：500**
表11响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：503**
表12响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
#### 请求示例
```
{
  "file" : "file"
}
```
#### 响应示例
**状态码：200**
导入用户列表响应。
```
{
  "user_detail_list" : [ {
    "id" : "2",
    "user_name" : "lzz",
    "user_email" : "lzz@huawei.com",
    "permission_group" : "default",
    "desktop_name" : "lzz"
  }, {
    "id" : "3",
    "user_name" : "lzz",
    "user_email" : "lzz@huawei.com",
    "permission_group" : "default",
    "desktop_name" : "lzz2"
  } ],
  "failed_detail_list" : [ {
    "id" : "4",
    "user_name" : "lzz",
    "user_email" : "lzz@huawei.com",
    "permission_group" : "default",
    "desktop_name" : "lzz3"
  } ],
  "total_count" : 3
}
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 导入用户列表响应。               |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。