
URI
POST /v2.0/{project_id}/loadbalancers/resource_instances/action
表1 參數(shù)說明
|
參數(shù)
|
是否必選
|
參數(shù)類型
|
描述
|
|
project_id
|
是
|
String
|
標(biāo)簽所在的項目ID。
獲取方法詳見獲取項目ID。
|
請求參數(shù)
表3 請求參數(shù)
|
參數(shù)
|
是否必選
|
參數(shù)類型
|
描述
|
|
tags
|
否
|
Array
|
待查詢的負(fù)載均衡器的標(biāo)簽列表,最多包含10個key,每個key下面的value最多10個;
key不能為空或者空字符串。
Key不能重復(fù),同一個key中values不能重復(fù)。
詳見表4 tags 字段數(shù)據(jù)結(jié)構(gòu)說明。
|
|
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
|
否
|
Array
|
搜索字段,key為要匹配的字段,如resource_name等。value為匹配的值。key為固定字典值。
根據(jù)不同的字段確認(rèn)是否需要模糊匹配,如resource_name默認(rèn)為模糊搜索,如果value為空字符串精確匹配。key如果是resource_id則精確匹配。詳見表5。
|
表4 tags 字段數(shù)據(jù)結(jié)構(gòu)說明
|
參數(shù)
|
是否必選
|
參數(shù)類型
|
描述
|
|
key
|
是
|
String
|
標(biāo)簽的鍵。最大長度127個unicode字符。key不能為空。(搜索時不對此參數(shù)做校驗)
|
|
values
|
是
|
Array
|
標(biāo)簽的值列表。每個值最大長度255個unicode字符,value之間為或的關(guān)系。
當(dāng)values為空列表時,表示按key全量搜索,當(dāng)values中的元素value以“*”開頭時,表示按*后面的值全模糊匹配。
|
表5 matches字段數(shù)據(jù)結(jié)構(gòu)說明
|
參數(shù)
|
是否必選
|
參數(shù)類型
|
描述
|
|
key
|
是
|
String
|
匹配的鍵。
取值范圍:
- resource_name:資源名稱;
- resource_id:資源id;
|
|
value
|
是
|
String
|
匹配的值。每個值最大長度255個unicode字符 。
|
響應(yīng)參數(shù)
表6 響應(yīng)參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
resources
|
Array
|
負(fù)載均衡器對象的列表。詳見表7。
|
|
total_count
|
Integer
|
總記錄數(shù)。
|
表7 resource 字段數(shù)據(jù)結(jié)構(gòu)說明
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
resource_id
|
String
|
資源ID。
|
|
resource_detail
|
String
|
資源詳情。資源對象,用于擴(kuò)展。默認(rèn)為空。
|
|
tags
|
Array
|
標(biāo)簽列表,沒有標(biāo)簽?zāi)J(rèn)為空數(shù)組。詳見表8。
|
|
resource_name
|
String
|
資源名稱,沒有默認(rèn)為空字符串。
|
|
super_resource_id
|
String
|
父級資源id
|
表8 tags 字段數(shù)據(jù)結(jié)構(gòu)說明
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
key
|
String
|
鍵。最大長度127個unicode字符。key不能為空。(搜索時不對此參數(shù)做校驗)
|
|
value
|
String
|
值。最大長度255個unicode字符。
|
請求示例
- 請求樣例1 action為filter時的請求體
POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/loadbalancers/resource_instances/action
{
"offset": "100",
"limit": "100",
"action": "filter",
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
],
"tags": [
{
"key": "key1",
"values": [
"*value1",
"value2"
]
}
]
}
- 請求樣例2 action為count時的請求體
POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/loadbalancers/resource_instances/action
{
"action": "count",
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
],
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
]
}
響應(yīng)示例
- 響應(yīng)樣例1 action為filter時響應(yīng)體
{
"resources": [
{
"resource_detail": "",
"resource_id": "154d135b-3a89-4e89-8023-06efb9acdc05",
"resource_name": "resouece1",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value1"
}
]
}
],
"total_count": 1000
}
- 響應(yīng)樣例2 action為count時響應(yīng)體
{
"total_count": 1000
}
