Help Center/ Enterprise Router/ API Reference/ APIs/ Routes/ Updating a Static Route
Updated on 2024-04-25 GMT+08:00

Updating a Static Route

Function

This API is used to update a static route.

Constraints

If is_blackhole is set to false, the attachment_id parameter must be carried. If is_blackhole is set to true, the attachment_id parameter cannot be passed.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

route_table_id

Yes

String

Route table ID

route_id

Yes

String

Route ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

route

Yes

UpdateRoute object

Route

Table 3 UpdateRoute

Parameter

Mandatory

Type

Description

attachment_id

No

String

Next hop of the route

is_blackhole

No

Boolean

Whether the route is a blackhole route

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

route

Route object

Route

request_id

String

Request ID

Table 5 Route

Parameter

Type

Description

id

String

Route ID

type

String

Route type. The value is static.

state

String

Route status. Value options: pending, available, modifying, deleting, deleted, and failed

is_blackhole

Boolean

Whether the route is a blackhole route

destination

String

Destination address of the route

attachments

Array of RouteAttachment objects

Next hops

route_table_id

String

Route table ID

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 RouteAttachment

Parameter

Type

Description

resource_id

String

Attached resource ID

resource_type

String

Attachment type.

  • vpc: VPC attachment

  • vpn: VPN gateway attachment

  • vgw: virtual gateway attachment

attachment_id

String

Attachment ID

Example Requests

Modifying a static route

PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/19d334b7-78c1-4e0e-ba29-b797e641e23c/static-routes/9b3b38a9-1c9d-4f01-9429-81af6b545289

{
  "route" : {
    "is_blackhole" : false,
    "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
  }
}

Example Responses

Status code: 202

Accepted

{
  "route" : {
    "id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
    "type" : "static",
    "destination" : "192.168.0.0/16",
    "attachments" : [ {
      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
      "resource_type" : "vpc",
      "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
    } ],
    "route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
    "is_blackhole" : false,
    "state" : "pending",
    "created_at" : "2020-03-11T15:13:31",
    "updated_at" : "2020-03-11T15:13:31"
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

Status Codes

Status Code

Description

202

Accepted

Error Codes

See Error Codes.