Adding a Forwarding Policy

Function

This API is used to add a forwarding policy to a listener.

Constraints

Forwarding policies can be added to only to HTTP or HTTPS listeners.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/l7policies

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

Request Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
l7policy	Yes	CreateL7PolicyOption object	Specifies the forwarding policy.

**Table 4** CreateL7PolicyOption
Parameter	Mandatory	Type	Description
action	Yes	String	Specifies where requests will be forwarded. The value can be one of the following: 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. Notes and constraints: 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, TERMINATED_HTTPS, or HTTPS. If action is set to REDIRECT_TO_LISTENER, the listener's protocol must be HTTP.
admin_state_up	No	Boolean	Specifies the administrative status of the forwarding policy. The value can only be true.
description	No	String	Provides supplementary information about the forwarding policy.
listener_id	Yes	String	Specifies the ID of the listener to which the forwarding policy is added. Notes and constraints: If action is set to REDIRECT_TO_POOL, the forwarding policy can be added to an HTTP or HTTPS listener. If action is set to REDIRECT_TO_LISTENER, the forwarding policy can be added to an HTTP listener.
name	No	String	Specifies the forwarding policy name.
position	No	Integer	Specifies the forwarding policy priority. The value cannot be updated. This parameter is unsupported. Please do not use it.
priority	No	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 values: 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. Notes and constraints: 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. This parameter is supported by forwarding policies of shared load balancers.
project_id	No	String	Specifies the ID of the project where the forwarding policy is used.
redirect_listener_id	No	String	Specifies the ID of the listener to which requests are redirected. This parameter is mandatory when action is set to REDIRECT_TO_LISTENER. Notes and constraints: 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. This parameter is unsupported for shared load balancers.
redirect_pool_id	No	String	Specifies the ID of the backend server group to which the requests are forwarded. Notes and constraints: 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_url	No	String	Specifies the URL to which requests are forwarded. Format: protocol://host:port/path?query
redirect_url_config	No	CreateRedirectUrlConfig object	Specifies the URL to which requests are forwarded. Notes and constraints: 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. For shared load balancers, this parameter is unsupported. If it is passed, an error will be returned. 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
fixed_response_config	No	CreateFixtedResponseConfig object	Specifies the configuration of the page that will be returned. Notes and constraints: 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. For shared load balancers, this parameter is unsupported. If it is passed, an error will be returned.
redirect_pools_extend_config	No	CreateRedirectPoolsExtendConfig object	Specifies the backend server group that the requests are forwarded to. Notes and constraints: This parameter is valid only when action is set to REDIRECT_TO_POOL.
rules	No	Array of CreateL7PolicyRuleOption objects	Lists the forwarding rules in the forwarding policy. Notes and constraints: Each list can contain a maximum of 10 forwarding rules (if conditions is specified, a condition is considered as a rule). If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type. The entire list will be replaced if you update it. If the action of 17policy is set to Redirect to another listener, 17rule cannot be created.

**Table 5** CreateRedirectUrlConfig
Parameter	Mandatory	Type	Description
protocol	No	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	No	String	Specifies the host name 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	No	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	No	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	No	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	Yes	String	Specifies the status code returned after the requests are redirected. The value can be 301, 302, 303, 307, or 308.
insert_headers_config	No	CreateInsertHeadersConfig object	Specifies the headers you want to write into the request that matches the forwarding rule.
remove_headers_config	No	CreateRemoveHeadersConfig object	Specifies the headers you want to remove from the request that matches the forwarding rule.

**Table 6** CreateInsertHeadersConfig
Parameter	Mandatory	Type	Description
configs	Yes	Array of CreateInsertHeaderConfig objects	Specifies the headers you want to write into the request that matches the forwarding rule.

**Table 7** CreateInsertHeaderConfig
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the key of the header you want to write into the request that matches the forwarding rule. The value is a string of 1 to 40 case-insensitive characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The key cannot be the following: connection, upgrade, content-length, transfer-encoding, keep-alive, te, host, cookie, remoteip, authority, x-forwarded-host, x-forwarded-for, x-forwarded-for-port, x-forwarded-tls-certificate-id, x-forwarded-tls-protocol, x-forwarded-tls-cipher, x-forwarded-elb-ip, x-forwarded-port, x-forwarded-elb-id, x-forwarded-elb-vip, x-real-ip, x-forwarded-proto, x-nuwa-trace-ne-in, or x-nuwa-trace-ne-out.
value_type	Yes	String	Specifies the value type. The value can be USER_DEFINED, REFERENCE_HEADER, or SYSTEM_DEFINED.
value	Yes	String	Specifies the value of the header. If value_type is set to SYSTEM_DEFINED, the value can be CLIENT-PORT, CLIENT-IP, ELB-PROTOCOL, ELB-ID, ELB-PORT, ELB-EIP, or ELB-VIP. The value can contain 1 to 128 characters. ASCII codes 32 through 127 printable characters, asterisk (*), and question mark (?) are also supported. The value cannot start or end with a space.

**Table 8** CreateRemoveHeadersConfig
Parameter	Mandatory	Type	Description
configs	Yes	Array of CreateRemoveHeaderConfig objects	Specifies the headers you want to remove from the request that matches the forwarding rule.

**Table 9** CreateRemoveHeaderConfig
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the key of the header you want to remove from the request that matches the forwarding rule. The value is a string of 1 to 40 case-insensitive characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The key cannot be the following: connection, upgrade, content-length, transfer-encoding, keep-alive, te, host, cookie, remoteip, authority, x-forwarded-host, x-forwarded-for, x-forwarded-for-port, x-forwarded-tls-certificate-id, x-forwarded-tls-protocol, x-forwarded-tls-cipher, x-forwarded-elb-ip, x-forwarded-port, x-forwarded-elb-id, x-forwarded-elb-vip, x-real-ip, x-forwarded-proto, x-nuwa-trace-ne-in, or x-nuwa-trace-ne-out.

**Table 10** CreateFixtedResponseConfig
Parameter	Mandatory	Type	Description
status_code	Yes	String	Specifies the fixed HTTP status code configured in the forwarding rule. The value can be any integer in the range of 200–299, 400–499, or 500–599.
content_type	No	String	Specifies the format of the response body. The value can be: text/plain (default) text/css text/html application/javascript application/json
message_body	No	String	Specifies the content of the response message body.

**Table 11** CreateRedirectPoolsExtendConfig
Parameter	Mandatory	Type	Description
rewrite_url_enable	No	Boolean	Specifies whether to set rewrite_url_enable to true.
rewrite_url_config	No	CreateRewriteUrlConfig object	Specifies the URL for the backend server group that requests are forwarded to. This parameter is mandatory when rewrite_url_enable is set to true.

**Table 12** CreateRewriteUrlConfig
Parameter	Mandatory	Type	Description
host	No	String	Specifies the rewritten host that requests are redirected to. The string 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	No	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	No	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 13** CreateL7PolicyRuleOption
Parameter	Mandatory	Type	Description
admin_state_up	No	Boolean	Specifies the administrative status of the forwarding rule. The value can only be true.
type	Yes	String	Specifies the type of the forwarding rule. The value can be one of the following: HOST_NAME: A domain name will be used for matching. PATH: A URL will be used for matching. METHOD: An HTTP request method will be used for matching. HEADER: The request header will be used for matching. QUERY_STRING: A query string will be used for matching. SOURCE_IP: The source IP address will be used for matching. COOKIE: The cookie will be used for matching. Notes and constraints: If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type. If type is set to HEADER and QUERY_STRING, multiple forwarding rules can be created for each type.
compare_type	Yes	String	Specifies how requests are matched with the forwarding rule. The value can be: EQUAL_TO: exact match. REGEX: regular expression match STARTS_WITH: prefix match Notes and constraints: If type is set to HOST_NAME, the value can only be EQUAL_TO, and asterisks () can be used as wildcard characters. If type* is set to PATH, the value can be REGEX, STARTS_WITH, or EQUAL_TO. If type is set to METHOD or SOURCE_IP, the value can only be EQUAL_TO. If type is set to HEADER or QUERY_STRING, the value can only be EQUAL_TO, asterisks (*) and question marks (?) can be used as wildcard characters.
invert	No	Boolean	Specifies whether reverse matching is supported. The value can be true or false, and the default value is false. This parameter is unsupported. Please do not use it.
key	No	String	Specifies the key of the match item. For example, if an HTTP header is used for matching, key is the name of the HTTP header parameter. This parameter is unsupported. Please do not use it.
value	Yes	String	Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. Notes and constraints: This parameter will take effect only when conditions is left blank. If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter, digit, or . If you want to use a wildcard domain name, enter as the leftmost label of the domain name. If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.+?,=!:\|\/()[]{} If type* is set to METHOD, SOURCE_IP, HEADER, or QUERY_STRING, this parameter will not take effect, and conditions will be used to specify the key and value.
conditions	No	Array of CreateRuleCondition objects	Specifies the conditions contained in a forwarding rule. Notes and constraints: This parameter will take effect when enhance_l7policy_enable is set to true. If conditions is specified, key and value will not take effect. The keys in the list must be the same, whereas each value must be unique.

**Table 14** CreateRuleCondition
Parameter	Mandatory	Type	Description
key	No	String	Specifies the key of match item. Notes and constraints: All keys in the conditions list in the same rule must be the same. If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, this parameter is an empty string. If type is set to HEADER, key indicates the name of the HTTP header parameter, and value indicates the value of the request header parameter. The value can contain 1 to 40 characters, including letters, digits, hyphens (-), and underscores (_). If type is set to QUERY_STRING, key indicates the name of the query parameter, and value indicates the value of the query parameter. The key is case sensitive and can contain 1 to 128 characters. Spaces, square brackets ([ ]), curly brackets ({ }), angle brackets (< >), backslashes (), double quotation marks (" "), pound signs (#), ampersands (&), vertical bars (\|), percent signs (%), and tildes (~) are not supported.
value	Yes	String	Specifies the value of the match item. Notes and constraints: The key of each condition in a forwarding policy must be the same. The value of each condition in a forwarding policy must be unique. Value ranges: If type is set to HOST_NAME, key is left blank, value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk () as the leftmost label of the domain name. If type* is set to PATH, key is left blank, value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.+?,=!:\|/()[]{} If type* is set to HEADER, key indicates the name of the HTTP header parameter and value indicates the value of the HTTP header parameter. The value can contain 1 to 128 characters. Asterisks () and question marks (?) are allowed, but spaces and double quotation marks are not allowed. An asterisk can match zero or more characters, and a question mark can match 1 character. If type* is set to QUERY_STRING, key indicates the name of the query parameter and value indicates the value of the query parameter. The value is case sensitive and can contain 1 to 128 characters. Spaces, square brackets ([ ]), curly brackets ({ }), angle brackets (< >), backslashes (), double quotation marks (" "), pound signs (#), ampersands (&), vertical bars (\|), percent signs (%), and tildes (~) are not supported. Asterisks () and question marks (?) are allowed. An asterisk can match zero or more characters, and a question mark can match 1 character. If type* is set to METHOD, key is left blank, value indicates the HTTP method. The value can be GET, PUT, POST, DELETE, PATCH, HEAD, or OPTIONS. If type is set to SOURCE_IP, key is left blank, value indicates the source IP address of the request. The value is an IPv4 or IPv6 CIDR block, for example, 192.168.0.2/32 or 2049::49/64.

Response Parameters

Status code: 201

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

**Table 16** L7Policy
Parameter	Type	Description
action	String	Specifies where requests will be forwarded. The value can be one of the following: 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. Notes and constraints: 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, TERMINATED_HTTPS, 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. 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 values: 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. Notes and constraints: 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. This parameter is supported by forwarding policies of shared load balancers.
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 (default): The forwarding policy is provisioned successfully. ERROR: Another forwarding policy of the same listener has the same forwarding rule.
redirect_pool_id	String	Specifies the ID of the backend server group to which the requests are forwarded. Notes and constraints: This parameter is valid only when action is set to REDIRECT_TO_POOL.
redirect_listener_id	String	Specifies the ID of the listener to which requests are redirected. Notes and constraints: 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. Notes and constraints: 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. For shared load balancers, this parameter is unsupported. If it is passed, an error will be returned. 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 the requests are forwarded to. Notes and constraints: This parameter is valid only when action is set to REDIRECT_TO_POOL.
fixed_response_config	FixtedResponseConfig object	Specifies the configuration of the page that will be returned. Notes and constraints: 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. For shared load balancers, this parameter is unsupported. If it is passed, an error will be returned.
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). This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.
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). This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

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

**Table 18** 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 host name 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 (/). 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 19** 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 20** RewriteUrlConfig
Parameter	Type	Description
host	String	Specifies the rewritten host that requests are redirected to. The string 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 21** 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

Creating a redirection for a listener.

POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies

{
  "l7policy" : {
    "action" : "REDIRECT_TO_LISTENER",
    "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
    "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050"
  }
}

Example Responses

Status code: 201

Normal response to POST requests.

{
  "request_id" : "b60d1d9a-5263-45b0-b1d6-2810ac7c52a1",
  "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" : null,
    "redirect_listener_id" : null,
    "action" : "REDIRECT_TO_POOL",
    "position" : 100,
    "priority" : null,
    "provisioning_status" : "ACTIVE",
    "id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307",
    "name" : "l7policy-67"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Creating a redirection for a listener.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;


public class CreateL7PolicySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateL7PolicyRequest request = new CreateL7PolicyRequest();
        CreateL7PolicyRequestBody body = new CreateL7PolicyRequestBody();
        CreateL7PolicyOption l7policybody = new CreateL7PolicyOption();
        l7policybody.withAction("REDIRECT_TO_LISTENER")
            .withListenerId("e2220d2a-3faf-44f3-8cd6-0c42952bd0ab")
            .withRedirectListenerId("48a97732-449e-4aab-b561-828d29e45050");
        body.withL7policy(l7policybody);
        request.withBody(body);
        try {
            CreateL7PolicyResponse response = client.createL7Policy(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

Creating a redirection for a listener.

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateL7PolicyRequest()
        l7policybody = CreateL7PolicyOption(
            action="REDIRECT_TO_LISTENER",
            listener_id="e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
            redirect_listener_id="48a97732-449e-4aab-b561-828d29e45050"
        )
        request.body = CreateL7PolicyRequestBody(
            l7policy=l7policybody
        )
        response = client.create_l7_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

Creating a redirection for a listener.

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateL7PolicyRequest{}
	redirectListenerIdL7policy:= "48a97732-449e-4aab-b561-828d29e45050"
	l7policybody := &model.CreateL7PolicyOption{
		Action: "REDIRECT_TO_LISTENER",
		ListenerId: "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
		RedirectListenerId: &redirectListenerIdL7policy,
	}
	request.Body = &model.CreateL7PolicyRequestBody{
		L7policy: l7policybody,
	}
	response, err := client.CreateL7Policy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     