All Products
Search
Document Center

Cloud Firewall:ModifyTrFirewallV2RoutePolicyScope

Last Updated:Dec 16, 2025

Modifies the scope of a routing policy for a VPC firewall that is created for a Transit Router (TR).

Operation description

You can modify the policy scope for point-to-multipoint and multipoint-to-multipoint scenarios, but not for point-to-point scenarios.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

The language of the response. Valid values:

  • zh (default): Chinese

  • en: English

zh

TrFirewallRoutePolicyId

string

Yes

The ID of the routing policy.

policy-4d724d0139df48f1****

FirewallId

string

Yes

The ID of the TR firewall instance.

vfw-tr-6520de0253bc4669****

SrcCandidateList

array<object>

No

The source instances.

object

No

A source instance.

CandidateId

string

No

The ID of the instance.

vpc-2ze9epancaw8t4sha****

CandidateType

string

No

The type of the instance.

VPC

DestCandidateList

array<object>

No

The destination instances.

object

No

The sub-instance to which traffic is redirected.

CandidateId

string

No

The ID of the instance.

vpc-2ze9epancaw8t4uzi****

CandidateType

string

No

The type of the instance.

VPC

ShouldRecover

string

No

Specifies whether to restore the traffic redirection configuration. Valid values:

  • true: Rolls back the routes.

  • false: Revokes the routes.

false

Response elements

Element

Type

Description

Example

object

TrFirewallRoutePolicyId

string

The ID of the routing policy.

policy-4d724d0139df48f1****

RequestId

string

The ID of the request.

E7D4D635-0C70-5CEB-A609-851E94D51FBB

Examples

Success response

JSON format

{
  "TrFirewallRoutePolicyId": "policy-4d724d0139df48f1****",
  "RequestId": "E7D4D635-0C70-5CEB-A609-851E94D51FBB"
}

Error codes

HTTP status code

Error code

Error message

Description

200 ErrorDBUpdateError A database update error occurred. A database update error occurred.
400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
400 ErrorParameters Error Parameters The parameter is invalid.
400 ErrorAuthentication authentication error The authentication failed.
400 ErrorDBNoRow No rows in database. No data found.
400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
400 ErrorPolicySrcAndDestConflict Policy has same destination candidate as source candidtes. The main drainage instance conflicts with the sub-drainage instance in the drainage template.
400 ErrorDBTxError A database transaction error occurred. The error message returned because an internal error has occurred in the database transaction.
400 ErrorTrFirewallEndToEndTrToAll Parameter error, point-to-multipoint scenario, TR instance does not support configuration ALL. Parameter error. In point-to-multipoint scenarios, the TR instance does not support ALL configuration.
400 ErrorCannotEditRoutePolicyWhenClose Can not edit route policy when policy closed. Cannot update a drainage template when a firewall drainage template is created, deleted, or closed.
400 ErrorFirewallUpdating Can not modify firewall, firewall is updating. Please check if there is a routing policy updating. The firewall cannot be operated. The firewall is in an updated state. Please check whether any drainage templates are being created, deleted, updated, opened or closed.
400 ErrorIllegalRoutePolicyScopeUpdate Can not update policy scope. The peer-to-peer scenario cannot be configured to update the drainage template range.
400 ErrorCannotEditToAllPolicy Can not modify policy scope for policy contains All type candidate. You cannot edit a drainage template that contains an ALL type.
400 ErrorCandidateNoRouteTable Please attach candidate with transit router before create routing template. Before creating a drainage template, bind the drainage instance to a routing table of a forwarding router.
400 ErrorTrFirewallRouteMapConflict Cen TR firewall route table has route map conflict. The CEN routing table and the cloud firewall have routing policy conflicts.
400 ErrorUserCredentials User credentials failed. Unauthorized, not accessible, please first authorize firewall permissions.
400 ErrorTrFirewallDoNotSupportPrefixList Cen TR firewall do not support prefix list. Cloud Firewall of CEN Enterprise Edition does not support prefix lists.
400 ErrorCandidateHasStaticRoute Tr firewall don't support candidate which associated with transit router route table contains custom route. Please retry after deleted the route. There are custom routes in the routing table of the forwarding router bound to the drainage instance. Cloud Firewall does not support this type of drainage instance. Delete the corresponding route and try again.
400 ErrorTrRouteTableContainsRejectRoutes There are routes conflict in transit router route table.Please resolve route conflict before create route policy. There is a routing conflict in the routing table of the forwarding router. Resolve the routing conflict before creating a firewall drainage scenario.
400 ErrorTrFwVswCidrConflict Illegal tr firewall cidr configuration. Tr firewall configuration network segment is invalid.
400 ErrorFirewallCandidateReference Firewall Candidate referrence count greater than one. Drainage instances exist in multiple drainage scenarios.
400 ErrorDBInsertError A database insert error occurred. An error occurred while performing an insert operation in the database.
400 ErrorRecordLog record operation log error. Update operation log error.
400 ErrorTrFirewallOnlyContainsEcrAndTrCandidate TR firewall cannot only contain both ECR and TR. TR firewall cannot only contain both ECR and TR.
400 ErrorTrFirewallPolicyNotFound TR firewall policy does not exist.
400 ErrorTrFirewallEcmpRoute Cen TR ecmp next hop must add to route policy at the same time. The next hop of the CEN medium-price route must be added to the cloud firewall drainage scenario at the same time.
400 ErrorTrFirewallCenManegedRouteMapConflict Cen TR firewall route table has cen managed route map conflict. if a routing policy of the old version of cen enterprise edition with a priority of 5000 exists, contact after-sales service to update the routing policy.
400 ErrorCandidateHasIPv6Route Cloud Enterprise Network TR enterprise firewall don't support ipv6 route. Cloud Enterprise Network TR Enterprise Firewall does not support Ipv6 routing

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.