ListTagResources - 查询实例已绑定的标签列表

更新时间:
复制为 MD 格式

查询实例已经绑定的标签列表。

接口说明

  • 请求中至少指定参数ResourceId.NTag.NTag.N.KeyTag.N.Value),以确定检索对象。

  • Tag.N是资源的标签,由一个键值对组成。仅指定Tag.N.Key时,则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。

  • 如果您同时指定Tag.NResourceId.N筛选标签,则ResourceId.N必须满足所有输入的标签键值对。

  • 如果您同时指定多个标签键值对,返回结果为同时包含被指定的多个键值对的资源。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

slb:ListTagResources

get

acl

acs:slb:{#regionId}:{#accountId}:acl/{#aclId}

loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

ServerCertificate

acs:slb:{#regionId}:{#AccountId}:certificate/{#ServerCertificateId}

CaCertificate

acs:slb:{#regionId}:{#AccountId}:certificate/{#CaCertificateId}

  • slb:tag
  • slb:tag
  • slb:tag

请求参数

名称

类型

必填

描述

示例值

RegionId

string

传统型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口查询地域 ID。

cn-hangzhou

ResourceType

string

资源类型定义,取值:

  • instance:负载均衡实例。

  • certificate:证书。

  • acl:访问控制。

  • listener:监听。

  • vservergroup:虚拟服务器组。

  • masterslaveservergroup:主备服务器组。

instance

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

caeba0bbb2be03f84eb48b699f0a****

ResourceId

array

资源 ID。最多支持添加 20 个资源。

说明

listenerResourceId 取值为LoadBalancerId_监听协议_Port,其中 LoadBalancerId 为实例 ID,port 为监听端口。示例:lb-bp1qnnvj18yy6h****_http_80。

lb-bp1qnnvj18yy6h******

string

资源 ID。最多支持添加 20 个资源。

说明

listenerResourceId 取值为LoadBalancerId_监听协议_Port,其中 LoadBalancerId 为实例 ID,port 为监听端口。示例:lb-bp1qnnvj18yy6h****_http_80。

lb-bp1qnnvj18yy6h****

Tag

array<object>

标签列表。

object

标签列表。

Key

string

资源的标签键。最多支持添加 20 个标签键。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept

Value

string

资源的标签值。最多支持添加 20 个标签值。一旦传入该值,不可以为空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称

类型

描述

示例值

object

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

caeba0bbb2be03f84eb48b699f0a****

RequestId

string

请求 ID。

DE65F6B7-7566-4802-9007-96F2494AC512

TagResources

object

TagResource

array<object>

绑定标签的资源信息。

object

绑定标签的资源信息。

TagValue

string

标签值。

FinanceJoshua

ResourceType

string

资源类型。

instance

ResourceId

string

资源 ID。

lb-bp16qjewdsunr4****

TagKey

string

标签键。

FinanceDept

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "ResourceType": "instance",
        "ResourceId": "lb-bp16qjewdsunr4****",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 TagTypeNotSame The category of tags in the same request must be the same. 同一请求中的标签类别必须相同。
400 ResourceNotExist %s. 指定的资源不存在。
400 QueryTokenNotExist The specified NextToken does not exist. 指定的NextToken 不存在。
400 InvalidParam.NextToken The specified NextToken is invalid. 指定的NextToken无效。请检查参数约束,并在修改后重试。
400 InvalidParam.Scope The specified Scope is invalid. 指定的Scope无效。请检查参数约束,并在修改后重试。
400 InvalidParam.ResourceType The specified ResourceType is invalid. 指定的ResourceType无效。请检查参数约束,并在修改后重试。
400 InvalidParam.TagKey The specified TagKey is invalid. 指定的TagKey无效。请检查参数约束,并在修改后重试。
400 InvalidParam.TagValue The specified TagValue is invalid. 指定的TagValue无效。请检查参数约束,并在修改后重试。
400 InvalidParam.TagKeyOrValue The specified TagKey or TagValue is invalid. 指定的TagKey Or Value无效。请检查参数约束,并在修改后重试。
400 InvalidParam.TagOwnerUid The specified TagOwnerUid is invalid. 指定的TagOwnerUid无效。请检查参数约束,并在修改后重试。
400 InvalidParam.TagOwnerBid The specified TagOwnerBid is invalid. 指定的TagOwnerBid无效。请检查参数约束,并在修改后重试。
400 MissingParam.Scope The parameter Scope is required. 参数Scope缺失。
400 MissingParam.TagOwnerUid The parameter TagOwnerUid is required. 参数TagOwnerUid缺失。
400 MissingParam.TagOwnerBid The parameter TagOwnerBid is required. 参数TagOwnerBid缺失。
400 InvalidParameter.RegionId The specified RegionId does not exist. 指定的RegionId不存在。
400 MissingParam.TagOrResourceId The parameter Tag or ResourceId is required at least one. 参数TagOrResourceId缺失。
400 SizeLimitExceeded.ResourceId The maximum size of ResourceId is exceeded. 指定的ResourceId长度无效。请检查参数约束,并在修改后重试。
400 SizeLimitExceeded.Tag The maximum size of Tag is exceeded. 指定的Tag长度无效。请检查参数约束,并在修改后重试。

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

变更历史

更多信息,参考变更详情