文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 用户标签/ 获取用户标签头 - ListUserTagHead
更新时间:2025-11-25 GMT+08:00
分享

获取用户标签头 - ListUserTagHead

功能介绍

获取用户标签头。

授权信息

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

URI

GET /v1/{project_id}/tags/head

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释:

标签类型,分为用户标签及用户组标签。

约束限制:

不涉及

取值范围:

  • user:用户类型标签

  • userGroup:用户组类型标签

默认取值:

不涉及

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 UserTagVo objects

数据。

表5 UserTagVo

参数

参数类型

描述

tag_description

String

参数解释:

标签描述。

取值范围:

不涉及

tag_id

String

参数解释:

标签ID。

取值范围:

不涉及

tag_name

String

参数解释:

标签名称。

取值范围:

不涉及

tag_type

String

参数解释:

标签类型,分为用户标签及用户组标签。

取值范围:

  • user:用户类型标签

  • userGroup:用户组类型标签

请求示例

获取用户标签头。

GET https://{endpoint}/v1/{project_id}/tags?type=user

响应示例

状态码

状态码

描述

200

用户标签列表。

错误码

请参见错误码

相关文档