ListTagResources - 查詢資源已經綁定的標籤列表 - Elastic Compute Service

查詢一個或多個ECS資源已經綁定的標籤列表

介面說明

請求中至少指定以下任一參數，以確定查詢對象。

ResourceId.N
Tag.N（Tag.N.Key與Tag.N.Value）
TagFilter.N

同時指定下列參數時，返回結果中僅包含同時滿足這兩個條件的 ECS 資源。

Tag.N和ResourceId.N
TagFilter.N和ResourceId.N

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:ListTagResources

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	資源所屬的地區 ID，您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
RegionId	string	是	資源所屬的地區 ID，您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
NextToken	string	否	下一個查詢開始 Token。	caeba0bbb2be03f84eb48b699f0a4883
ResourceType	string	是	資源類型定義。取值範圍： instance：ECS 執行個體。 disk：磁碟。 snapshot：快照。 image：鏡像。 securitygroup：安全性群組。 volume：儲存卷。 eni：彈性網卡。 ddh：Dedicated Host。 ddhcluster：Dedicated Host叢集。 keypair：SSH 金鑰對。 launchtemplate：啟動模板。 reservedinstance：預留執行個體券。 snapshotpolicy：自動快照策略。 elasticityassurance：彈性保障。 capacityreservation：容量預定。 command：雲助手命令。 invocation：雲助手命令執行或檔案下髮結果。 activation：雲助手受管理的執行個體啟用碼。 managedinstance：雲助手受管理的執行個體。	instance
ResourceId	array	否	ECS 資源 ID。N 的取值範圍為 1~50。	i-bp1j6qtvdm8w0z1o****
	string	否	ECS 資源 ID。N 的取值範圍為 1~50。	i-bp1j6qtvdm8w0z1o****
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	精確尋找 ECS 資源時使用的標籤鍵。標籤鍵長度的取值範圍為 1~128。N 的取值範圍為 1~20。 `Tag.N`參數使用說明：方式一：用於精確尋找綁定了指定標籤的 ECS 資源，由一個索引值對組成。僅指定`Tag.N.Key`時，則返回關聯該標籤鍵的所有資源。僅指定`Tag.N.Value`，則報錯`InvalidParameter.TagValue`。同時指定多個標籤索引值對時，僅同時滿足所有標籤索引值對的 ECS 資源會被尋找到。方式二：用於查詢非預設資源群組內的資源資訊。`Key`的取值固定為`acs:rm:rgId`，對應的`Value`取值為資源群組 ID。如果`Key`取值為`acs:rm:rgId`，則`Value`的取值只能是非預設資源群組 ID。如果指定的資源群組 ID 為預設資源群組，則會返回錯誤資訊。如果`Key`取值為`acs:rm:rgId`，則不支援再指定其他標籤索引值對。如果通過多個`Tag.N`參數同時查詢資源群組和標籤對應的資源，則會返回錯誤資訊。	TestKey
Value	string	否	精確尋找 ECS 資源時使用的標籤值。標籤值長度的取值範圍為 1~128。N 的取值範圍為 1~20。說明當`Key=acs:rm:rgId`時，該參數只能傳入資源群組 ID，且資源群組 ID 不能為預設資源群組。	TestValue
TagFilter	array<object>	否	Tag 過濾規則。說明該參數正在邀測中，暫未開放使用。
	object	否	Tag 過濾規則。
TagValues	array	否	模糊尋找 ECS 資源時使用的標籤值。標籤值長度的取值範圍為 1~128。N 的取值範圍為 1~5。具體的參數說明請參見`TagFilter.N.TagKey`參數描述。	TestTagFilter
	string	否	模糊尋找 ECS 資源時使用的標籤值。標籤值長度的取值範圍為 1~128。N 的取值範圍為 1~5。具體的參數說明請參見`TagFilter.N.TagKey`參數描述。	TestTagFilter
TagKey	string	否	模糊尋找 ECS 資源時使用的標籤鍵。標籤鍵長度的取值範圍為 1~128。N 的取值範圍為 1~5。 `TagFilter.N`用於模糊尋找綁定了指定標籤的 ECS 資源，由一個鍵和一個或多個值組成。模糊查詢可能會有 2 秒延時，僅支援模糊過濾後資源數小於等於 5000 的情況。通過標籤鍵（`TagFilter.N.TagKey`）模糊尋找 ECS 資源時，標籤值（`TagFilter.N.TagValues.N`）必須為空白。例如，模糊搜尋標籤鍵為`environment`的 ECS 資源時，`TagFilter.1.TagKey`可以設定為`env`（首碼匹配的模糊搜尋方式）、`env`（兩邊匹配的模糊搜尋方式）或者`env`（精確搜尋方式），而`TagFilter.1.TagValues`必須為空白。通過標籤值（`TagFilter.N.TagValues.N`）模糊尋找 ECS 資源時，標籤鍵（`TagFilter.N.TagKey`）必須設定為精確值。例如，模糊搜尋標籤鍵為`env`，標籤值為`product`的 ECS 資源時，`TagFilter.1.TagKey`必須精確設定為`env`，`TagFilter.1.TagValues.1`可以設定為`proc`（首碼匹配的模糊搜尋方式）、`proc`（兩邊匹配的模糊搜尋方式）或者`proc`（精確搜尋方式）。同一個`TagKey`下只能用同一種搜尋方式，如果設定了多個不同的搜尋方式，則以第一個方式為準。標籤鍵之間為交集關係，即僅同時滿足您指定的所有標籤鍵的 ECS 資源才會被尋找到。同一標籤鍵下的標籤值之間為並集關係，即滿足您為該標籤鍵指定的任一標籤值的 ECS 資源均會被尋找到。說明 `TagFilter.N`與`Tag.N`參數不能同時使用，否則會返回錯誤資訊。	env

返回參數

名稱	類型	描述	樣本值
	object
NextToken	string	下一個查詢開始 Token。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	請求 ID。	484256DA-D816-44D2-9D86-B6EE4D5BA78C
TagResources	object
TagResource	array<object>	由資源及其標籤組成的集合，包含了資源 ID、資源類型和標籤索引值等資訊。
	object
TagValue	string	標籤值。	TestValue
ResourceType	string	資源類型。可能值： instance：ECS 執行個體。 disk：磁碟。 snapshot：快照。 image：鏡像。 securitygroup：安全性群組。 volume：儲存卷。 eni：彈性網卡。 ddh：Dedicated Host。 ddhcluster：Dedicated Host叢集。 keypair：SSH 金鑰對。 launchtemplate：啟動模板。 reservedinstance：預留執行個體券。 snapshotpolicy：自動快照策略。 elasticityassurance：彈性保障。 capacityreservation：容量預定。 command：雲助手命令。 invocation：雲助手命令執行結果。 activation：雲助手受管理的執行個體啟用碼。 managedinstance：雲助手受管理的執行個體。	instance
ResourceId	string	資源 ID。	i-bp1j6qtvdm8w0z1o****
TagKey	string	標籤鍵。	TestKey

樣本

正常返回樣本

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "TestValue",
        "ResourceType": "instance",
        "ResourceId": "i-bp1j6qtvdm8w0z1o****",
        "TagKey": "TestKey"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidDefaultResourceGroup.NotSupported	The specified parameter Tag is not support for default resource group.	不支援查詢預設資源群組。
400	InvalidTag.NotSupported	You can only specify Tag for either resource tag or resource group.	不支援同時查詢資源群組和標籤。
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed , Valid : 50.	指定的ResourceIds參數的數量超過限制。
400	NumberExceed.Tags	The Tags parameter's number is exceed , Valid : 20.	指定的標籤數量超過限制。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	標籤中存在重複的鍵，請保持鍵的唯一性。
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定的標籤鍵參數有誤。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定的標籤值參數有誤。
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	指定的 Tag.N.Key 和 Tag.N.Value 不匹配。
400	InvalidTagCount	The specified tags are beyond the permitted range.	指定的標記超出取值範圍。
400	Invalid.Scope	The specified scope is invalid.
400	InvalidTags.MalFormed	The tags must be empty, when the tagFilters is not empty.
500	ServiceUnavailable	The service is unavailable, please try again later.	服務暫時不可用，請稍候重試。
500	InternalError	The process of creating snapshot has failed due to some unknown error.	建立快照失敗。
403	PermissionDenied.TagOwnerBid	The specified operator not have permission to set TagOwnerBid value.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.	無權設定標籤歸屬者。
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.	指定的操作員無權設定範圍值。
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.
403	NoPermission.Tag	The operator is not permission for the tag.	您沒有操作該資源標籤的許可權。
403	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.	傳入的參數必須包含Tags或ResourcesIds其中的至少一個。
403	PermissionDenied.TagsFuzzyQuery	The specified operator has not permission to query fuzzy tags.
403	NumberExceed.TagValues	The number of the specified TagValues is beyond permitted range, the max is 5.
403	InvalidFilter.Malformed	The specified Filter is not valid.
403	InvalidTagFilter.Malformed	The specified TagFilter is not valid.
403	Invalid.NextToken	The specified NextToken is not valid.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	地區資訊錯誤
404	MissingParameter.ResourceIds	The parameter - ResourceIds.N should not be null.
404	MissingParameter.TagOwnerUid	The parameter - TagOwnerUid should not be null.
404	MissingParameter.TagOwnerBid	The parameter - TagOwnerBid should not be null.
404	MissingParameter.ResourceType	The parameter - ResourceType should not be null.	參數ResourceType不可為空。
404	MissingParameter.Tags	The parameter - Tags should not be null.
404	MissingParameter.RegionId	The parameter - RegionId should not be null.	必填參數RegionId為空白。
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.	指定的資源不存在，請檢查參數 ResourceId 是否正確。
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	指定的資源類型不存在。

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

變更歷史

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