Creating a Route Table

Updated on 2025-03-31 GMT+08:00

Function

This API is used to create a route table. A route table is the basis for an enterprise router to send and receive packets. It contains attachment associations, propagations, and routes.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

er_id

Yes

String

Enterprise router ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Client-Token

No

String

Idempotence identifier

Minimum: 1

Maximum: 64

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

route_table

No

CreateRouteTable object

Route table

Table 4 CreateRouteTable

Parameter

Mandatory

Type

Description

name

Yes

String

Route table name. The value can contain 1 to 64 characters. Only digits, letters, underscores (_), hyphens (-), and periods (.) are allowed.

Minimum: 1

Maximum: 64

description

No

String

Description of the route table

Minimum: 0

Maximum: 255

tags

No

Array of Tag objects

Tag information

Table 5 Tag

Parameter

Mandatory

Type

Description

key

No

String

Tag key.

  • A tag key can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag key cannot be left blank.

  • A tag key can contain 1 to 128 characters.

  • Tags with the tag key starting with _sys_ are system tags and cannot be added by tenants.

Minimum: 1

Maximum: 128

value

No

String

Tag value.

  • A tag value can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag value can be left blank or set to null.

  • A tag value can contain 0 to 255 characters.

Minimum: 0

Maximum: 255

Response Parameters

Status code: 202

Table 6 Response header parameters

Parameter

Type

Description

X-Client-Token

String

Idempotence identifier

Table 7 Response body parameters

Parameter

Type

Description

route_table

RouteTable object

Route table

request_id

String

Request ID

Table 8 RouteTable

Parameter

Type

Description

id

String

Route table ID

name

String

Route table name

description

String

Description

is_default_association

Boolean

Whether the route table is the default association route table.

Default: false

is_default_propagation

Boolean

Whether the route table is the default propagation route table.

state

String

Route table status. Value options: pending, available, deleting, deleted, or failed

tags

Array of Tag objects

Tag

created_at

String

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

updated_at

String

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

Table 9 Tag

Parameter

Type

Description

key

String

Tag key.

  • A tag key can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag key cannot be left blank.

  • A tag key can contain 1 to 128 characters.

  • Tags with the tag key starting with _sys_ are system tags and cannot be added by tenants.

Minimum: 1

Maximum: 128

value

String

Tag value.

  • A tag value can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag value can be left blank or set to null.

  • A tag value can contain 0 to 255 characters.

Minimum: 0

Maximum: 255

Example Requests

Creating a route table named my-route-table

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

{
  "route_table" : {
    "name" : "my-route-table",
    "tags" : [ {
      "key" : "key",
      "value" : "value"
    } ]
  }
}

Example Responses

Status code: 202

Accepted

{
  "route_table" : {
    "id" : "4ab54142-7c92-48ad-8288-77727a231052",
    "name" : "my-route-table",
    "is_default_association" : false,
    "is_default_propagation" : false,
    "state" : "pending",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z",
    "tags" : [ {
      "key" : "key",
      "value" : "value"
    } ]
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

Status Codes

Status Code

Description

202

Accepted

Error Codes

See Error Codes.

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback