DescribeTags - Elastic Compute Service

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

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
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	該標籤標記了多少 Dedicated Host。	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
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidTagCount	The specified tags are beyond the permitted range.
400	InvalidTagKey.Malformed	The parameter Tag.n.Key is illegal.
400	InvalidTagValue.Malformed	The parameter Tag.n.Value is illegal.
400	Invalid.TagCategory	The parameter Category is illegal.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。