調用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"
} ]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?