Help Center/ Elastic Load Balance/ API Reference (Ankara Region)/ APIs (V3)/ Forwarding Policy/ Batch Modifying Forwarding Policy Priorities
Updated on 2025-02-24 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Batch Modifying Forwarding Policy Priorities

Function

This API is used to batch modify the priorities of forwarding policies.

Constraints

This API is only used to update the priorities of forwarding policies added to a listener of a dedicated load balancer when action is set to REDIRECT_TO_POOL.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/l7policies/batch-update-priority

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

l7policies

No

Array of BatchUpdatePriorityRequestBody objects

Specifies the forwarding policy.
Table 4 BatchUpdatePriorityRequestBody

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the ID of the forwarding policy.

priority

Yes

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.

This parameter is supported by forwarding policies of shared load balancers.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Example Requests

Batch modifying the priorities of forwarding policies

POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/l7policies/batch-update-priority

{
  "l7policies" : [ {
    "id" : "1fe93e12-6e07-47a9-8f81-3346c015601d",
    "priority" : 11
  } ]
}

Example Responses

Status code: 202

Created

{
  "request_id" : "e5c07525-1470-47b6-9b0c-567527a036aa"
}

Status Codes

Status Code

Description

202

Created

Error Codes

See Error Codes.

Parent topic: Forwarding Policy