Updating a Forwarding Policy¶

Function¶

This API is used to update a forwarding policy.

URI¶

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
l7policy_id	Yes	String	Specifies the forwarding policy ID.
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	UpdateL7PolicyOption object	Specifies the forwarding policy.

**Table 4** UpdateL7PolicyOption¶
Parameter	Mandatory	Type	Description
admin_state_up	No	Boolean	Specifies the administrative status of the forwarding policy. The default value is true. This parameter is unsupported. Please do not use it.
description	No	String	Provides supplementary information about the forwarding policy. Minimum: 0 Maximum: 255
name	No	String	Specifies the forwarding policy name. Minimum: 0 Maximum: 255
redirect_listener_id	No	String	Specifies the ID of the listener to which requests are redirected. Note: This parameter cannot be left blank or set to null when action is set to REDIRECT_TO_LISTENER. The listener's protocol must be 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_pool_id	No	String	Specifies the ID of the backend server group that requests will be forwarded to. This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL. The specified backend server group cannot be the default backend server group associated with the listener, or any backend server group associated with the forwarding policies of other listeners. This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.
redirect_url_config	No	UpdateRedirectUrlConfig object	Specifies the URL to which requests are forwarded. For dedicated load balancers, 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. Format: protocol://host:port/path?query 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 inherited. 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. For shared load balancers, this parameter is unsupported. If it is passed, an error will be returned.
fixed_response_config	No	UpdateFixtedResponseConfig object	Specifies the configuration of the page that will be returned. 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.
rules	No	Array of CreateRuleOption objects	Lists the forwarding rules in the forwarding policy. The 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. For details, see the description of l7rule.
priority	No	Integer	Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take 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. This parameter is unsupported for shared load balancers. If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating REDIRECT_TO_LISTENER has the highest priority. 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 URL 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. If enhance_l7policy_enable is set to true and this parameter is not passed, the priority will be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (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. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default. This parameter is invalid for shared load balancers. Minimum: 0 Maximum: 10000
redirect_pools_config	No	Array of CreateRedirectPoolsConfig objects	Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL. Note: If action is set to REDIRECT_TO_POOL, specify either redirect_pool_id or redirect_pools_config. If both are specified, only redirect_pools_config takes effect. This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER. All configuration will be overwritten.

**Table 5** UpdateRedirectUrlConfig¶
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. Minimum: 1 Maximum: 36
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. Default: ${host} Minimum: 1 Maximum: 128
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. Default: ${port} Minimum: 1 Maximum: 16
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 (/). Default: ${path}* Minimum: 1 Maximum: 128
query	No	String	Specifies the query string set in the URL for redirection. The default value is ${query}, indicating that the query string of the request will be used. The value is case-sensitive and can contain only letters, digits, and special characters!$&'()+,-./:;=?@^_` 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. Default: ${query} Minimum: 0 Maximum: 128
status_code	No	String	Specifies the status code returned after the requests are redirected. The value can be 301, 302, 303, 307, or 308. Minimum: 1 Maximum: 16

**Table 6** UpdateFixtedResponseConfig¶
Parameter	Mandatory	Type	Description
status_code	No	String	Specifies the 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. Minimum: 1 Maximum: 16
content_type	No	String	Specifies the format of the response body. The value can be text/plain, text/css, text/html, application/javascript, or application/json. Minimum: 1 Maximum: 64
message_body	No	String	Specifies the content of the response message body. Minimum: 0 Maximum: 1024

**Table 7** CreateRuleOption¶
Parameter	Mandatory	Type	Description
admin_state_up	No	Boolean	Specifies the administrative status of the forwarding rule. The default value is true. This parameter is unsupported. Please do not use it.
compare_type	Yes	String	Specifies how requests are matched with the forwarding rule. Values: EQUAL_TO: exact match. REGEX: regular expression match STARTS_WITH: prefix match Note: 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.
key	No	String	Specifies the key of match content. For example, if the request header is used for forwarding, key is the request header. This parameter is unsupported. Please do not use it. Minimum: 0 Maximum: 255
value	Yes	String	Specifies the value of the match content. For example, if a domain name is used for matching, value is the domain name. This parameter is valid only when conditions is left blank. If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), periods (.), and asterisks () and must start with a letter or digit. 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 and compare_type to STARTS_WITH or EQUAL_TO, the value 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. Minimum: 1 Maximum: 128
project_id	No	String	Specifies the project ID. Minimum: 32 Maximum: 32
type	Yes	String	Specifies the match content. 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. Note: If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.
invert	No	Boolean	Specifies whether reverse matching is supported. The value can be true or false (default). This parameter is unsupported. Please do not use it.
conditions	No	Array of CreateRuleCondition objects	Specifies the matching conditions of the forwarding rule. This parameter is available only when enhance_l7policy_enable is set to true. If conditions is specified, parameters key and value will not take effect, and the conditions value will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique.

**Table 8** CreateRuleCondition¶
Parameter	Mandatory	Type	Description
key	No	String	Specifies the key of match item. If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, this parameter is left blank. If type is set to HEADER, key indicates the name of the HTTP 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. 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. All keys in the conditions list in the same rule must be the same. Minimum: 1 Maximum: 128
value	Yes	String	Specifies the value of the match item. If type is set to HOST_NAME, key is left blank, and 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, and 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, and 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, and 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. All keys in the conditions list in the same rule must be the same. Minimum: 1 Maximum: 128

**Table 9** CreateRedirectPoolsConfig¶
Parameter	Mandatory	Type	Description
pool_id	Yes	String	Specifies the ID of the backend server group.
weight	Yes	Integer	Specifies the weight of the backend server group. The value ranges from 0 to 100.

Response Parameters¶

Status code: 200

**Table 10** 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 11** 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. 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. Note: If action is set to REDIRECT_TO_POOL, the listener's protocol must be HTTP, HTTPS, or TERMINATED_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 default value is true. This parameter is unsupported. Please do not use it.
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. Minimum: 1 Maximum: 255
position	Integer	Specifies the forwarding policy priority. This parameter cannot be updated. This parameter is unsupported. Please do not use it. Minimum: 1 Maximum: 100
priority	Integer	Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take 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. This parameter is unsupported for shared load balancers. If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating REDIRECT_TO_LISTENER has the highest priority. 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 URL 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. If enhance_l7policy_enable is set to true and this parameter is not passed, the priority will be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (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. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default. This parameter is invalid for 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 or ERROR. ACTIVE (default): The forwarding policy is provisioned successfully.
redirect_pool_id	String	Specifies the ID of the backend server group that requests will be forwarded to. This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL. If both redirect_pools_config and redirect_pool_id are specified, redirect_pools_config will take effect.
redirect_pools_config	Array of CreateRedirectPoolsConfig objects	Specifies the configuration of the backend server group that the requests are forwarded to. 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. This parameter is mandatory when action is set to REDIRECT_TO_LISTENER. Note: 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. For dedicated load balancers, 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. Format: protocol://host:port/path?query 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 inherited. 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. For shared load balancers, this parameter is unsupported. If it is passed, an error will be returned.
fixed_response_config	FixtedResponseConfig object	Specifies the configuration of the page that will be returned. 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 12** CreateRedirectPoolsConfig¶
Parameter	Type	Description
pool_id	String	Specifies the ID of the backend server group.
weight	Integer	Specifies the weight of the backend server group. The value ranges from 0 to 100.

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

**Table 14** 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. Minimum: 1 Maximum: 36
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. Default: ${host} Minimum: 1 Maximum: 128
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. Default: ${port} Minimum: 1 Maximum: 16
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 (/). Default: ${path}* Minimum: 1 Maximum: 128
query	String	Specifies the query string set in the URL for redirection. 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. The value is case-sensitive and can contain only letters, digits, and special characters!$&'()+,-./:;=?@^_` Default: ${query}* Minimum: 0 Maximum: 128
status_code	String	Specifies the status code returned after the requests are redirected. The value can be 301, 302, 303, 307, or 308. Minimum: 1 Maximum: 16

**Table 15** 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. Minimum: 1 Maximum: 16
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. Minimum: 0 Maximum: 32
message_body	String	Specifies the content of the response message body. Minimum: 0 Maximum: 1024

Example Requests¶

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

{
  "l7policy" : {
    "name" : "My policy.",
    "description" : "Update policy.",
    "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050"
  }
}

Example Responses¶

Status code: 200

Successful request.

{
  "request_id" : "e5c07525-1470-47b6-9b0c-567527a036aa",
  "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,
    "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"
  }
}

Status Codes¶

Status Code	Description
200	Successful request.

Error Codes¶

See Error Codes.

last updated: 2024-11-13 14:50 UTC - commit: dc0473f339644f421ca4d648c4746583f80203ae