全部产品
Search
文档中心

资源管理:ListResourcesByTag - 基于标签查询资源

更新时间:Jun 20, 2024

基于标签查询资源。

接口说明

使用说明

本文将提供一个示例,在华南 1(深圳)地域,查询标签键k1绑定的 VPC 实例。返回结果显示,该标签键绑定了 2 个 VPC 实例。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

关于地域 ID 的详情,请参见服务接入点

cn-shenzhen
NextTokenstring

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a****
MaxResultinteger

分页时每页显示的数据条数。

默认值:50。最大值:1000。

50
ResourceTypestring

资源类型,用于查询的过滤条件。取值:

  • FuzzyType=EQUAL 时,支持的资源类型请调用 ListSupportResourceTypes 获取。

  • FuzzyType=NOT 时,支持的资源类型请参见下文支持逻辑非查询的资源类型

ALIYUN::VPC::VPC
FuzzyTypestring

查询操作。取值:

  • EQUAL(默认值):精确查询绑定了指定标签的资源。
  • NOT:精确查询未绑定指定标签的资源。
EQUAL
TagFilter.Valuestring

标签值,用于查询的过滤条件。

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

v1
TagFilter.Keystring

标签键,用于查询的过滤条件。

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

k1
IncludeAllTagsboolean

是否返回资源上的标签信息。取值:

  • False(默认值):不返回资源上的标签信息。
  • True :返回资源上所有标签信息。
False

支持逻辑非查询的资源类型:

  • ALIYUN::ADB::CLUSTER
  • ALIYUN::ALB::ACL
  • ALIYUN::ALB::LOADBALANCER
  • ALIYUN::ALB::SECURITYPOLICY
  • ALIYUN::ALB::SERVERGROUP
  • ALIYUN::ALIDNS::DOMAIN
  • ALIYUN::BASTIONHOST::INSTANCE
  • ALIYUN::BPSTUDIO::APPLICATION
  • ALIYUN::BPSTUDIO::TEMPLATE
  • ALIYUN::CAS::INSTANCE
  • ALIYUN::CDN::DOMAIN
  • ALIYUN::CDS::CLUSTER
  • ALIYUN::CEN::BANDWIDTHPACKAGE
  • ALIYUN::CEN::CEN
  • ALIYUN::CS::CLUSTER
  • ALIYUN::DBAUDIT::INSTANCE
  • ALIYUN::DCDN::DOMAIN
  • ALIYUN::DDOSBGP::INSTANCE
  • ALIYUN::DDOSCOO::INSTANCE
  • ALIYUN::DDS::INSTANCE
  • ALIYUN::DRDS::INSTANCE
  • ALIYUN::ECS::DDH
  • ALIYUN::ECS::DDHCLUSTER
  • ALIYUN::ECS::DISK
  • ALIYUN::ECS::ENI
  • ALIYUN::ECS::INSTANCE
  • ALIYUN::ECS::KEYPAIR
  • ALIYUN::ECS::LAUNCHTEMPLATE
  • ALIYUN::ECS::SECURITYGROUP
  • ALIYUN::ECS::SNAPSHOT
  • ALIYUN::EDAS::APPLICATION
  • ALIYUN::EDAS::CLUSTER
  • ALIYUN::ELASTICSEARCH::INSTANCE
  • ALIYUN::EMR::CLUSTER
  • ALIYUN::EMR::FLOWPROJECT
  • ALIYUN::HBR::CLIENT
  • ALIYUN::HBR::HANAINSTANCE
  • ALIYUN::HBR::VAULT
  • ALIYUN::KVSTORE::INSTANCE
  • ALIYUN::MULTIMOD::CLUSTER
  • ALIYUN::OCEANBASE::INSTANCE
  • ALIYUN::OOS::EXECUTION
  • ALIYUN::OOS::PARAMETER
  • ALIYUN::OOS::SECRETPARAMETER
  • ALIYUN::OOS::STATECONFIGURATION
  • ALIYUN::OOS::TEMPLATE
  • ALIYUN::OSS::BUCKET
  • ALIYUN::OUTBOUNDBOT::INSTANCE
  • ALIYUN::POLARDB::CLUSTER
  • ALIYUN::PVTZ::ZONE
  • ALIYUN::RDS::INSTANCE
  • ALIYUN::VPC::COMMONBANDWIDTHPACKAGE
  • ALIYUN::VPC::EIP
  • ALIYUN::VPC::NATGATEWAY
  • ALIYUN::VPC::VPC

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

7D61FF74-61C2-5768-B01F-05FC97F24F35
NextTokenstring

根据NextToken判断是否具备下一个查询开始的 Token。取值:

  • 如果NextToken为空,即"NextToken": "",表示没有下一个。
  • 如果NextToken有值,则该值就是下一个查询开始的 Token。
caeba0bbb2be03f84eb48b699f0a****
Resourcesobject []

资源列表。

ResourceIdstring

资源 ID。

vpc-wz9pifyuw26esxd05****
Tagsobject []

标签信息。

IncludeAllTagsTrue时,返回该参数。

Keystring

标签键。

k1
Valuestring

标签值。

v1
Categorystring

资源标签类型。取值:

  • custom:自定义标签。
  • system:系统标签。
custom

示例

正常返回示例

JSON格式

{
  "RequestId": "7D61FF74-61C2-5768-B01F-05FC97F24F35",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "Resources": [
    {
      "ResourceId": "vpc-wz9pifyuw26esxd05****",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1",
          "Category": "custom"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-12-06API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-11-21API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用