文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 通行证管理/ 获取已分配通行证的用户列表（不包含未激活）
更新时间：2024-08-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取已分配通行证的用户列表（不包含未激活）

功能介绍

获取已分配通行证的用户列表（不包含未激活）。

URI

GET /v1/{project_id}/quota-users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参考获取项目ID。

最小长度：0

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

account_name

否

String

用户名（模糊搜索）。

最小长度：0

最大长度：512

sys_role

否

String

系统角色：

  • 1通用角色；
  • 2只读用户。

最小长度：0

最大长度：128

type

否

String

角色类型：IAM、SELF-BUILT

最小长度：0

最大长度：128

sort_key

否

String

排序字段：effectiveTime、accountName

最小长度：0

最大长度：128

sort_dir

否

String

排序方式：desc、asc

最小长度：0

最大长度：128

offset

否

Integer

页数，默认0

最小值：0

最大值：1000

limit

否

Integer

每页数据数，默认10

最小值：0

最大值：1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

最小长度：0

最大长度：8192

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

数据总量。

最小值：0

最大值：2147483647

page_data

Array of 表5 objects

数据

数组长度：0-2147483647
表5 page_data

参数

参数类型

描述

user_id

String

用户id

最小长度：0

最大长度：128

account_name

String

用户名称

最小长度：0

最大长度：512

user_type

String

用户类型, IAM|SELF-BUILT|DEFAULT

最小长度：0

最大长度：128

sys_role

Integer

用户角色：

  • 0未激活；
  • 1通用角色；
  • 2只读用户。

最小值：0

最大值：128

枚举值：

  • 0
  • 1
  • 2

effective_time

Long

生效时间戳。

最小值：0

最大值：9223372036854775807

请求示例

GET https://{endpoint}/v1/{project_id}/quota-users?sort_key=accountName&sort_dir=asc&limit=10&offset=0&account_name=&sys_role=1

响应示例

无

状态码

状态码

描述

200

获取通行证列表成功。

错误码

请参见错误码。

父主题： 通行证管理

相关文档