Updated on 2025-12-19 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_policy_id" : "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"
}

SDK Sample Code

The SDK sample code is as follows.

Java

The route policy is successfully modified.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.er.v3.region.ErRegion;
import com.huaweicloud.sdk.er.v3.*;
import com.huaweicloud.sdk.er.v3.model.*;


public class UpdatePropagationRoutePolicySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ErClient client = ErClient.newBuilder()
                .withCredential(auth)
                .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdatePropagationRoutePolicyRequest request = new UpdatePropagationRoutePolicyRequest();
        request.withErId("{er_id}");
        request.withRouteTableId("{route_table_id}");
        request.withPropagationId("{propagation_id}");
        UpdatePropagationRequestBody body = new UpdatePropagationRequestBody();
        ImportRoutePolicy routePolicybody = new ImportRoutePolicy();
        routePolicybody.withImportPolicyId("c097c4af-a122-4cee-af50-e4052b7bf8d5");
        body.withRoutePolicy(routePolicybody);
        request.withBody(body);
        try {
            UpdatePropagationRoutePolicyResponse response = client.updatePropagationRoutePolicy(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

The route policy is successfully modified.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdker.v3.region.er_region import ErRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdker.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ErClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ErRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdatePropagationRoutePolicyRequest()
        request.er_id = "{er_id}"
        request.route_table_id = "{route_table_id}"
        request.propagation_id = "{propagation_id}"
        routePolicybody = ImportRoutePolicy(
            import_policy_id="c097c4af-a122-4cee-af50-e4052b7bf8d5"
        )
        request.body = UpdatePropagationRequestBody(
            route_policy=routePolicybody
        )
        response = client.update_propagation_route_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

The route policy is successfully modified.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := er.NewErClient(
        er.ErClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdatePropagationRoutePolicyRequest{}
	request.ErId = "{er_id}"
	request.RouteTableId = "{route_table_id}"
	request.PropagationId = "{propagation_id}"
	importPolicyIdRoutePolicy:= "c097c4af-a122-4cee-af50-e4052b7bf8d5"
	routePolicybody := &model.ImportRoutePolicy{
		ImportPolicyId: &importPolicyIdRoutePolicy,
	}
	request.Body = &model.UpdatePropagationRequestBody{
		RoutePolicy: routePolicybody,
	}
	response, err := client.UpdatePropagationRoutePolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

202

Accepted

Error Codes

See Error Codes.