功能介紹
查詢資源實(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 |
資源類型。
枚舉值：
|
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值）。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
action |
是 |
String |
操作標(biāo)識(shí)（僅限于filter，count）：filter（過(guò)濾），count(查詢總條數(shù))。 為filter時(shí)表示分頁(yè)查詢，為count只需按照條件將總條數(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時(shí)，默認(rèn)為0，必須為數(shù)字，且不能為負(fù)數(shù)。 |
|
limit |
否 |
String |
查詢記錄數(shù)。 action為count時(shí)無(wú)此參數(shù)。 action為filter時(shí)，默認(rèn)為1000。limit最多為1000，不能為負(fù)數(shù)，最小值為1。 |
|
without_any_tag |
否 |
Boolean |
不包含任意一個(gè)標(biāo)簽，該字段為true時(shí)查詢所有不帶標(biāo)簽的資源。 |
|
tags |
否 |
最多包含10個(gè)key，每個(gè)key最多包含10個(gè)value，結(jié)構(gòu)體不能缺失。key不能為空或者空字符串。key不能重復(fù)，同一個(gè)key中value不能重復(fù)，不同key對(duì)應(yīng)的資源之間為與的關(guān)系。 |
|
|
matches |
否 |
搜索字段。 key為要匹配的字段，當(dāng)前只支持resource_name。 value為匹配的值，當(dāng)前為精確匹配。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
resources |
資源列表。 |
|
|
total_count |
Integer |
資源總數(shù)。 |
請(qǐng)求示例
-
查詢資源實(shí)例數(shù)量
Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/resource_instances/action { "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] } -
查詢資源實(shí)例列表
Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/resource_instances/action { "offset" : "100", "limit" : "100", "action" : "filter", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
響應(yīng)示例
狀態(tài)碼： 200
ok
{
"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
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
ok |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
