更新时间:2025-03-10 GMT+08:00
分享

获取用户标签值

功能介绍

获取用户标签值。

URI

GET /v1/{project_id}/tags/value

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

project_id

表2 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释:

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

约束限制:

不涉及

取值范围:

以下枚举值:

  • user:用户类型标签;
  • userGroup:用户组类型标签。

默认取值:

不涉及

offset

Integer

返回条目的起始offset,默认值0。

limit

Integer

返回条目数,默认值10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

数据总量。

page_data

Array of UserTagValueItemVO objects

数据。

表5 UserTagValueItemVO

参数

参数类型

描述

user_id

String

用户Id。

account_name

String

用户名。

type

String

参数解释:

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

约束限制:

不涉及

取值范围:

以下枚举值:

  • user:用户类型标签;
  • userGroup:用户组类型标签。

默认取值:

不涉及

tag_values

Map<String,Array<String>>

用户标签值。

tag_value_info

Map<String,UserTagValueVo>

标签值信息。

表6 UserTagValueVo

参数

参数类型

描述

user_id

String

用户或用户组ID。

account_name

String

用户或用户组名称。

type

String

参数解释:

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

约束限制:

不涉及

取值范围:

以下枚举值:

  • user:用户类型标签;
  • userGroup:用户组类型标签。

默认取值:

不涉及

from_type

String

来源类型。

  • IAM:用户或用户组来源于IAM;
  • CUSTOM:自定义用户组;
  • SELF-BUILT:自定义用户。

group_path

Array of strings

用户组级别路径。

create_date

Integer

创建时间戳。

update_date

Integer

更新时间戳。

value_type

String

默认标签值类型,默认为NULL。

  • DEFAULT:默认值,采用默认标签值;
  • NULL:空值;
  • ALL:所有值;
  • ENUM:枚举值,default_value必须有枚举值配置。

value

Array of strings

枚举值。

请求示例

获取用户标签值。

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

响应示例

状态码

状态码

描述

200

查询用户标签列表成功。

错误码

请参见错误码

相关文档