文档首页/ 云专线 DC/ API参考/ API/ 全域接入网关路由表/ 修改全域接入网关路由表
更新时间:2024-12-27 GMT+08:00

修改全域接入网关路由表

功能介绍

支持的修改操作:新增、删除、修改

调用方法

请参见如何调用API

URI

PUT /v3/{project_id}/dcaas/gdgw/{gdgw_id}/routetables

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

gdgw_id

String

全域接入网关ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

dry_run

Boolean

是否dry run模式执行

gdgw_routetable

GdgwRouteTableRequest object

修改路由入参对象

表4 GdgwRouteTableRequest

参数

是否必选

参数类型

描述

add_routes

Array of objects

需要添加的路由

数组长度:0 - 100

del_routes

Array of objects

需要删除的路由

数组长度:0 - 100

update_routes

Array of objects

需要更新的路由

仅更新该条路由的附加信息,不执行交换机的路由更新操作。当前支持更新:路由描述-description信息

数组长度:0 - 100

表5 add_routes

参数

是否必选

参数类型

描述

type

String

下一跳类型:

  • vif_peer: 虚拟接口对等体

  • gdgw: 全域接入网关

destination

String

路由子网

nexthop

String

下一跳id

description

String

路由描述

表6 del_routes

参数

是否必选

参数类型

描述

type

String

下一跳类型:

  • vif_peer: 虚拟接口对等体

  • gdgw: 全域接入网关

destination

String

路由子网

nexthop

String

下一跳id

表7 update_routes

参数

是否必选

参数类型

描述

destination

String

路由子网

nexthop

String

下一跳id

description

String

路由描述

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求id

最小长度:0

最大长度:36

gdgw_routetable

Array of CommonRoutetable objects

全域接入网关路由表

数组长度:0 - 2000

表9 CommonRoutetable

参数

参数类型

描述

id

String

路由id

最小长度:36

最大长度:36

tenant_id

String

租户id

最小长度:64

最大长度:64

gateway_id

String

网关id

最小长度:36

最大长度:36

destination

String

路由子网

最小长度:64

最大长度:64

nexthop

String

下一跳id

最小长度:36

最大长度:36

obtain_mode

String

路由类型:

  • customized: 默认路由

  • specific: 自定义路由

  • bgp: 动态路由

status

String

路由状态:

  • ACTIVE: 下发正常

  • ERROR: 下发失败

  • PENDING_CREATE: 待下发

address_family

String

地址族类型:

  • ipv4: ipv4

  • ipv6: ipv6

description

String

路由描述

最小长度:0

最大长度:1024

type

String

下一跳类型:

  • vif_peer: 虚拟接口对等体

  • gdgw: 全域接入网关

最小长度:0

最大长度:255

请求示例

更新专线网关路由表请求体

PUT https://{dc_endpoint}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/gdgw/0851a5e0-6623-42c2-bb02-b8956e313dd8/routetables

{
  "gdgw_routetable" : {
    "add_routes" : [ {
      "destination" : "1.1.1.0/24",
      "nexthop" : "b9060822-06bf-4c48-995d-29a3fb04a3c3",
      "type" : "vif_peer",
      "description" : ""
    } ]
  }
}

响应示例

状态码: 200

OK

  • 更新专线网关路由表响应体

    {
      "request_id" : "d365091f89df06c8737bd81a72efc8b2",
      "gdgw_routetable" : [ {
        "id" : "94912503-0a97-48ee-909b-6676129a565e",
        "description" : "",
        "tenant_id" : "4bd6efdb0fb747b39aa2c0162c112226",
        "gateway_id" : "0851a5e0-6623-42c2-bb02-b8956e313dd8",
        "destination" : "1.1.1.0/24",
        "nexthop" : "b9060822-06bf-4c48-995d-29a3fb04a3c3",
        "type" : "vif_peer",
        "obtain_mode" : "specific",
        "status" : "PENDING_CREATE",
        "address_family" : "ipv4"
      } ]
    }

SDK代码示例

SDK代码示例如下。

更新专线网关路由表请求体

 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
56
57
58
59
60
61
62
63
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.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateGdgwRouteTableSolution {

    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);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateGdgwRouteTableRequest request = new UpdateGdgwRouteTableRequest();
        request.withGdgwId("{gdgw_id}");
        UpdateGdgwRoutetableRequestBody body = new UpdateGdgwRoutetableRequestBody();
        List<AddGdgwRouteAction> listGdgwRoutetableAddRoutes = new ArrayList<>();
        listGdgwRoutetableAddRoutes.add(
            new AddRoutes()
                .withDestination("1.1.1.0/24")
                .withDescription("")
                .withType(AddRoutes.TypeEnum.fromValue("vif_peer"))
                .withNexthop("b9060822-06bf-4c48-995d-29a3fb04a3c3")
        );
        GdgwRouteTableRequest gdgwRoutetablebody = new GdgwRouteTableRequest();
        gdgwRoutetablebody.withAddRoutes(listGdgwRoutetableAddRoutes);
        body.withGdgwRoutetable(gdgwRoutetablebody);
        request.withBody(body);
        try {
            UpdateGdgwRouteTableResponse response = client.updateGdgwRouteTable(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());
        }
    }
}

更新专线网关路由表请求体

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.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 = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateGdgwRouteTableRequest()
        request.gdgw_id = "{gdgw_id}"
        listAddRoutesGdgwRoutetable = [
            AddRoutes(
                destination="1.1.1.0/24",
                description="",
                type="vif_peer",
                nexthop="b9060822-06bf-4c48-995d-29a3fb04a3c3"
            )
        ]
        gdgwRoutetablebody = GdgwRouteTableRequest(
            add_routes=listAddRoutesGdgwRoutetable
        )
        request.body = UpdateGdgwRoutetableRequestBody(
            gdgw_routetable=gdgwRoutetablebody
        )
        response = client.update_gdgw_route_table(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新专线网关路由表请求体

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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 := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateGdgwRouteTableRequest{}
	request.GdgwId = "{gdgw_id}"
	descriptionAddRoutes:= ""
	typeAddRoutes:= model.GetAddRoutesTypeEnum().VIF_PEER
	var listAddRoutesGdgwRoutetable = []model.AddRoutes{
        {
            Destination: "1.1.1.0/24",
            Description: &descriptionAddRoutes,
            Type: &typeAddRoutes,
            Nexthop: "b9060822-06bf-4c48-995d-29a3fb04a3c3",
        },
    }
	gdgwRoutetablebody := &model.GdgwRouteTableRequest{
		AddRoutes: &listAddRoutesGdgwRoutetable,
	}
	request.Body = &model.UpdateGdgwRoutetableRequestBody{
		GdgwRoutetable: gdgwRoutetablebody,
	}
	response, err := client.UpdateGdgwRouteTable(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码