全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Nov 08, 2024

    基于标签查询资源。

    接口说明

    使用说明

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    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 个字符，不能以aliyun和acs:开头，不能包含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****
    Resourcesarray<object>

    资源列表。

    TagResourceobject

    资源列表。

    ResourceIdstring

    资源 ID。

    		vpc-wz9pifyuw26esxd05****
    Tagsarray<object>

    标签信息。

    当IncludeAllTags为True时，返回该参数。

    Tagobject

    标签信息。

    当IncludeAllTags为True时，返回该参数。

    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"
        }
      ]
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400Invalid.MsgEndPointThe MsgEndPoint is invalid.MsgEndPoint非法。
    400Invalid.MsgQueueThe MsgQueue is invalid.消息列表参数非法。
    400InvalidParameter.TagsThe specified value of parameter Tags is not valid.Tags参数非法。
    400InvalidParameter.TagsThe Tags' parameter cannot be empty, and JSON parsing should adhere to the format of a Map.参数Tags不能为空，JSON解析需符合Map的格式，比如 {"key":"value"}
    400Duplicate.TagKeyThe Tag.N.Key contains duplicate keys, please check the duplicate tag key.存在重复的标签键。
    400InvalidParameter.TagKeyThe TagKey parameter is invalid. The following TagKeys are invalid: %s.参数中存在不合法的标签键，不合法的标签键如下：%s
    400MetaTagKeyHasValueThe specified TagKey already bind tag value指定的标签键存在绑定的标签值
    400NumberExceed.TagKeysThe maximum number of TagKeys is exceeded.标签键的个数超过最大限制。
    400InvalidParameter.TagValueThe TagValue parameter is invalid. The following TagValues are invalid: %s.参数中包含不合法的标签值，不合法的标签值如下：%s
    403Invalid.NextTokenThe parameter NextToken is invalid.NextToken参数非法。
    403InvalidParamter.NextTokenNextToken parameter is illegal.NextToken 参数非法。
    403FuzzyType.NotSupportFuzzy queries are not supported.不支持模糊查询。
    403NumberExceed.TagsThe maximum number of Tags is exceeded.标签参数数量超限。
    403QuotaExceed.TagsPerResourceThe maximum number of tags for each resource is exceeded.每个资源上的标签数量有限制，目前有资源已经超限。
    403Duplicate.TagKeyThe Tag.N.Key contains duplicate keys.参数包含重复标签键。
    403InvalidParameter.KeyThe Key is invalid.Key值非法。
    403InvalidParameter.TagKeyThe Tag.N.Key parameter is invalid.标签键参数非法。
    403MetaTagKey.BindingResourcesBinding resource exists for tag key.标签键存在绑定资源。
    403MetaTagKeyNotFoundThe meta tag key is not found.预置标签键不存在。
    403NoPermissionKey.CategorySome keys cannot be modified because the user does not have permission.某些key的标签类型没有操作权限。
    403NoPermissionKey.OperatorYou are not authorized to operate the tag key.该用户没有操作此标签键权限。
    403InvalidParameter.CategoryThe specified Category is invalid. Valid values are Custom and System.标签类型非法，合法值为Custom，System。
    403InvalidParameter.TagValueThe Tag.N.Value parameter is invalid.标签值参数非法。
    403InvalidParameter.ValueThe Value is invalid.Value值非法。
    404MissingParameter.TagsYou must specify Tags.缺少参数Tags。
    404Missing.TagKeyTag.N.Value has been specified and you must specify Tag.N.Key.一对键值对，对应的TagValue缺失相同N的TagKey。
    404MissingParameter.KeyThe Key must not be empty.Key值为空。
    404MissingParameter.TagKeyYou must specify TagKey.标签键参数不可为空。
    404MissingParameter.TagKeyValueParamListThe parameter TagKeyValueParamList must not be null.缺少参数TagKeyValueParamList。
    404MissingParameter.ValueThe Value must not be empty.Value值为空。

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

    变更历史

    变更时间变更内容概要操作
    2022-12-06API 内部配置变更，不影响调用查看变更详情
    2022-11-21API 内部配置变更，不影响调用查看变更详情