功能介紹
查詢轉(zhuǎn)發(fā)規(guī)則。支持過濾查詢和分頁查詢。如未特殊說明,匹配規(guī)則為精確匹配。
接口約束
分頁查詢使用的參數(shù)為marker、limit、page_reverse。marker和page_reverse只有和limit一起使用時才會生效,單獨使用無效。
調(diào)試
您可以在API Explorer中直接運行調(diào)試該接口。
URI
GET /v2/{project_id}/elb/l7policies/{l7policy_id}/rules
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
操作用戶的項目ID。 獲取方法詳見獲取項目ID。 |
l7policy_id |
是 |
String |
轉(zhuǎn)發(fā)策略id。 |
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
marker |
否 |
String |
分頁查詢的起始的資源ID,表示上一頁最后一條查詢記錄的轉(zhuǎn)發(fā)規(guī)則的ID。 必須與limit一起使用。 |
limit |
否 |
Integer |
分頁查詢每頁的轉(zhuǎn)發(fā)規(guī)則個數(shù)。如果不設(shè)置,則默認不分頁查詢所有。 |
page_reverse |
否 |
Boolean |
分頁的順序,true表示從后往前分頁,false表示從前往后分頁,默認為false。 必須與limit一起使用。 |
id |
否 |
String |
轉(zhuǎn)發(fā)規(guī)則ID。 |
tenant_id |
否 |
String |
轉(zhuǎn)發(fā)規(guī)則所在的項目ID。 支持的最大字符長度:255 |
project_id |
否 |
String |
此參數(shù)和tenant_id參數(shù)含義一樣,均指轉(zhuǎn)發(fā)規(guī)則所在的項目ID。 |
admin_state_up |
否 |
Boolean |
轉(zhuǎn)發(fā)規(guī)則的管理狀態(tài); 該字段為預(yù)留字段,暫未啟用。默認為true。 |
type |
否 |
String |
轉(zhuǎn)發(fā)規(guī)則的匹配類型。 取值范圍:
同一個轉(zhuǎn)發(fā)策略下轉(zhuǎn)發(fā)規(guī)則的type不能重復(fù)。 |
compare_type |
否 |
String |
轉(zhuǎn)發(fā)匹配方式: type為HOST_NAME時,取值范圍:
type為PATH時,取值范圍:
|
invert |
否 |
Boolean |
是否反向匹配; 取值范圍:true/false。默認值:false; 該字段為預(yù)留字段,暫未啟用。 |
key |
否 |
String |
匹配內(nèi)容的鍵值。默認為null。 該字段為預(yù)留字段,暫未啟用。 支持的最大字符長度:255 |
value |
否 |
String |
匹配內(nèi)容的值。 支持的最大字符長度:128
|
provisioning_status |
否 |
String |
該字段為預(yù)留字段,暫未啟用。 轉(zhuǎn)發(fā)規(guī)則的配置狀態(tài),可以為ACTIVE。 |
請求消息
無
響應(yīng)消息
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
rules |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
id |
String |
轉(zhuǎn)發(fā)規(guī)則ID |
tenant_id |
String |
轉(zhuǎn)發(fā)規(guī)則所在的項目ID。 支持的最大字符長度:255 |
project_id |
String |
此參數(shù)和tenant_id參數(shù)含義一樣,均指轉(zhuǎn)發(fā)規(guī)則所在的項目ID。 |
admin_state_up |
Boolean |
轉(zhuǎn)發(fā)規(guī)則的管理狀態(tài); 該字段為預(yù)留字段,暫未啟用。取值范圍:true/false。
|
type |
String |
轉(zhuǎn)發(fā)規(guī)則的匹配類型。 取值范圍:
|
compare_type |
String |
轉(zhuǎn)發(fā)匹配方式: type為HOST_NAME時,取值范圍:
type為PATH時,取值范圍:
|
invert |
Boolean |
是否反向匹配; 取值范圍:true/false。默認值:false; 該字段為預(yù)留字段,暫未啟用。 |
key |
String |
匹配內(nèi)容的鍵值。默認為null。 該字段為預(yù)留字段,暫未啟用。 支持的最大字符長度:255 |
value |
String |
匹配內(nèi)容的值。 支持的最大字符長度:128
|
provisioning_status |
String |
該字段為預(yù)留字段,暫未啟用。 轉(zhuǎn)發(fā)規(guī)則的配置狀態(tài),可以為ACTIVE。 |
請求示例
- 請求樣例 全量查詢指定轉(zhuǎn)發(fā)策略關(guān)聯(lián)的轉(zhuǎn)發(fā)規(guī)則
GET https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/
l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586/rules
響應(yīng)示例
- 響應(yīng)樣例
{ "rules": [ { "compare_type": "EQUAL_TO", "provisioning_status": "ACTIVE", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "www.test.com", "key": null, "type": "HOST_NAME", "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "compare_type": "EQUAL_TO", "provisioning_status": "ACTIVE", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "/aaa.html", "key": null, "type": "PATH", "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ] }
返回碼
請參見狀態(tài)碼。