DescribeTags查詢標籤列表-ApsaraDB for MongoDB-阿里雲

查詢目標地區中所有的標籤資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeTags

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。您可以通過調用 DescribeRegions 介面查詢。	cn-hangzhou
ResourceType	string	否	資源類型，取值固定為 INSTANCE。	INSTANCE
ResourceGroupId	string	否	資源群組 ID。	dds-bp17e7a04960****
NextToken	string	否	下一個查詢開始 Token，用來返回更多結果。說明第一次查詢不需要提供本參數，如果一次查詢沒有返回全部結果，則可在後續查詢中傳入前一次返回的 NextToken 值以繼續查詢。	212db86****

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
NextToken	string	下一個查詢開始 Token。說明如果一次查詢沒有返回全部結果，則會返回本參數，您可以後續查詢中傳入本參數的值以繼續查詢。	212db86****
RequestId	string	請求 ID。	EEDBE38F-5CF5-4316-AAC2-35817BA60D68
Tags	array<object>	標籤資訊。
	object	標籤資訊。
TagValues	array	標籤的值。
	string	標籤的值。	3.4環境
TagKey	string	標籤的鍵。	測試組

樣本

正常返回樣本

JSON格式

{
  "NextToken": "212db86****",
  "RequestId": "EEDBE38F-5CF5-4316-AAC2-35817BA60D68",
  "Tags": [
    {
      "TagValues": [
        "3.4環境"
      ],
      "TagKey": "測試組"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidTagKey.Malformed	The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.	指定的參數“Tag.n.Key”或“TagKey.n”無效。
400	InvalidTagValue.Malformed	The specified parameter 'Tag.n.Value' is not valid.
400	InvalidParameter.ResourceId	The specified parameter 'ResourceId.n' is not valid.
400	MissParameter.TagOrResourceId	The parameter 'Tag.n'' or 'ResourceId.n' is needed.
400	InvalidParameter.Scope	The specified parameter 'Scope' is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed.
400	NumberExceed.Tags	The Tags parameter's number is exceed.
400	Duplicate.TagKey	The specified parameter 'Tag.n.Key' is duplicated.
400	InvalidParameter.ResourceType	The specified parameter 'ResourceType' is not valid.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

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

變更歷史

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