全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 更多
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 智能硬件
云服务器 ECS

DescribeTags

更新时间:2018-03-28 10:06:57

描述

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

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

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:DescribeTags
RegionId String 地域 ID。更多详情,请参阅 地域与可用区,或者调用 DescribeRegions 查看最新的阿里云地域列表。
ResourceType String 标签绑定的资源类型。取值范围:
  • disk
  • instance
  • image
  • securitygroup
  • snapshot
以上取值均为小写。
ResourceId String 标签绑定的资源 ID。例如,当资源类型(ResourceType)为实例(instance)时,资源 ID 可以理解为实例 ID。
Tag.n.Key String 标签键,n 的取值范围为 [1, 5]。
Tag.n.Value String 标签值,n 的取值范围为 [1, 5]。
PageNumber Integer 标签列表的页码。
起始值:1
默认值:1
PageSize Integer 分页查询时设置的每页行数。
最大值:100
默认值:50

返回参数

名称 类型 描述
Tags TagSetItem 满足所有筛选条件的标签
TotalCount Integer 标签总个数
PageSize Integer 分页查询时设置的每页行数
PageNumber Integer 标签列表的页码

示例

请求示例

  1. https://ecs.aliyuncs.com/?Action=DescribeTags
  2. &ResourceType=snapshot
  3. &ResourceId=s-946ntx4wr
  4. &RegionId=cn-hangzhou
  5. &Tag.1.Key=test
  6. &Tag.1.Value=api
  7. &<公共请求参数>

返回示例

XML 格式

  1. <DescribeTagsResponse>
  2. <RequestId>B04B8CF3-4489-432D-83BA-6F128E4F2295</RequestId>
  3. <PageNumber>1</PageNumber>
  4. <PageSize>50</PageSize>
  5. <Tags>
  6. <Tag>
  7. <TagKey>test</TagKey>
  8. <TagValue>api</TagValue>
  9. </Tag>
  10. </Tags>
  11. <TotalCount>1</TotalCount>
  12. </DescribeTagsResponse>

JSON 格式

  1. {
  2. "PageNumber": 1,
  3. "PageSize": 50,
  4. "RequestId": "B04B8CF3-4489-432D-83BA-6F128E4F2295",
  5. "Tags": {
  6. "Tag": [
  7. {
  8. "TagKey": "test",
  9. "TagValue": "api"
  10. }
  11. ]
  12. },
  13. "TotalCount": 1
  14. }

错误码

错误代码 错误信息 HTTP 状态码 说明
InvalidTagKey.Malformed The parameter Tag.n.Key is illegal. 400 指定的 Tag.n.Key 不合法。
InvalidTagValue.Malformed The parameter Tag.n.Value is illegal. 400 指定的 Tag.n.Value 不合法。
InvalidRegionId.NotFound The RegionId provided does not exist in our records. 404 指定的 RegionId 不存在。
InvalidResourceType.NotFound The ResourceType provided does not exist in our records. 404 指定的 ResourceType 不存在。
本文导读目录