調用ListTagResources,查詢可見的資源標籤關係。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
要求標頭
該介面使用公用要求標頭,無特殊要求標頭。請參見公用請求參數文檔。
請求文法
GET /openapi/tags HTTP/1.1
請求參數
|
名稱 |
類型 |
位置 |
是否必選 |
樣本值 |
描述 |
| Page | Integer | Query | 否 | 1 | 資源關係列表的分頁數,廢棄欄位。 |
| Size | Integer | Query | 否 | 10 | 分頁查詢時設定的每頁條數,廢棄欄位。 |
| ResourceType | String | Query | 是 | INSTANCE | 資源類型定義。 |
| NextToken | String | Query | 否 | 1d2db86sca4384811e0b5e8707e****** | 下一個查詢開始的Token。 |
| ResourceIds | String | Query | 否 | ["es-cn-aaa","es-cn-bbb"] | 要查詢的執行個體ID列表。採用JSON數組格式,最多支援20個子項。 |
| Tags | String | Query | 否 | [{"key":"env","value":"dev"},{"key":"dev", "value":"IT"}] | 要查詢的Tags列表,採用JSON字串的形式,最多包含20個子項。 |
- 您需要在ResourceIds和Tags參數中,至少選擇一個傳入值,否則報錯。
-
您只能查詢系統標籤中的可見標籤,不能查詢不可見標籤。
說明 系統標籤是指雲產品(即阿里雲服務)給使用者執行個體添加的標籤。系統標籤分為可見標籤和不可見標籤。
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| PageSize | Integer | 1 | 分頁數。 |
| RequestId | String | F99407AB-2FA9-489E-A259-40CF6D****** | 請求ID。 |
| Headers | Object | 返回頭資訊。該參數為空白,僅供參考,程式中不能強制依賴此參數。 說明 返回樣本中不包含此參數。 |
|
| X-Total-Count | Integer | 10 | 查詢到TagResource的資源數量。 |
| TagResources | Object | 標籤資源群組。 |
|
| TagResource | Array of TagResource | 標籤資源。 |
|
| TagValue | String | dev | 標籤值。 |
| ResourceType | String | ALIYUN::ELASTICSEARCH::INSTANCE | 資源類型。固定為 |
| ResourceId | String | es-cn-oew1q8bev0002**** | 資源ID。 |
| TagKey | String | env | 標籤鍵。 |
樣本
請求樣本
GET /openapi/tags?ResourceType=INSTANCE&NextToken=1d2db86sca4384811e0b5e8707e******&ResourceIds=["es-cn-aaa","es-cn-bbb"]&Tags=[{"key":"env", "value":"dev"},{"key":"dev", "value":"IT"}] HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
正常返回樣本
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "A5423B74-DBD5-4714-BF28-6725E5BE****",
"TagResources" : {
"TagResource" : [ {
"ResourceType" : "ALIYUN::ELASTICSEARCH::INSTANCE",
"ResourceId" : "es-cn-oew1q8bev0002****",
"TagKey" : "env",
"TagValue" : "dev"
} ]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。