查詢可以供您使用的標籤。您可以根據資源類型、資源 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 標籤列表的頁碼

樣本

請求樣本 
https://ecs.aliyuncs.com/?Action=DescribeTags
&ResourceType=snapshot
&ResourceId=s-946ntx4wr
&RegionId=cn-hangzhou
&Tag.1.Key=test
&Tag.1.Value=api
&<公共請求參數>
返回樣本

XML 格式

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

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼，請訪問 API 錯誤中心。

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
nvalidTagKey.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不存在。