Updated on 2025-12-15 GMT+08:00

Modifying a Route Policy

Function

This API is used to modify a route policy.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

er:routeTables:updatePropagationRoutePolicy

Write

routeTables *

  • g:EnterpriseProjectId

  • g:ResourceTag/<tag-key>

  • er:propagations:update

-

attachments *

  • g:EnterpriseProjectId

  • g:ResourceTag/<tag-key>

URI

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations/{propagation_id}/change-route-policy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

er_id

Yes

String

Enterprise router ID

route_table_id

Yes

String

Route table ID

propagation_id

Yes

String

Propagation ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

route_policy

Yes

ImportRoutePolicy object

Route that controls inbound traffic

Table 3 ImportRoutePolicy

Parameter

Mandatory

Type

Description

import_policy_id

No

String

ID of the route policy that controls inbound IPv4 traffic

Minimum: 0

Maximum: 36

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

propagation

Propagation object

Propagation details

request_id

String

Request ID.

Table 5 Propagation

Parameter

Type

Description

id

String

Unique association ID

project_id

String

Project ID

er_id

String

Enterprise router ID

route_table_id

String

Unique ID of the route table

attachment_id

String

Unique ID of the attachment

resource_type

String

  • Definition: Resource type.

  • Range:

    • vpc: VPC

    • vpn: VPN gateway

    • vgw: Direct Connect virtual gateway

    • peering: peering connection. A cloud connection is used to connect two enterprise routers from different regions.

    • ecn: ECN

    • cfw: CFW instance

resource_id

String

Unique ID of the attachment

route_policy

ImportRoutePolicy object

Route that controls inbound traffic

state

String

  • Definition: Status.

  • Range:

    • pending

    • available

    • modifying

    • deleting

    • deleted

    • failed

created_at

String

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

updated_at

String

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

Table 6 ImportRoutePolicy

Parameter

Type

Description

import_policy_id

String

ID of the route policy that controls inbound IPv4 traffic

Minimum: 0

Maximum: 36

Example Requests

The route policy is successfully modified.

POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f9/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/propagations/915a14a6-867b-4af7-83d1-70efceb146f9/change-route-policy

{
  "route_policy" : {
    "import_policy_id" : "c097c4af-a122-4cee-af50-e4052b7bf8d5"
  }
}

Example Responses

Status code: 202

Accepted

{
  "propagation" : {
    "id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
    "route_table_id" : "91c013e2-d65a-474e-9177-c3e1799ca726",
    "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64",
    "resource_type" : "vpn",
    "resource_id" : "4e5fe97c-82bc-432e-87d8-06d7e157dffa",
    "route_policy" : {
      "import_route_policy" : "c097c4af-a122-4cee-af50-e4052b7bf8d5"
    },
    "state" : "pending",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z"
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

Status Codes

Status Code

Description

202

Accepted

Error Codes

See Error Codes.