Help Center/ Enterprise Router/ API Reference/ APIs/ Route Tables/ Updating Route Table Information

Updated on 2024-04-25 GMT+08:00

View PDF

Updating Route Table Information

Function

This API is used to update basic information about a route table, such as the name and description.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}

**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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
route_table	No	UpdateRouteTable object	Request body for updating a route table

**Table 3** UpdateRouteTable
Parameter	Mandatory	Type	Description
name	No	String	Route table name Minimum: 1 Maximum: 64
description	No	String	Description of the route table Minimum: 0 Maximum: 255

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
route_table	RouteTable object	Route table
request_id	String	Request ID

**Table 5** 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. The value can be 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

**Table 6** Tag
Parameter	Type	Description
key	String	Tag key. The value can contain a maximum of 36 Unicode characters, including uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). Minimum: 1 Maximum: 128
value	String	Tag value. Tag values consist of letters, digits, spaces, and special characters _.:=+-@ Tag values can contain 0 to 255 characters. Tag values can be left blank or set to null. Minimum: 0 Maximum: 255

Example Requests

Changing the name of a route table of an enterprise router to new-rtb

PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f5/route-tables/4ab54142-7c92-48ad-8288-77727a231052

{
  "route_table" : {
    "name" : "new-rtb"
  }
}

Example Responses

Status code: 200

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