文档

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代码示例。

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ListTagResourcesRead
  • BandwidthPackage
    acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}
  • Address
    acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}
  • NatGateway
    acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}
  • RouteTable
    acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTable}
  • VPC
    acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}
  • VSwitch
    acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}
  • vpc:tag

请求参数

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

资源类型。取值:

  • VPC:表示资源类型为专有网络实例。
  • VSWITCH:表示资源类型为交换机实例。
  • ROUTETABLE:表示资源类型为路由表实例。
  • EIP:表示资源类型为弹性公网 IP 实例。
  • VPNGATEWAY:表示资源类型为 VPN 网关实例。
  • NATGATEWAY:表示资源类型为 NAT 网关实例。
  • COMMONBANDWIDTHPACKAGE:表示资源类型为共享带宽实例。
  • PREFIXLIST:表示资源类型为前缀列表实例。
  • PUBLICIPADDRESSPOOL:表示资源类型为 IP 地址池实例。
  • IPV4GATEWAY:表示资源类型为 IPv4 网关实例。
  • IPV6GATEWAY:表示资源类型为 IPv6 网关实例。
  • NETWORKACL:表示资源类型为网络 ACL 实例。
  • TRAFFICMIRRORFILTER:表示资源类型为流量镜像筛选条件实例。
  • TRAFFICMIRRORSESSION:表示资源类型为流量镜像会话实例。
  • FLOWLOG:表示资源类型为流日志实例。
  • HAVIP:表示资源类型为高可用虚拟 IP 实例。
  • DHCPOPTIONSSET:表示资源类型为 DHCP 选项集实例。
  • GATEWAYENDPOINT:表示资源类型为网关终端节点实例。
说明 输入的资源类型取值不区分大小写。
VPC
NextTokenstring

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

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

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

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

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

50
ResourceIdarray

资源 ID。最多支持 50 个资源 ID。

string

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

说明 参数ResourceId.NTag.NTag.N.KeyTag.N.Value)至少输入一个。
vpc-bp16qjewdsunr41m1****
RegionIdstring

资源所属的地域 ID。

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

cn-hangzhou
Tagobject []

标签信息。

ListTagResources
Keystring

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

一个标签键最多支持 128 个字符,不能是空字符串,不能以aliyunacs:开头,不能包含http://或者https://

说明 参数ResourceId.NTag.NTag.N.KeyTag.N.Value)至少输入一个。
FinanceDept
Valuestring

资源的标签值。最多支持 20 个标签值。

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

说明 参数ResourceId.NTag.NTag.N.KeyTag.N.Value)至少输入一个。
FinanceJoshua

返回参数

名称类型描述示例值
object

返回的信息。

NextTokenstring

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

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

请求 ID。

DE65F6B7-7566-4802-9007-96F2494AC512
TagResourcesobject []

绑定标签的资源信息。

ResourceTypestring

资源类型。取值:

  • VPC:表示资源类型为专有网络实例。
  • VSWITCH:表示资源类型为交换机实例。
  • ROUTETABLE:表示资源类型为路由表实例。
  • EIP:表示资源类型为弹性公网 IP 实例。
  • VPNGATEWAY:表示资源类型为 VPN 网关实例。
  • NATGATEWAY:表示资源类型为 NAT 网关实例。
  • COMMONBANDWIDTHPACKAGE:表示资源类型为共享带宽实例。
  • PREFIXLIST:表示资源类型为前缀列表实例。
  • PUBLICIPADDRESSPOOL:表示资源类型为 IP 地址池实例。
  • IPV4GATEWAY:表示资源类型为 IPv4 网关实例。
  • IPV6GATEWAY:表示资源类型为 IPv6 网关实例。
  • NETWORKACL:表示资源类型为网络 ACL 实例。
  • TRAFFICMIRRORFILTER:表示资源类型为流量镜像筛选条件实例。
  • TRAFFICMIRRORSESSION:表示资源类型为流量镜像会话实例。
  • FLOWLOG:表示资源类型为流日志实例。
  • HAVIP:表示资源类型为高可用虚拟 IP 实例。
  • DHCPOPTIONSSET:表示资源类型为 DHCP 选项集实例。
  • GATEWAYENDPOINT:表示资源类型为网关终端节点实例。
VPC
TagValuestring

标签值。

FinanceJoshua
ResourceIdstring

资源 ID。

vpc-bp16qjewdsunr41m1****
TagKeystring

标签键。

FinanceDept

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400InvalidTagValueThe tag values are not valid.无效的标签值
400MissingParam%s-
400InvalidInstanceType.NotFoundThe instance type is not found实例类型没有找到
400InvalidInstanceIds.NotFoundThe instanceIds are not found实例ID没有找到
400Forbidden.TagKeysThe request do not allow to operate the tag keys没有权限操作TagKeys
400QuotaExceeded.TagNumCustom Tags quota exceededquota超限
400Forbidden.NotAllowedCategaryThe System tag is not valid系统tag无效
400Forbidden.TagKeysThe request does not allow operate this tagkeys该请求不允许操作此 tagkey
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.标签资源重复
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.标签数量超限
400SizeLimitExceeded.ResourceIdThe maximum number of resource IDs is exceeded.资源组ID数目超限
400BothEmpty.TagsAndResourcesThe specified Tags and ResourcesIds are not allow to both empty.标签和资源组不能同时为空
400MissingParam.ResourceTypeThe param of ResourceType is missing.参数ResourceType缺失
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。

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

变更历史

变更时间变更内容概要操作
2023-07-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2023-07-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
  • 本页导读 (1)
文档反馈