全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
云服务器 ECS

DescribeTags

更新时间:2017-09-13 16:11:36

描述

查询当前可用的标签。

  • 容许根据资源类型、资源 ID、Tag-Key、Tag-Value 等条件查询所有符合条件的 Tags。
  • 指定的条件为 and 关系,只有指定的所有条件都满足的TagSetItem才会被返回。
  • 如果指定了 Tag-Key 但没有指定 Tag-Value,就查询所有该 Tag-Key 关联的 Tag。
  • 如果指定了 Tag-Key/Tag-Value 对,就查询精确匹配该 Tag-Key/Tag-Value 对的 Tag。

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,DescribeTags
RegionId String 所属区域。RegionId 的列表详见 地域列表
ResourceId String ResourceId
ResourceType String 资源类型:
  • image
  • instance
  • snapshot
  • disk
  • securitygroup
所有值均为小写。
Tag.n.Key String 标签 key,n 从 1 开始,最大为 5
Tag.n.Value String 标签 value,n 从 1 开始,最大为 5
PageSize Integer 默认 50,最大 100
PageNumber Integer 实例状态列表的页码,起始值为 1,默认值为 1

返回参数

名称 类型 描述
RequestId String 请求ID
Tags TagSetItem 实际返回内容的结构体列表
PageSize Integer 默认 50,最大 100
PageNumber Integer 实例状态列表的页码,起始值为 1,默认值为 1
TotalCount Integer 实例总个数

错误码

错误代码 描述 Http状态码 语义
InvalidRegionId.NotFound The RegionId provided does not exist in our records. 404 指定的 RegionId 不存在。RegionId 的列表详见 地域列表
InvalidResourceType.NotFound The ResourceType provided does not exist in our records. 404 指定的 ResourceType 不存在
InvalidTagCount The specified tags are beyond the permitted range. 400 指定的 Tag 数超过了 5 个
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 不合法

示例

请求示例

  1. https://ecs.aliyuncs.com/?Action=AddTags
  2. &ResourceId=s-946ntx4wr
  3. &ResourceType=snapshot
  4. &RegionId=cn-shenzhen
  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. }
本文导读目录