获取用户标签值 - ListUserTagValue
功能介绍
获取用户标签值。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/tags/value
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
project_id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
参数解释: 标签类型,分为用户标签及用户组标签。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
offset |
否 |
Integer |
返回条目的起始offset,默认值0。 |
|
limit |
否 |
Integer |
返回条目数,默认值10。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
数据总量。 |
|
page_data |
Array of UserTagValueItemVO objects |
数据。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
用户Id。 |
|
account_name |
String |
用户名。 |
|
type |
String |
参数解释: 标签类型,分为用户标签及用户组标签。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
tag_values |
Map<String,Array<String>> |
用户标签值。 |
|
tag_value_info |
Map<String,UserTagValueVo> |
标签值信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
用户或用户组ID。 |
|
account_name |
String |
用户或用户组名称。 |
|
type |
String |
参数解释: 标签类型,分为用户标签及用户组标签。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
from_type |
String |
来源类型。
|
|
group_path |
Array of strings |
用户组级别路径。 |
|
create_date |
Integer |
创建时间戳。 |
|
update_date |
Integer |
更新时间戳。 |
|
value_type |
String |
默认标签值类型,默认为NULL。
|
|
value |
Array of strings |
枚举值。 |
请求示例
获取用户标签值。
GET https://{endpoint}/v1/{project_id}/tags?type=user
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询用户标签列表成功。 |
错误码
请参见错误码。