Querying Details of a Forwarding Policy

Updated on 2022-01-25 GMT+08:00

View PDF

Function

This API is used to query details about a forwarding policy.

URI

GET /v2/{project_id}/elb/l7policies/{l7policy_id}

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
l7policy_id	Yes	String	Specifies the forwarding policy ID.

Request

None

Response

**Table 2** Parameter description
Parameter	Type	Description
l7policy	Object	Specifies the forwarding policy. For details, see Table 3.

**Table 3** **l7policy** parameter description
Parameter	Type	Description
id	String	Specifies the forwarding policy ID.
tenant_id	String	Specifies the ID of the project where the forwarding policy is used.
name	String	Specifies the forwarding policy name.
admin_state_up	Boolean	Specifies the administrative status of the forwarding policy. The value can be true or false. This parameter is reserved. The default value is true.
description	String	Provides supplementary information about the forwarding policy.
listener_id	String	Specifies the ID of the listener to which the forwarding policy is added.
action	String	Specifies whether requests are forwarded to another backend server group or redirected to another HTTPS listener. The value range varies depending on the protocol of the backend server group: REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id. REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
redirect_pool_id	String	Specifies the ID of the backend server group to which traffic is forwarded.
redirect_listener_id	String	Specifies the ID of the listener to which the traffic is redirected.
redirect_url	String	Specifies the URL to which traffic is redirected. This parameter is reserved.
rules	Array	Lists the forwarding rules of the forwarding policy.
position	Integer	Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100. This parameter is reserved.
provisioning_status	String	Specifies the provisioning status of the forwarding policy. The value can be ACTIVE, PENDING_CREATE, or ERROR. The default value is ACTIVE. This parameter is reserved.

**Table 4** **rules** parameter description
Parameter	Type	Description
id	String	Specifies the ID of the associated forwarding rule.

Example Request

Example request: Querying details of a forwarding policy

GET https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586

Example Response

Example response 1

{
    "l7policy": {
        "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", 
        "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", 
        "redirect_url": null, 
        "provisioning_status": "ACTIVE",
        "action": "REDIRECT_TO_POOL", 
        "position": 1, 
        "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", 
        "name": "l7policy-garry-1"
    }
}

Status Code

For details, see HTTP Status Codes of Load Balancers.

Parent topic: Forwarding Policy

Previous topic: Querying Forwarding Policies

Next topic: Updating a Forwarding Policy

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot