调用ListTagResources接口查询云资源已经绑定的标签列表。

使用说明

  • 请求中至少指定参数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代码示例。

请求参数

名称 类型 是否必选 示例值 描述
ResourceType String VPC

资源类型。取值:

  • VPC:专有网络实例。
  • VSWITCH:交换机实例。
  • ROUTETABLE:路由表实例。
  • EIP:弹性公网IP实例。
  • VpnGateWay:VPN网关实例。
  • NATGATEWAY:NAT网关实例。
  • COMMONBANDWIDTHPACKAGE:共享带宽实例。
RegionId String cn-hangzhou

资源所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
Action String ListTagResources

系统规定参数。取值:ListTagResources

MaxResults Integer 50

分页大小,取值范围:1~50,默认值:50

ResourceId.N String vpc-bp16qjewdsunr41m1****

资源ID。最多支持输入20个资源ID。

Tag.N.Key String FinanceDept

资源的标签键。最多支持20个标签键。一旦传入该值,则不允许为空字符串。

最多支持64个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

Tag.N.Value String FinanceJoshua

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

最多支持128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String DE65F6B7-7566-4802-9007-96F2494AC512

请求ID。

TagResources Array of TagResource

绑定标签的资源信息。

TagResource
ResourceType String VPC

资源类型。取值:

  • VPC:专有网络实例。
  • VSWITCH:交换机实例。
  • ROUTETABLE:路由表实例。
  • EIP:弹性公网IP实例。
  • VpnGateWay:VPN网关实例。
  • NATGATEWAY:NAT网关实例。
  • COMMONBANDWIDTHPACKAGE:共享带宽实例。
TagValue String FinanceJoshua

标签值。

ResourceId String vpc-bp16qjewdsunr41m1****

资源ID。

TagKey String FinanceDept

标签键。

示例

请求示例

http(s)://[Endpoint]/?ResourceType=VPC
&RegionId=cn-hangzhou
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Action=ListTagResources
&MaxResults=50
&ResourceId=["vpc-bp16qjewdsunr41m1****"]
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTagResourcesResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>DE65F6B7-7566-4802-9007-96F2494AC512</RequestId>
    <TagResources>
        <ResourceType>VPC</ResourceType>
        <TagValue>FinanceJoshua</TagValue>
        <ResourceId>vpc-bp16qjewdsunr41m1****</ResourceId>
        <TagKey>FinanceDept</TagKey>
    </TagResources>
</ListTagResourcesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagResources" : [ {
    "ResourceType" : "VPC",
    "TagValue" : "FinanceJoshua",
    "ResourceId" : "vpc-bp16qjewdsunr41m1****",
    "TagKey" : "FinanceDept"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidTagKey The tag keys are not valid. 无效的标签索引
400 InvalidTagValue The tag values are not valid. 无效的标签值
400 InvalidInstanceType.NotFound The instance type is not found 实例类型没有找到
400 InvalidInstanceIds.NotFound The instanceIds are not found 实例ID没有找到
400 Forbidden.TagKeys The request do not allow to operate the tag keys 没有权限操作TagKeys
400 QuotaExceeded.TagNum Custom Tags quota exceeded quota超限
400 Forbidden.TagKey.Duplicated The specified tag key already exists. 标签资源重复
400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded. 标签数量超限
400 SizeLimitExceeded.ResourceId The maximum number of resource IDs is exceeded. 资源组ID数目超限
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源,请申请权限后再操作。
403 BothEmpty.TagsAndResources The specified Tags and ResourcesIds are not allow to both empty. 标签和资源组不能同时为空

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