获取用户列表 - ListUser
功能介绍
获取用户列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/users
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 用户数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
users | Array of GetUserRsp objects | 参数解释: 用户信息列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 用户ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name | String | 参数解释: 用户名,长度1-60之间,首位不能为数字,特殊字符只能包含下划线“_”、中划线“-”和空格。 约束限制: 不涉及 取值范围: 首位不能为数字,支持字母、数字、空格、下划线、中划线,长度为[1-60]字符。 默认取值: 不涉及 |
role | String | 参数解释: 角色类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
status | String | 参数解释: 状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
String | 参数解释: 用户邮箱,需符合邮箱格式。 约束限制: 不涉及 取值范围: 满足邮箱格式(字母、数字、下划线、点、加号、@、点、域名)。 默认取值: 不涉及 | |
phone | String | 参数解释: 用户手机号,纯数字,长度大于等于5位,小于等于32位。必须与国家码同时存在。 约束限制: 必须与areacode同时存在。 取值范围: 仅支持纯数字,长度为[5-32]个字符。 默认取值: 不涉及 |
areacode | String | 参数解释: 国家码。中国大陆为“0086”。 约束限制: 不涉及 取值范围: 仅支持纯数字 默认取值: 不涉及 |
is_domain_owner | Boolean | 参数解释: 是否domain用户。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
create_time | String | 参数解释: 用户创建时间,UTC时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
pwd_status | Boolean | 参数解释: IAM用户密码状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
update_time | String | 参数解释: 更新时间,UTC时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source | String | 参数解释: 来源,PLATFORM或者IAM。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求示例
无
响应示例
状态码:200
OK
{
"count" : 1,
"users" : [ {
"id" : "7116d09f88fa41908676fdd4b039...",
"name" : "user",
"role" : "ADMIN",
"status" : "ACTIVE",
"email" : "example@XXXX.com",
"phone" : "12345678910",
"areacode" : "0086",
"is_domain_owner" : true,
"create_time" : "2021-01-15T02:45:38Z",
"pwd_status" : true,
"update_time" : "2021-01-15T02:45:38Z",
"source" : "PLATFORM"
} ]
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
错误码
请参见错误码。

