sgode/virtual-private-cloud
1
0
Fork 0
forked from docs/virtual-private-cloud
Code Pull Requests Activity
virtual-private-cloud/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst
proposalbot a539bdd666 Changes to vpc_api-ref from docs/doc-exports#556 (VPC API 20230106 version 
VPC

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2024-02-06 09:16:27 +00:00

7.0 KiB
Raw Blame History

original_name

vpc_route_0003.html

Creating a VPC Route

Function

This API is used to create a route.

URI

POST /v2.0/vpc/routes

Request Parameters

Table 1 Request parameter
Parameter Type Mandatory Description
route route <vpc_route_0003> object Yes Specifies the route. For details, see Table 2 <vpc_route_0003__table05001250111>.
Table 2 route objects
Attribute Type Mandatory Description
destination String Yes Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24.
nexthop String Yes Specifies the next hop. If the route type is peering, enter the VPC peering connection ID.
type String Yes

Specifies the route type.

Currently, only the peering type is supported, that is, the next hop is a VPC peering connection.
vpc_id String Yes Specifies the ID of the VPC ID requesting for creating a route.

Example Request

  • Create a route in the route table of the VPC whose ID is ab78be2d-782f-42a5-aa72-35879f6890ff for the VPC peering connection. The next hop is the peering connection whose ID is 60c809cb-6731-45d0-ace8-3bf5626421a9, and the destination is 192.168.200.0/24.

    POST https://{Endpoint}/v2.0/vpc/routes

{
    "route": {
        "type": "peering",
        "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9",
        "destination": "192.168.200.0/24",
        "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"
    }
}

Response Parameters

Table 3 Response parameter
Parameter Type Description
route route <vpc_route_0003> object Specifies the route. For details, see Table 4 <vpc_route_0003__table1163544010410>.
Table 4 route objects
Attribute Type Description
id String Specifies the route ID.
destination String Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24.
nexthop String Specifies the next hop. If the route type is peering, enter the VPC peering connection ID.
type String Specifies the route type. Currently, the value can only be peering.
vpc_id String Specifies the VPC of the route. Set this parameter to the existing VPC ID.
tenant_id String Specifies the project ID.

Example Response

{
    "route": {
        "type": "peering",
        "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9",
        "destination": "192.168.200.0/24",
        "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff",
        "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
        "id": "3d42a0d4-a980-4613-ae76-a2cddecff054"
    }
}

Status Code

See Status Codes <vpc_api_0002>.

Error Code

See Error Codes <vpc_api_0003>.