DescribeTags

呼叫 DescribeTags 介面查詢滿足篩選條件的標籤列表。

介面說明

請求中至少指定參數 ResourceId.N 或 Tag.N（Tag.N.Key 與 Tag.N.Value），以確定檢索對象。
Tag.N 是資源的標籤，由一個鍵值對組成。僅指定 Tag.N.Key 時，則傳回該標籤鍵關聯的所有標籤值。僅指定 Tag.N.Value 會報錯。
如果您同時指定 Tag.N 和 ResourceId.N 篩選標籤，則 ResourceId.N 須滿足任意輸入的標籤鍵值對。
如果您同時指定多個標籤鍵值對，傳回結果為所有滿足任意標籤值對的標籤。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeTags

get

*全部资源

*

vpc:tag

無

請求參數

名稱	類型	必填	描述	樣本值
ResourceType	string	否	資源類型。取值： VPC：表示資源類型為專有網路執行個體。 VSWITCH：表示資源類型為交換機執行個體。 ROUTETABLE：表示資源類型為路由表執行個體。 EIP：表示資源類型為彈性公網 IP 執行個體。 VPNGATEWAY：表示資源類型為 VPN 閘道執行個體。 NATGATEWAY：表示資源類型為 NAT 閘道執行個體。 COMMONBANDWIDTHPACKAGE：表示資源類型為共享頻寬執行個體。 PREFIXLIST：表示資源類型為前綴列表執行個體。 PUBLICIPADDRESSPOOL：表示資源類型為 IP 位址池執行個體。 IPV4GATEWAY：表示資源類型為 IPv4 閘道執行個體。 IPV6GATEWAY：表示資源類型為 IPv6 閘道執行個體。 NETWORKACL：表示資源類型為網路 ACL 執行個體。 TRAFFICMIRRORFILTER：表示資源類型為流量鏡像篩選條件執行個體。 TRAFFICMIRRORSESSION：表示資源類型為流量鏡像工作階段執行個體。 FLOWLOG：表示資源類型為流日誌執行個體。 HAVIP：表示資源類型為高可用虛擬 IP 執行個體。 DHCPOPTIONSSET：表示資源類型為 DHCP 選項集執行個體。 GATEWAYENDPOINT：表示資源類型為閘道端點執行個體。說明輸入的資源類型取值不區分大小寫。	VPC
RegionId	string	是	資源所屬的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
NextToken	string	否	是否擁有下一次查詢的權杖（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫傳回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResult	integer	否	分頁大小，取值範圍：1~50，預設值：50。	50
ResourceId	array	否	資源 ID。最多支援輸入 50 個資源 ID。
	string	否	資源 ID。最多支援輸入 50 個資源 ID。說明當輸入此參數時，必須輸入 ResourceType 參數。	vpc-bp16qjewdsunr41m1****
Tag	array<object>	否	資源的標籤集合。
	object	否	資源的標籤集合。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。一個標籤鍵最多支援 128 個字元，不能是空字串，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。一個標籤值最多支援 128 個字元，可以是空字串，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	object
NextToken	string	是否擁有下一次查詢的權杖（Token）。取值：如果 NextToken 為空表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的權杖。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	請求 ID。	C46FF5A8-C5F0-4024-8262-B16B639225A0
TagResources	object
TagResource	array<object>	所有滿足篩選條件的標籤列表。
	object	標籤列表。
TagValue	string	標籤值。	FinanceJoshua
TagKey	string	標籤鍵。	FinanceDept

樣本

正常返回樣本

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.
400	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.
400	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.
400	InvalidTagKey	The tag keys are not valid.
400	InvalidTagValue	The tag values are not valid.
400	MissingParam	%s
400	InvalidInstanceType.NotFound	The instance type is not found
400	InvalidInstanceIds.NotFound	The instanceIds are not found
400	Forbidden.TagKeys	The request do not allow to operate the tag keys
400	QuotaExceeded.TagNum	Custom Tags quota exceeded
400	Forbidden.NotAllowedCategary	The System tag is not valid
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.
400	SizeLimitExceeded.ResourceId	The maximum number of resource IDs is exceeded.
403	Forbidden	User not authorized to operate on the specified resource.

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

變更歷史

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