調用DescribeTags介面查詢RDS執行個體的標籤。

調用本介面時限制條件如下：

  • 如果傳入指定執行個體ID，則查詢該執行個體下所有標籤，其他過濾條件失效；
  • 若查詢標籤時僅傳入標籤鍵（TagKey），未傳入標籤值（TagValue），則返回所有符合標籤鍵條件的結果。若同時傳入標籤鍵和標籤值，則返回兩個條件都符合的結果。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String 是 DescribeTags

系統規定參數，取值：DescribeTags。

RegionId String 是 cn-hangzhou

地區ID，可以通過介面DescribeRegions查看可用的地區ID。

DBInstanceId String 否 rm-uf6wjk5xxxxxxx

執行個體ID。

说明 傳入該參數，其他過濾條件失效。
Tags String 否 {“key1”:”value1”}

需要查詢的標籤，包括TagKey和TagValue。格式：{“key1”:”value1”}。
AccessKeyId String 否 LTAIfCxxxxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰ID。
ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxxxxx

用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過64個ASCII字元，且該參數值中不能包含非ASCII字元。
proxyId String 否 API

代理模式ID。

返回資料

名稱 類型 樣本值 描述
Items

由Tag資訊組成的數組。
TagKey String key1

標籤鍵。
TagValue String value1

標籤值。
DBInstanceIds rm-uf6wjk5xxxxxxx

該標籤所綁定的執行個體ID。
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

請求ID。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=DescribeTags
&RegionId=cn-hangzhou
&<公用請求參數>

正常返回樣本

XML 格式 

<DescribeTagsResponse>
	  <Items>
		    <TagInfos>
			      <TagValue>1</TagValue>
			      <TagKey>測試</TagKey>
			      <DBInstanceIds>
				        <DBInstanceIds>rm-uf6wjk5xxxxxxx</DBInstanceIds>
			      </DBInstanceIds>
		    </TagInfos>
	  </Items>
	  <RequestId>6D709088-6D7D-4152-99F4-C2FE86463862</RequestId>	
</DescribeTagsResponse>

JSON 格式 

{
	"Items":{
		"TagInfos":[
			{
				"TagValue":"1",
				"TagKey":"測試",
				"DBInstanceIds":{
					"DBInstanceIds":[
						"rm-uf6wjk5xxxxxxx"
					]
				}
			}
		]
	},
	"RequestId":"6D709088-6D7D-4152-99F4-C2FE86463862"
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 Tag.NoRegionIdExist the region Id can not be blank. RegionId不可為空。建立，續約，變更配置的時候region不可為空。
400 Tag.NoTagInfoExist all the tags and tagN parameters is null. Tag參數無效。
400 Tag.TagKeyCanNotBeAll tag key can not be all. TagKey無效。
400 Tag.TagKeyDuplex tag key must be sole in one operation. 標籤鍵必須是唯一的。
400 Tag.NoDBInstanceIdExist the dbinstance Id can not be blank. 執行個體Id是必傳參數。續約，變更配置的時候，執行個體Id不可為空。
400 Tag.TooManyDBInstanceIds the dbinstance Ids is more than 30. 執行個體Id的最多為30個。
400 Tag.TooManyTagsForOneInstance total 10 tags can be added to one resource. 一個資源最多可以添加10個tag，請您不要超量添加。
400 Tag.SetTagInfoAtTwoParamters only tags or tagN parameter could be setted. 你的tag參數設定取消。
400 Tag.Allow5TagInfos only 5 tags allowed in one operation. 在一次操作中最多可以使用5個標記。
400 Tag.TagKeyIsBlank tag key can not be blank. 標籤鍵不可為空。
400 Tag.TagKeyStartWith.aliyun tag key and value can not be started with aliyun. TagKeyStartWith無效。
400 Tag.TagKeyTooLong the max tag key's length is 64. 標籤鍵的長度不能超過64。
400 Tag.TagValueTooLong the max tag value's length is 128. 標籤值的長度不能超過128。
400 Tag.InvalidTagsParamter tags paramter is invalid. 標籤參數無效。
404 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in our records. 執行個體不存在。確認該執行個體是在當前帳號下面，確定未被刪除。
400 Tag.Malformed The specified parameter Tag is not valid. Tag無效
400 Tag.Malformed The specified parameter Value is not valid. TagValue無效

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