文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 通行证管理/ 获取已分配通行证的用户列表(不包含未激活) - ListQuotaUserList
更新时间:2025-11-25 GMT+08:00
分享

获取已分配通行证的用户列表(不包含未激活) - ListQuotaUserList

功能介绍

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/{project_id}/quota-users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

account_name

String

参数解释:

用户名。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sys_role

String

参数解释:

系统角色。

约束限制:

不涉及

取值范围:

  • 1:通用角色

  • 2:只读用户

默认取值:

不涉及

type

String

参数解释:

角色类型。

约束限制:

不涉及

取值范围:

  • IAM:IAM用户

  • SELF-BUILT:自定义用户

默认取值:

不涉及

sort_key

String

参数解释:

排序字段。

约束限制:

不涉及

取值范围:

  • effectiveTime:生效时间

  • accountName:用户名称

默认取值:

不涉及

sort_dir

String

参数解释:

排序类型。

约束限制:

不涉及

取值范围:

  • asc: 升序

  • desc: 降序

默认取值:

asc

offset

Integer

参数解释:

分页查询偏移量。

约束限制:

不涉及

取值范围:

[0,1000]

默认取值:

0

limit

Integer

参数解释:

返回条目数。

约束限制:

不涉及

取值范围:

[1,1000]

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

数据总量。

取值范围:

不涉及

page_data

Array of page_data objects

数据

表5 page_data

参数

参数类型

描述

user_id

String

参数解释:

用户id。

取值范围:

不涉及

account_name

String

参数解释:

用户名称。

取值范围:

不涉及

user_type

String

参数解释:

用户类型。

取值范围:

  • IAM:IAM用户

  • SELF-BUILT:自建用户

  • DEFAULT:默认

sys_role

Integer

参数解释:

用户角色。

取值范围:

  • 0:未激活

  • 1:通用角色

  • 2:只读用户

effective_time

Long

参数解释:

生效时间戳。

取值范围:

不涉及

请求示例

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

响应示例

状态码

状态码

描述

200

获取通行证列表成功

错误码

请参见错误码

相关文档