DescribeResourceByTags - 根据标签检索资源-云服务器 ECS(ECS)-阿里云帮助中心

调用DescribeResourceByTags根据标签检索资源。支持根据标签检索，也支持根据资源类型检索。

说明

目前该API接口已标记为弃用，推荐使用替代API：Tag(2018-08-28) - ListResourcesByTag。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeResourceByTags

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	查询结果显示的每页的信息条目数。最大值：100。默认值：50。	50
PageNumber	integer	否	查询结果显示的页码。起始值：1。默认值：1。	1
ResourceType	string	否	资源类型。取值范围： instance：ECS 实例。 disk：磁盘。 snapshot：快照。 image：镜像。 securitygroup：安全组。 volume：存储卷。 eni：弹性网卡。 ddh：专有宿主机。 keypair：SSH 密钥对。 launchtemplate：启动模板。以上取值均为小写。	instance
RegionId	string	是	资源所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Tag	array<object>	否	标签列表。
	object	否	标签列表。
key	string	否	资源的标签键。说明为提高兼容性，建议您尽量使用 Tag.N.Key 参数。	testkey
Key	string	否	资源的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符。	TestKey
Value	string	否	资源的标签值。N 的取值范围：1~20。一旦传入该值，允许为空字符串。最多支持 128 个字符。	TestValue
value	string	否	资源的标签值。说明为提高兼容性，建议您尽量使用 Tag.N.Value 参数。	testvalue

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1C1E5359-71D7-44D8-8FAA-0327B549157X
PageSize	integer	查询结果显示的每页的信息条目数。	50
PageNumber	integer	查询结果显示的页码。	1
TotalCount	integer	返回的资源总数。	8
Resources	object
Resource	array<object>	绑定标签的资源信息集合。
	object
ResourceType	string	资源类型。	instance
ResourceId	string	资源 ID。	i-bp16t2cgmiiy7t1c****
RegionId	string	地域 ID。	cn-hangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "1C1E5359-71D7-44D8-8FAA-0327B549157X",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 8,
  "Resources": {
    "Resource": [
      {
        "ResourceType": "instance",
        "ResourceId": "i-bp16t2cgmiiy7t1c****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidTagCount	The specified tags are beyond the permitted range.	指定的标记超出取值范围。
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地域 ID 不存在。
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	指定的资源类型不存在。

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

变更历史

更多信息，参考变更详情。