查询项目下超节点已使用的标签-ListProjectHypernodeTags
功能介绍
查询项目下超节点已使用标签接口,用于获取指定项目中所有超节点资源已绑定的标签,并按标签键聚合返回各键下出现过的取值集合。
该接口适用于以下场景:控制台标签输入联想、查看项目内标签使用情况、配置标签策略前的标签盘点等。
查询完成后,将返回标签键列表及每个键对应的取值去重集合。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics:hypernode:listTags | List | - | - | - | - |
URI
GET /v2/{project_id}/hypernodes/tags
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页大小,表示单次返回的最大资源实例条数。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 100。 |
| offset | 否 | Integer | 参数解释: 分页偏移量,表示从满足条件的第几条结果开始返回。 约束限制: 从 0 开始计数;与 limit 组合使用实现分页。 取值范围: 大于等于 0 的整数。 默认取值: 0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 项目中出现过的不同标签键的数量。 取值范围: 大于等于 0 的整数。 |
| tags | Array of ProjectTag objects | 参数解释: 按标签键聚合后的标签列表,每项包含一个键及其在项目内出现过的全部取值。 取值范围: 不涉及。 |
请求示例
查询项目下超节点已使用标签请求示例。使用场景:用户需要查看项目中所有超节点资源已绑定的标签时,查询标签键列表及取值集合。
GET https://{endpoint}/v2/{project_id}/hypernodes/tags?limit=10&offset=0 响应示例
状态码:200
成功返回项目下超节点标签聚合结果。
{
"total_count" : 2,
"tags" : [ {
"key" : "env",
"values" : [ "prod", "test" ]
}, {
"key" : "department",
"values" : [ "ops" ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功返回项目下超节点标签聚合结果。 |
错误码
请参见错误码。