華為云計算 云知識 查詢轉(zhuǎn)發(fā)策略列表ListL7policies
查詢轉(zhuǎn)發(fā)策略列表ListL7policies

 

功能介紹

查詢轉(zhuǎn)發(fā)策略。支持過濾查詢和分頁查詢。如未特殊說明,匹配規(guī)則為精確匹配。

調(diào)試

您可以在API Explorer中直接運行調(diào)試該接口。

URI

GET /v2/{project_id}/elb/l7policies

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

操作用戶的項目ID。

獲取方法詳見獲取項目ID。

表2 查詢參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

marker

String

分頁查詢的起始的資源ID,表示上一頁最后一條查詢記錄的轉(zhuǎn)發(fā)策略的ID。

必須與limit一起使用。

limit

Integer

分頁查詢每頁的轉(zhuǎn)發(fā)策略個數(shù)。如果不設置,則默認不分頁查詢所有。

page_reverse

Boolean

分頁的順序,true表示從后往前分頁,false表示從前往后分頁,默認為false。

必須與limit一起使用。

id

String

轉(zhuǎn)發(fā)策略ID。

tenant_id

String

轉(zhuǎn)發(fā)策略所在的項目ID。

支持的最大字符長度:255

獲取方法詳見獲取項目ID。

project_id

String

此參數(shù)和tenant_id參數(shù)含義一樣,均指轉(zhuǎn)發(fā)策略所在的項目ID。

獲取方法詳見獲取項目ID

name

String

轉(zhuǎn)發(fā)策略名稱。

支持的最大字符長度:255

admin_state_up

Boolean

轉(zhuǎn)發(fā)策略的管理狀態(tài)。

該字段為預留字段,暫未啟用。默認為true。

description

String

轉(zhuǎn)發(fā)策略的描述信息。

支持的最大字符長度:255

listener_id

String

轉(zhuǎn)發(fā)策略所在的監(jiān)聽器ID。

action

String

轉(zhuǎn)發(fā)策略的匹配動作。

取值范圍:

  • REDIRECT_TO_POOL:將匹配的流量轉(zhuǎn)發(fā)到redirect_pool_id指定的后端 云服務器 組上;
  • REDIRECT_TO_LISTENER:將listener_id指定的HTTP監(jiān)聽器的流量重定向到redirect_listener_id指定的TERMINATED_HTTPS監(jiān)聽器上。

redirect_pool_id

String

流量匹配后轉(zhuǎn)發(fā)到后端云服務器組的ID。

redirect_listener_id

String

流量匹配后轉(zhuǎn)發(fā)到的監(jiān)聽器的ID。

redirect_url

String

轉(zhuǎn)發(fā)策略重定向到的url。

該字段為預留字段,暫未啟用。

支持的最大字符長度:255

position

Integer

轉(zhuǎn)發(fā)優(yōu)先級,從1遞增,最高100。默認值:100;

該字段為預留字段,暫未啟用。

provisioning_status

String

該字段為預留字段,暫未啟用。

轉(zhuǎn)發(fā)策略的配置狀態(tài),可以為ACTIVE。

enterprise_project_id

String

企業(yè)項目ID,僅用于基于企業(yè)項目的細粒度鑒權使用。

  • 如果參數(shù)中傳遞了listerener_id,則用該 負載均衡 器對應的企業(yè)項目ID鑒權。
  • 如果參數(shù)中沒有傳遞listerener_id,則使用轉(zhuǎn)發(fā)策略對應的企業(yè)項目id鑒權。
  • 如果listener_id和enterprise_project_id都沒有傳遞 ,則默認進行細粒度鑒權 ,必須在用戶組下分配elb:*list權限才能通過鑒權。

請求消息

響應消息

表3 響應參數(shù)

參數(shù)

參數(shù)類型

描述

l7policies

Array of L7policies objects

轉(zhuǎn)發(fā)策略對象列表。列表元素數(shù)據(jù)結(jié)構詳見表4 l7policies字段說明。

表4 l7policy字段說明

參數(shù)

參數(shù)類型

描述

id

String

轉(zhuǎn)發(fā)策略ID。

tenant_id

String

轉(zhuǎn)發(fā)策略所在的項目ID。

project_id

String

此參數(shù)和tenant_id參數(shù)含義一樣,均指轉(zhuǎn)發(fā)策略所在的項目ID。

name

String

轉(zhuǎn)發(fā)策略名稱。

admin_state_up

Boolean

轉(zhuǎn)發(fā)策略的管理狀態(tài);

該字段為預留字段,暫未啟用。取值范圍:true/false。

  • true表示開啟。
  • false表示關閉。

description

String

轉(zhuǎn)發(fā)策略的描述信息。

listener_id

String

轉(zhuǎn)發(fā)策略所在的監(jiān)聽器ID。

action

String

轉(zhuǎn)發(fā)策略的匹配動作。

取值范圍:

  • REDIRECT_TO_POOL:將匹配的流量轉(zhuǎn)發(fā)到redirect_pool_id指定的后端云服務器組上;
  • REDIRECT_TO_LISTENER:將listener_id指定的HTTP監(jiān)聽器的流量重定向到redirect_listener_id指定的TERMINATED_HTTPS監(jiān)聽器上。

redirect_pool_id

String

流量匹配后轉(zhuǎn)發(fā)到后端云服務器組的ID。

redirect_listener_id

String

流量匹配后轉(zhuǎn)發(fā)到的監(jiān)聽器的ID。

redirect_url

String

轉(zhuǎn)發(fā)策略重定向到的url。

該字段為預留字段,暫未啟用。

rules

Array of Rules objects

轉(zhuǎn)發(fā)策略關聯(lián)的轉(zhuǎn)發(fā)規(guī)則的ID列表。詳見表7。

position

Integer

轉(zhuǎn)發(fā)優(yōu)先級,從1遞增,最高100。默認值:100;

該字段為預留字段,暫未啟用。

provisioning_status

String

該字段為預留字段,暫未啟用。

轉(zhuǎn)發(fā)策略的配置狀態(tài),可以為ACTIVE。

表5 rules字段說明

參數(shù)

參數(shù)類型

描述

id

String

關聯(lián)的轉(zhuǎn)發(fā)規(guī)則id

請求示例

  • 請求樣例1 全量查詢轉(zhuǎn)發(fā)策略
    GET https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies
  • 請求樣例2 過濾查詢轉(zhuǎn)發(fā)類型為REDIRECT_TO_POOL的轉(zhuǎn)發(fā)策略
    GET https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies?action=REDIRECT_TO_POOL

響應示例

  • 響應樣例1
    {
        "l7policies": [
            {
                "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", 
                "redirect_listener_id": null,  
                "description": "", 
                "admin_state_up": true, 
                "rules": [
                    {
                        "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3"
                    }, 
                    {
                        "id": "f02b3bca-69d2-4335-a3fa-a8054e996213"
                    }
                ], 
                "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "project_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", 
                "redirect_url": null, 
                "action": "REDIRECT_TO_POOL", 
                "position": 2,
                "provisioning_status": "ACTIVE", 
                "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", 
                "name": ""
            }, 
            {
                "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", 
                "redirect_listener_id": null,  
                "description": "", 
                "admin_state_up": true, 
                "rules": [
                    {
                        "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5"
                    }
                ], 
                "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "project_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", 
                "redirect_url": null, 
                "action": "REDIRECT_TO_POOL", 
                "position": 1, 
                "provisioning_status": "ACTIVE",
                "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", 
                "name": ""
            }
        ]
    }
  • 響應樣例2
    {
        "l7policies": [
            {
                "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", 
                "redirect_listener_id": null,  
                "description": "", 
                "admin_state_up": true, 
                "rules": [
                    {
                        "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3"
                    }, 
                    {
                        "id": "f02b3bca-69d2-4335-a3fa-a8054e996213"
                    }
                ], 
                "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "project_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", 
                "redirect_url": null, 
                "action": "REDIRECT_TO_POOL", 
                "position": 2,
                "provisioning_status": "ACTIVE", 
                "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", 
                "name": ""
            }, 
            {
                "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", 
                "redirect_listener_id": null,  
                "description": "", 
                "admin_state_up": true, 
                "rules": [
                    {
                        "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5"
                    }
                ], 
                "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "project_id": "a31d2bdcf7604c0faaddb058e1e08819",
                "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", 
                "redirect_url": null, 
                "action": "REDIRECT_TO_POOL", 
                "position": 1, 
                "provisioning_status": "ACTIVE",
                "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", 
                "name": ""
            }
        ]
    }

返回碼

請參見狀態(tài)碼。