Viewing Details of a Forwarding Policy
Function
This API is used to view details of a forwarding policy.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/l7policies/{l7policy_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
l7policy_id |
Yes |
String |
Specifies the forwarding policy ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the token used for IAM authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. The value is automatically generated. |
l7policy |
L7Policy object |
Specifies the forwarding policy. |
Parameter |
Type |
Description |
---|---|---|
action |
String |
Specifies where requests will be forwarded. The value can be one of the following:
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:
|
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 each forwarding policy of the same listener. This parameter is available only for dedicated load balancers and 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.
a) If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to create because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, please specify a value or adjust the priorities of existing forwarding policies. b) If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default. For shared load balancers, this parameter is unsupported. |
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.
|
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. |
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:
|
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. |
redirect_pools_config |
Array of RedirectPoolsConfig objects |
Specifies the backend server groups that requests are forwarded to. A maximum of 5 backend server groups can be configured for a forwarding policy. |
redirect_pools_sticky_session_config |
Specifies whether to enable sticky session for backend server groups configured for a forwarding policy. The load balancer generates a cookie after it receives a request from a client. All subsequent requests with the same cookie are routed to the same backend server groups. This parameter is unsupported for shared load balancers. If it is passed, an error will be returned. |
|
redirect_pools_extend_config |
RedirectPoolsExtendConfig object |
Specifies the backend server group that the requests are forwarded to.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. 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. |
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 |
insert_headers_config |
InsertHeadersConfig object |
Specifies the headers you want to write into the request that matches the condition. |
remove_headers_config |
RemoveHeadersConfig object |
Specifies the headers you want to remove from the request that matches the condition. |
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. Requests are routed to backend server groups based on their weights. Backend server groups with higher weights receive proportionately more requests. No requests will be routed to a backend server group with a weight of 0. Minimum: 0 Maximum: 100 |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Specifies whether to enable sticky session for backend server groups configured in a forwarding policy. The default value is false, indicating that sticky session is disabled. Default: false |
timeout |
Integer |
Specifies the duration that a session persists. The value ranges from 1 to 1440 (default), in minutes. |
Parameter |
Type |
Description |
---|---|---|
rewrite_url_enable |
Boolean |
Specifies whether to set rewrite_url_enable to true. |
rewrite_url_config |
RewriteUrlConfig object |
Specifies the URL for the backend server group that requests are forwarded to. This parameter is mandatory when action is set to REDIRECT_TO_POOL. |
insert_headers_config |
InsertHeadersConfig object |
Specifies the headers you want to write into the request that matches the condition. |
remove_headers_config |
RemoveHeadersConfig object |
Specifies the headers you want to remove from the request that matches the condition. |
traffic_limit_config |
TrafficLimitConfig object |
Specifies how requests are limited. |
Parameter |
Type |
Description |
---|---|---|
host |
String |
Specifies the domain name 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 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 #. 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. 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 #. The default value is ${query}, indicating that the query string of the request will be used. |
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 |
insert_headers_config |
InsertHeadersConfig object |
Specifies the headers you want to write into the request that matches the condition. |
remove_headers_config |
RemoveHeadersConfig object |
Specifies the headers you want to remove from the request that matches the condition. |
traffic_limit_config |
TrafficLimitConfig object |
Specifies how requests are limited. |
Parameter |
Type |
Description |
---|---|---|
configs |
Array of InsertHeaderConfig objects |
Specifies the headers you want to write into the request that matches the condition. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the key of the header you want to write into the request that matches the condition. 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 |
String |
Specifies the value type. The value can be USER_DEFINED, REFERENCE_HEADER, or SYSTEM_DEFINED. |
value |
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. The value can contain 1 to 128 characters. ASCII codes 32 through 127 printable characters, asterisks (*), and question marks (?) are also supported. The value cannot start or end with a space. |
Parameter |
Type |
Description |
---|---|---|
configs |
Array of RemoveHeaderConfig objects |
Specifies the headers you want to remove from the request that matches the condition. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the header you want to remove from the request that matches the condition. 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. |
Parameter |
Type |
Description |
---|---|---|
qps |
Integer |
Specifies the maximum number of queries per second (QPS). The value ranges from 0 to 1,00,000. 0 indicates that QPS is not limited. Minimum: 0 Maximum: 100000 |
per_source_ip_qps |
Integer |
Specifies the maximum number of queries per second (QPS) from a source IP address. This parameter is not available for QUIC listeners. The value can be 0 or null. The value ranges from 0 to 1,00,000. 0 indicates that QPS is not limited. If qps is not set to 0, per_source_ip_qps must be specified a smaller value than qps. Minimum: 0 Maximum: 100000 |
burst |
Integer |
Specifies the maximum number of queries per second (QPS) from a source IP address. The value ranges from 0 to 1,00,000. If the number of requests exceeds the value specified for qps but not reaches the value specified for burst, 503 status code will not be returned. Minimum: 0 Maximum: 100000 |
Example Requests
Querying 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot