功能介紹
使用標(biāo)簽過濾查詢租戶下資源的實(shí)例。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
POST /v1/{project_id}/{resource_type}/resource_instances/action
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID。 |
|
resource_type |
是 |
String |
資源類型，值為：endpoint_service或endpoint。 |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。 |
|
Content-Type |
否 |
String |
發(fā)送的實(shí)體的MIME類型。推薦用戶默認(rèn)使用application/json， 如果API是對(duì)象、 鏡像 上傳等接口，媒體類型可按照流類型的不同進(jìn)行確定。 缺省值：application/json |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
tags |
否 |
包含標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè)， 每個(gè)key對(duì)應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。Key不能重復(fù)， 同一個(gè)key中values不能重復(fù)。結(jié)果返回包含所有標(biāo)簽的資源列表， key之間是與的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。 無tag過濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
tags_any |
否 |
包含任意標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè)， 每個(gè)key對(duì)應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。 Key不能重復(fù)，同一個(gè)key中values不能重復(fù)。 結(jié)果返回包含標(biāo)簽的資源列表，key之間是或的關(guān)系，key、value結(jié)構(gòu)中value是或的關(guān)系。 無過濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
not_tags |
否 |
不包含標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè)， 每個(gè)key對(duì)應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。Key不能重復(fù)， 同一個(gè)key中values不能重復(fù)。結(jié)果返回不包含標(biāo)簽的資源列表，key之間是與的關(guān)系， key、value結(jié)構(gòu)中value是或的關(guān)系。 無過濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
not_tags_any |
否 |
不包含任意標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè)， 每個(gè)key對(duì)應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。Key不能重復(fù)， 同一個(gè)key中values不能重復(fù)。結(jié)果返回不包含標(biāo)簽的資源列表， key之間是與的關(guān)系，key、value結(jié)構(gòu)中value是或的關(guān)系。 無過濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
sys_tags |
否 |
系統(tǒng)標(biāo)簽， |
|
|
limit |
否 |
String |
查詢記錄數(shù)（action為count時(shí)無此參數(shù)）如果action為filter默認(rèn)為1000， limit最多為1000，不能為負(fù)數(shù)，最小值為1。 |
|
offset |
否 |
String |
索引位置，偏移量（action為count時(shí)無此參數(shù)）從第一條數(shù)據(jù)偏移offset條數(shù)據(jù)后開始查詢， 如果action為filter默認(rèn)為0（偏移0條數(shù)據(jù)，表示從第一條數(shù)據(jù)開始查詢）， 必須為數(shù)字，不能為負(fù)數(shù)。 |
|
action |
是 |
String |
操作標(biāo)識(shí)（僅限于filter，count）：filter（過濾）， count(查詢總條數(shù))如果是filter就按照過濾條件查詢， 如果是count，只需要返回總條數(shù)，禁止返回其他字段。 |
|
matches |
否 |
搜索字段，key為要匹配的字段，如resource_name等。value為匹配的值。 key為固定字典值，不能包含重復(fù)的key或不支持的key。 根據(jù)key的值確認(rèn)是否需要模糊匹配，如resource_name默認(rèn)為模糊搜索（不區(qū)分大小寫）， 如果value為空字符串精確匹配（多數(shù)服務(wù)不存在資源名稱為空的情況， 因此此類情況返回空列表）。resource_id為精確匹配。 第一期只做resource_name，后續(xù)再擴(kuò)展。 |
|
|
without_any_tag |
否 |
Boolean |
默認(rèn)為false，取值【true/false】,當(dāng)withoutAnyTag=true， 忽略tags、tagsAny、notTags、notTagsAny參數(shù)校驗(yàn)。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
key |
是 |
String |
鍵。 最大長度127個(gè)unicode字符。key不能為空。(搜索時(shí)不對(duì)此參數(shù)做字符集校)， key不能為空或者空字符串，不能為空格，校驗(yàn)和使用之前先trim前后半角空格。 最小長度：1 最大長度：36 |
|
values |
是 |
Array of strings |
值列表。 每個(gè)值最大長度255個(gè)unicode字符，校驗(yàn)和使用之前先trim前后半角空格。 value可為空數(shù)組但不可缺省。如果values為空列表，則表示any_value（查詢?nèi)我鈜alue）。 value之間為或的關(guān)系。(搜索時(shí)不對(duì)此參數(shù)做字符集校驗(yàn)，只做長度校驗(yàn))。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
resources |
資源實(shí)例詳情 |
|
|
total_count |
Integer |
總記錄數(shù)。 最小值：1 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
resource_id |
String |
資源ID，Endpoint Service ID或Endpoint ID。 |
|
tags |
標(biāo)簽列表。 |
|
|
resource_name |
String |
資源名稱，資源沒有名稱時(shí)，返回ID。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
鍵。 最大長度36個(gè)unicode字符。 key不能為空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長度：1 最大長度：36 |
|
value |
String |
值。 每個(gè)值最大長度43個(gè)unicode字符，可以為空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長度：1 最大長度：43 |
狀態(tài)碼： 400
狀態(tài)碼： 401
狀態(tài)碼： 403
狀態(tài)碼： 404
狀態(tài)碼： 405
狀態(tài)碼： 406
狀態(tài)碼： 407
狀態(tài)碼： 408
狀態(tài)碼： 409
狀態(tài)碼： 500
狀態(tài)碼： 501
狀態(tài)碼： 502
狀態(tài)碼： 503
狀態(tài)碼： 504
請(qǐng)求示例
-
使用標(biāo)簽查詢終端節(jié)點(diǎn)
POST https://{endpoint}/v1/{project_id}/endpoint/resource_instances/action action為filter時(shí)請(qǐng)求體 { "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "not_tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ] } -
查詢終端節(jié)點(diǎn)服務(wù)資源總數(shù)
https://{endpoint}/v1/{project_id}/endpoint_service/ resource_instances/action action為count時(shí)請(qǐng)求體 { "action": "count", "not_tags": [ { "key": "key1", "values": [ "value1", "*value2" ] } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
響應(yīng)示例
狀態(tài)碼： 200
服務(wù)器已成功處理了請(qǐng)求
– action為filter時(shí)響應(yīng)體
{
"resources": [
{
"resource_id": "cdfs_cefs_wesas_12_dsad",
"resource_name": "resource1",
"tags": [
{
"key": "key1", "value": "value1"
},
{
"key": "key2", "value": "value1"
}
]
}
],
"total_count": 1000
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
服務(wù)器已成功處理了請(qǐng)求 |
|
400 |
服務(wù)器未能處理請(qǐng)求 |
|
401 |
被請(qǐng)求的頁面需要用戶名和密碼 |
|
403 |
對(duì)被請(qǐng)求頁面的訪問被禁止 |
|
404 |
服務(wù)器無法找到被請(qǐng)求的頁面 |
|
405 |
請(qǐng)求中指定的方法不被允許 |
|
406 |
服務(wù)器生成的響應(yīng)無法被客戶端所接受 |
|
407 |
用戶必須首先使用代理服務(wù)器進(jìn)行驗(yàn)證，這樣請(qǐng)求才會(huì)被處理 |
|
408 |
請(qǐng)求超出了服務(wù)器的等待時(shí)間 |
|
409 |
由于沖突，請(qǐng)求無法被完成 |
|
500 |
請(qǐng)求未完成。服務(wù)異常 |
|
501 |
請(qǐng)求未完成。服務(wù)器不支持所請(qǐng)求的功能 |
|
502 |
請(qǐng)求未完成。服務(wù)器從上游服務(wù)器收到一個(gè)無效的響應(yīng) |
|
503 |
請(qǐng)求未完成。系統(tǒng)暫時(shí)異常 |
|
504 |
網(wǎng)關(guān)超時(shí) |
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
