功能介紹
通過(guò)標(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 /v3/{project_id}/{resource_type}/resource-instances/action
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租戶項(xiàng)目ID |
|
resource_type |
是 |
String |
枚舉值：
|
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
offset |
否 |
String |
索引位置， 從offset指定的下一條數(shù)據(jù)開(kāi)始查詢。 查詢第一頁(yè)數(shù)據(jù)時(shí)，不需要傳入此參數(shù)，查詢后續(xù)頁(yè)碼數(shù)據(jù)時(shí)，將查詢前一頁(yè)數(shù)據(jù)時(shí)響應(yīng)體中的值帶入此參數(shù)（action為count時(shí)無(wú)此參數(shù)）如果action為filter默認(rèn)為0,必須為數(shù)字，不能為負(fù)數(shù) |
|
limit |
否 |
String |
查詢記錄數(shù)（action為count時(shí)無(wú)此參數(shù)）如果action為filter默認(rèn)為1000，limit最多為1000,不能為負(fù)數(shù)，最小值為1 |
|
action |
是 |
String |
操作標(biāo)識(shí)（僅限于filter，count）：filter（過(guò)濾），count(查詢總條數(shù)) 如果是filter就是分頁(yè)查詢，如果是count只需按照條件將總條數(shù)返回即可。禁止返回其他字段。 枚舉值：
|
|
matches |
否 |
搜索字段,key為要匹配的字段，如resource_name等。value為匹配的值。此字段為固定字典值。根據(jù)不同的字段確認(rèn)是否需要模糊匹配，如resource_name默認(rèn)為模糊搜索（不區(qū)分大小寫），如果value為空字符串精確匹配。resource_id為精確匹配。第一期只做resource_name，后續(xù)在擴(kuò)展。 |
|
|
not_tags |
否 |
不包含標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè), 結(jié)構(gòu)體不能缺失，key不能為空或者空字符串。Key不能重復(fù)，同一個(gè)key中values不能重復(fù)。返回不包含標(biāo)簽的資源列表，key之間是與的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。無(wú)過(guò)濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
tags |
否 |
包含標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè)，結(jié)構(gòu)體不能缺失，key不能為空或者空字符串。Key不能重復(fù)，同一個(gè)key中values不能重復(fù)。返回包含所有標(biāo)簽的資源列表，key之間是與的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。無(wú)tag過(guò)濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
tags_any |
否 |
包含任意標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè),結(jié)構(gòu)體不能缺失，key不能為空或者空字符串。Key不能重復(fù)，同一個(gè)key中values不能重復(fù)。返回包含標(biāo)簽的資源列表，key之間是或的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。無(wú)過(guò)濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
not_tags_any |
否 |
不包含任意標(biāo)簽，最多包含10個(gè)key，每個(gè)key下面的value最多10個(gè),結(jié)構(gòu)體不能缺失，key不能為空或者空字符串。Key不能重復(fù)，同一個(gè)key中values不能重復(fù)。返回不包含標(biāo)簽的資源列表，key之間是或的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。無(wú)過(guò)濾條件時(shí)返回全量數(shù)據(jù)。 |
|
|
sys_tags |
否 |
僅op_service權(quán)限可以使用此字段做資源實(shí)例過(guò)濾條件。目前TMS調(diào)用時(shí)只包含一個(gè)tag結(jié)構(gòu)體。key：_sys_enterprise_project_id，value：企業(yè)項(xiàng)目id列表。目前TMS調(diào)用時(shí)，key下面只包含一個(gè)value。0表示默認(rèn)企業(yè)項(xiàng)目。sys_tags和租戶標(biāo)簽過(guò)濾條件（without_any_tag 、tags、tags_any、not_tags、not_tags_any）不能同時(shí)使用。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
resources |
資源列表。 |
|
|
total_count |
Integer |
總記錄數(shù)。 |
|
request_id |
String |
請(qǐng)求ID |
請(qǐng)求示例
-
action為filter時(shí)，根據(jù)標(biāo)簽查詢資源。
https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource-instances/action { "offset" : "10", "limit" : "10", "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" ] } ] } -
action為count時(shí)，查詢資源總數(shù)。
https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource_instances/action { "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" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
響應(yīng)示例
狀態(tài)碼： 200
查詢操作成功。
{
"resources" : [ ],
"total_count" : 0,
"request_id" : "9a4f4dfc4fb2fc101e65bba07d908535"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
查詢操作成功。 |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
