文档

DescribeTags - 查询已有标签列表

更新时间:

查询标签列表。

接口说明

调用该接口时,请注意:

  • 允许根据实例 ID、Tagkey、Tagvalue 等条件查询所有符合条件的 Tags。

  • 指定的条件为 and 关系,只有满足所有指定条件的 TagSet 才会被返回。

  • 如果指定了 Tagkey 而没有指定 Tagvalue,就查询所有该 Tagkey 关联的 Tag。

  • 不允许用户只指定 Tagvalue 而不指定 Tagkey。

  • 若指定了 Tagkey/Tagvalue 对,则精确匹配该 Tag。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
slb:DescribeTagsRead
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/*

请求参数

名称类型必填描述示例值
RegionIdstring

负载均衡实例的地域 ID。

cn-hangzhou
LoadBalancerIdstring

负载均衡实例 ID。

lb-bp1kuzybm******
Tagsstring

要查询的标签列表。

[{"TagKey":"Key1","TagValue":"Value1"},{"TagKey":"Key2","TagValue":"Value2"}]
DistinctKeyboolean

是否为 DistinctKey。

取值:true 或 false。

false
PageSizeinteger

单页结果数量,接口默认 50,最大 100。

50
PageNumberinteger

实例列表页码,起始值 1,默认值 1。

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF3******
PageSizeinteger

默认 50,最大 100。

50
PageNumberinteger

实例列表页码,起始值 1,默认值 1。

1
TotalCountinteger

根据过滤条件得到的实例总个数。

1
TagSetsobject []

Tag 列表。

TagValuestring

标签 Value。

api
InstanceCountinteger

该标签绑定的实例总数。

10
TagKeystring

标签 Key。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 1,
  "TagSets": {
    "TagSet": [
      {
        "TagValue": "api",
        "InstanceCount": 10,
        "TagKey": "test"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400NoPermission.OperatorThe operator is not permission for this operate.操作者无权进行此操作。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈