功能介紹
使用標(biāo)簽過濾實(shí)例。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /v2.0/{project_id}/vpcs/resource_instances/action
請求參數(shù)
|
參數(shù)名稱 |
類型 |
是否必選 |
說明 |
|---|---|---|---|
|
tags |
否 |
包含標(biāo)簽，最多包含10個key，每個key下面的value最多10個，結(jié)構(gòu)體不能缺失，key不能為空或者空字符串。Key不能重復(fù)，同一個key中values不能重復(fù)。 |
|
|
limit |
Integer |
否 |
查詢記錄數(shù)（action為count時無此參數(shù)）如果action為filter默認(rèn)為1000，limit最多為1000，不能為負(fù)數(shù)，最小值為1 |
|
offset |
Integer |
否 |
（索引位置）， 從offset指定的下一條數(shù)據(jù)開始查詢。 查詢第一頁數(shù)據(jù)時，不需要傳入此參數(shù)，查詢后續(xù)頁碼數(shù)據(jù)時，將查詢前一頁數(shù)據(jù)時響應(yīng)體中的值帶入此參數(shù)（action為count時無此參數(shù)）如果action為filter默認(rèn)為0，必須為數(shù)字，不能為負(fù)數(shù) |
|
action |
String |
是 |
操作標(biāo)識（僅限于filter，count）：filter（過濾），count(查詢總條數(shù)) 如果是filter就是分頁查詢，如果是count只需按照條件將總條數(shù)返回即可。 |
|
matches |
否 |
搜索字段，key為要匹配的字段，當(dāng)前僅支持resource_name。value為匹配的值。此字段為固定字典值。 |
請求示例
- 過濾查詢VPC資源實(shí)例，action為filter，從第1條數(shù)據(jù)開始查詢，單次查詢最多返回100條，用matches和tags過濾查詢。
POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action { "offset": "0", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ] }
- 過濾計(jì)數(shù)VPC資源實(shí)例，action為count，用matches和tags過濾計(jì)數(shù)。
POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
響應(yīng)參數(shù)
|
名稱 |
參數(shù)類型 |
說明 |
|---|---|---|
|
resources |
||
|
total_count |
Integer |
總記錄數(shù) |
響應(yīng)示例
- action為filter
{ "resources": [ { "resource_detail": null, "resource_id": "cdfs_cefs_wesas_12_dsad", "resource_name": "resouece1", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ], "total_count": 1000 }
- action為count
{ "total_count": 1000 }
狀態(tài)碼
請參見狀態(tài)碼。
錯誤碼
請參考錯誤碼。
