DescribeTags - 查询可供使用标签-云服务器 ECS(ECS)-阿里云帮助中心

查询可以供您使用的标签。您可以根据资源类型、资源ID、标签键或标签值等条件查询标签，筛选条件之间为逻辑与（&&）关系，返回满足所有筛选条件的标签。

说明

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

接口说明

如果您指定了标签键（Tag.N.Key）但没有指定标签值（Tag.N.Value），我们将查询该标签键对应的所有标签键值对。如果您指定了标签键值对，就查询精确匹配该键值对的标签。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeTags

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：启动模板。 reservedinstance：预留实例券。 snapshotpolicy：自动快照策略。以上取值均为小写。	snapshot
ResourceId	string	否	标签绑定的资源 ID。例如，当资源类型（ResourceType）为实例（instance）时，资源 ID 可以理解为实例 ID。	s-946ntx4wr****
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Category	string	否	说明该参数即将被弃用，为提高兼容性，建议您尽量使用其他参数。	null
Tag	array<object>	否	标签列表。
	object	否	标签列表。
key	string	否	资源的标签键。说明为提高兼容性，建议您尽量使用 Tag.N.Key 参数。	testkey
Key	string	否	资源的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	TestKey
Value	string	否	资源的标签值。N 的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	TestValue
value	string	否	资源的标签值。说明为提高兼容性，建议您尽量使用 Tag.N.Value 参数。	testvalue

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	B04B8CF3-4489-432D-83BA-6F128E4F2295
PageSize	integer	分页查询时设置的每页行数。	50
PageNumber	integer	标签列表的页码。	1
TotalCount	integer	标签总个数。	1
Tags	object
Tag	array<object>	满足所有筛选条件的标签。
	array<object>	满足所有筛选条件的标签。
TagValue	string	标签值。	TestValue
TagKey	string	标签键。	TestKey
ResourceTypeCount	object	资源类型计数。
Instance	integer	该标签标记了多少实例。	45
Image	integer	该标签标记了多少镜像。	6
Ddh	integer	该标签标记了多少专有宿主机。	1
SnapshotPolicy	integer	该标签标记了多少自动快照策略。	4
Securitygroup	integer	该标签标记了多少安全组。	4
Snapshot	integer	该标签标记了多少快照。	15
ReservedInstance	integer	该标签标记了多少预留实例券。	4
LaunchTemplate	integer	该标签标记了多少启动模板。	6
Eni	integer	该标签标记了多少弹性网卡。	5
Disk	integer	该标签标记了多少磁盘。	15
KeyPair	integer	该标签标记了多少密钥对。	17
Volume	integer	该标签标记了多少存储卷。	6

示例

正常返回示例

JSON格式

{
  "RequestId": "B04B8CF3-4489-432D-83BA-6F128E4F2295",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 1,
  "Tags": {
    "Tag": [
      {
        "TagValue": "TestValue",
        "TagKey": "TestKey",
        "ResourceTypeCount": {
          "Instance": 45,
          "Image": 6,
          "Ddh": 1,
          "SnapshotPolicy": 4,
          "Securitygroup": 4,
          "Snapshot": 15,
          "ReservedInstance": 4,
          "LaunchTemplate": 6,
          "Eni": 5,
          "Disk": 15,
          "KeyPair": 17,
          "Volume": 6
        }
      }
    ]
  }
}

异常返回示例

JSON格式

{
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "B04B8CF3-4489-432D-83BA-6F128E4F2295",
  "Tags": {
    "Tag": [
      {
        "TagKey": "test",
        "TagValue": "api"
      }
    ]
  },
  "TotalCount": 1
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidTagCount	The specified tags are beyond the permitted range.	指定的标记超出取值范围。
400	InvalidTagKey.Malformed	The parameter Tag.n.Key is illegal.	Tag.N.Key 不合法。
400	InvalidTagValue.Malformed	The parameter Tag.n.Value is illegal.	Tag.N.Value 不合法。
400	Invalid.TagCategory	The parameter Category is illegal.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地域 ID 不存在。
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	指定的资源类型不存在。

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

变更历史

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