Updated on 2022-01-25 GMT+08:00

Creating a VPC Route

Function

This API is used to create a route.

URI

POST /v2.0/vpc/routes

Request Message

  • Request parameter
    Table 1 Request parameter

    Parameter

    Type

    Mandatory

    Description

    route

    Object

    Yes

    Specifies the route object list. For details, see Table 2.

    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, the value can only be peering.

    vpc_id

    String

    Yes

    Specifies the ID of the VPC ID requesting for creating a route.

  • Example request
    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 Message

  • Response parameter
    Table 3 Response parameter

    Parameter

    Type

    Description

    route

    Object

    Specifies the route object list. For details, see Table 4.

    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.

Error Code

See Error Codes.