Viewing the Details of a Forwarding Policy

Function

This API is used to view the details of a forwarding policy.

Calling Method

For details, see Calling APIs.

URI

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

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

Request Parameters

Table 2 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the token used for IAM authentication.

Response Parameters

Status code: 200

Table 3 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID. The value is automatically generated.
l7policy	L7Policy object	Specifies the forwarding policy.

Table 4 L7Policy
Parameter	Type	Description
action	String	Specifies where requests will be forwarded. Value options: REDIRECT_TO_POOL: Requests will be forwarded to another backend server group. REDIRECT_TO_LISTENER: Requests will be redirected to an HTTPS listener. REDIRECT_TO_URL: Requests will be redirected to another URL. FIXED_RESPONSE: A fixed response body will be returned. Note: REDIRECT_TO_LISTENER has the highest priority. If requests are to be redirected to an HTTPS listener, other forwarding policies of the listener will become invalid. If action is set to REDIRECT_TO_POOL, the listener's protocol must be HTTP or HTTPS. If action is set to REDIRECT_TO_LISTENER, the listener's protocol must be HTTP.
admin_state_up	Boolean	Specifies the administrative status of the forwarding policy. Note: The value can only be true.
description	String	Provides supplementary information about the forwarding policy.
id	String	Specifies the forwarding policy ID.
listener_id	String	Specifies the ID of the listener to which the forwarding policy is added.
name	String	Specifies the forwarding policy name.
position	Integer	Specifies the forwarding policy priority. This parameter cannot be updated. This parameter is unsupported. Please do not use it.
priority	Integer	Specifies the forwarding policy priority. A smaller value indicates a higher priority. Value ranges: If action is set to REDIRECT_TO_LISTENER, the priority ranges from 0 to 10,000. If action is set to other values, the priority ranges from 1 to 10,000. Default value options: If this parameter is not passed and enhance_l7policy_enable is set to false, the priority of the new forwarding policy is 1. If action is set to REDIRECT_TO_LISTENER, the priority of the new forwarding policy is 0. If action is set to other values, the priority of the new forwarding policy will be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If no forwarding policies exist, the priority of the new forwarding policy will be 1 by default. If the highest priority of existing forwarding policies is the maximum value (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum value. In this case, specify a value or adjust the priorities of existing forwarding policies. Note: The value must be unique for forwarding policies of the same listener. This parameter takes effect only when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the path is, the higher the priority is. If a forwarding policy contains only a domain name without a path specified, the path is /, and prefix match is used by default.
project_id	String	Specifies the project ID of the forwarding policy.
provisioning_status	String	Specifies the provisioning status of the forwarding policy. The value can be ACTIVE or ERROR. ACTIVE (default): The forwarding policy is provisioned successfully.
redirect_pool_id	String	Specifies the ID of the backend server group to which the requests are forwarded. Note: This parameter is valid only when action is set to REDIRECT_TO_POOL. If this parameter is specified when action is set to REDIRECT_TO_LISTENER, an error will be reported.
redirect_listener_id	String	Specifies the ID of the listener to which requests are redirected. Note: This parameter is mandatory when action is set to REDIRECT_TO_LISTENER. The listener's protocol must be HTTPS or TERMINATED_HTTPS. A listener added to another load balancer is not allowed. This parameter cannot be passed in the API for adding or updating a forwarding policy if action is set to REDIRECT_TO_POOL.
redirect_url	String	Specifies the URL to which requests are forwarded. Format: protocol://host:port/path?query This parameter is unsupported. Please do not use it.
rules	Array of RuleRef objects	Lists the forwarding rules in the forwarding policy.
redirect_url_config	RedirectUrlConfig object	Specifies the URL to which requests are forwarded. Note: This parameter will take effect only when advanced forwarding is enabled (enhance_l7policy_enable is set to true). If it is passed when enhance_l7policy_enable is set to false, an error will be returned. This parameter is mandatory when action is set to REDIRECT_TO_URL. It cannot be specified if the value of action is not REDIRECT_TO_URL. At least one of the four parameters (protocol, host, port, and path) must be passed, or their values cannot be set to ${xxx} at the same time. ${xxx} indicates that the value in the request will be used. For example, ${host} indicates the host in the URL to be redirected. The values of protocol and port cannot be the same as those of the associated listener, and either host or path must be passed or their values cannot be ${xxx} at the same time. Value format: protocol://host:port/path?query
redirect_pools_extend_config	RedirectPoolsExtendConfig object	Specifies the backend server group that requests are forwarded to. Note: This parameter takes effect only when action is set to REDIRECT_TO_POOL.
fixed_response_config	FixtedResponseConfig object	Specifies the configuration of the page that will be returned. Note: This parameter will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. This parameter is mandatory when action is set to FIXED_RESPONSE. It cannot be specified if the value of action is not FIXED_RESPONSE.
created_at	String	Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).
updated_at	String	Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

Table 5 RuleRef
Parameter	Type	Description
id	String	Specifies the forwarding rule ID.

Table 6 RedirectUrlConfig
Parameter	Type	Description
protocol	String	Specifies the protocol for redirection. The value can be HTTP, HTTPS, or ${protocol}. The default value is ${protocol}, indicating that the protocol of the request will be used.
host	String	Specifies the name of the host that requests are redirected to. The value can contain only letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.
port	String	Specifies the port that requests are redirected to. The default value is ${port}, indicating that the port of the request will be used.
path	String	Specifies the path that requests are redirected to. The value can contain only letters, digits, and special characters: _~';@^-%#&$.+?,=!:\|\/()[]{} and must start with a slash (/). $1, $2, $3, and all the way to $9 match the wildcard asterisk () in the request URL. The default value is ${path}, indicating that the path of the request will be used.
query	String	Specifies the query string set in the URL for redirection. The value is case-sensitive and can contain only letters, digits, and special characters: !$&'()+,-./:;=?@^_`. $1, $2, $3, and all the way to $9 match the wildcard asterisk () in the request URL. The default value is ${query}, indicating that the query string of the request will be used. For example, in the URL https://www.example.com:8080/elb?type=loadbalancer, ${query} indicates type=loadbalancer. If this parameter is set to ${query}&name=my_name, the URL will be redirected to https://www.example.com:8080/elb?type=loadbalancer&name=my_name.
status_code	String	Specifies the status code returned after the requests are redirected. The value can be 301, 302, 303, 307, or 308.

Table 7 RedirectPoolsExtendConfig
Parameter	Type	Description
rewrite_url_enable	Boolean	Specifies whether to enable URL redirection.
rewrite_url_config	RewriteUrlConfig object	Specifies the URL for the backend server group that requests are forwarded to. This parameter is valid when rewrite_url_enable is set to true.

Table 8 RewriteUrlConfig
Parameter	Type	Description
host	String	Specifies the domain name of the host that requests are redirected to. The domain name can contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.
path	String	Specifies the path that requests are redirected to. The default value is ${path}, indicating that the path of the request will be used. The value can contain only letters, digits, and special characters: _~';@^-%#&$.+?,=!:\|/() and must start with a slash (/). $1, $2, $3, and all the way to $9 match the wildcard asterisk (*) in the request URL. If the number of regular expression match groups is less than the specified number, ${path} is empty. If the dollar sign ($) is followed by a letter, the matching result is empty until the next special character appears, for example, $abc#123, and the matching result is #123. If the dollar sign ($) is followed by a special character, for example, $#, the matching result is $#.
query	String	Specifies the query string set in the URL for redirection. The value is case-sensitive and can contain only letters, digits, and special characters: !$&'()+,-./:;=?@^_`. $1, $2, $3, and all the way to $9 match the wildcard asterisk () in the request URL. The default value is ${query}, indicating that the query string of the request will be used. If the number of regular expression match groups is less than the specified number, ${path} is empty. If the dollar sign ($) is followed by a letter, the matching result is empty until the next special character appears, for example, $abc#123, and the matching result is #123. If the dollar sign ($) is followed by a special character, for example, $#, the matching result is $#.

Table 9 FixtedResponseConfig
Parameter	Type	Description
status_code	String	Specifies the HTTP status code configured in the forwarding policy. The value can be any integer in the range of 200–299, 400–499, or 500–599.
content_type	String	Specifies the format of the response body. The value can be text/plain, text/css, text/html, application/javascript, or application/json.
message_body	String	Specifies the content of the response message body.

Example Requests

Querying the details of a forwarding policy

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be

Example Responses

Status code: 200

Successful request.

{
  "l7policy" : {
    "redirect_pool_id" : "768e9e8c-e7cb-4fef-b24b-af9399dbb240",
    "description" : "",
    "admin_state_up" : true,
    "rules" : [ {
      "id" : "c5c2d625-676b-431e-a4c7-c59cc2664881"
    } ],
    "project_id" : "7a9941d34fc1497d8d0797429ecfd354",
    "listener_id" : "cdb03a19-16b7-4e6b-bfec-047aeec74f56",
    "redirect_url" : null,
    "redirect_url_config" : null,
    "redirect_pools_config" : {
      "pool_id" : "722e9e8c-e7cb-4fef-b24b-af9399dbb240",
      "weight" : 12
    },
    "redirect_pools_sticky_session_config" : {
      "timeout" : 23,
      "enable" : false
    },
    "fixed_response_config" : {
      "content_type" : "text/plain",
      "message_body" : "",
      "status_code" : "207"
    },
    "redirect_listener_id" : null,
    "action" : "REDIRECT_TO_POOL",
    "position" : 100,
    "priority" : 1,
    "provisioning_status" : "ACTIVE",
    "id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307",
    "name" : "l7policy-67"
  },
  "request_id" : "6be83ec4-623e-4840-a417-2fcdf8ad5dfa"
}

Status Codes

Status Code	Description
200	Successful request.

Error Codes

See Error Codes.

Parent topic: Forwarding Policy

Предыдущая статья

Querying Forwarding Policies

Следующая статья

Updating a Forwarding Policy

Была ли эта статья полезна?

Поддержка Юридические документы