Querying VPC Routes¶
Function¶
This API is used to query all routes of the tenant submitting the request. The routes are filtered based on the filtering condition. For details about the response format of pagination query, see section Pagination.
URI¶
GET /v2.0/vpc/routes
Example:
Example:
GET https://{Endpoint}/v2.0/vpc/routes?id={id}&vpc_id={vpc_id}&tenant_id={tenant_id}&destination={destination}&type={type}&limit={limit}&marker={marker}
Table 1 describes the parameters.
Name | Mandatory | Type | Description |
---|---|---|---|
id | No | String | Specifies that the route ID is used as the filtering condition. |
tenant_id | No | String | Specifies that the tenant ID is used as the filtering condition. |
vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. |
destination | No | String | Specifies that the route destination address (CIDR) is used as the filtering condition. |
type | No | String | Specifies that the type is used as the filtering condition. Currently, the value can only be peering. |
marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit.
|
limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker. The default value is 2000. |
Request Parameters¶
None
Example Request¶
GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff
Response Parameters¶
Parameter | Type | Description |
---|---|---|
routes | Array of route objects | Specifies the route object list. For details, see Table 3. |
routes_links | Array of routes_link objects | Specifies the route object list. For details, see Table 4. The value of rel will be next and that of href will be a link only when limit is used for filtering and the number of resources exceeds the value of limit or 2000 (default value of limit). |
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. |
Name | Type | Description |
---|---|---|
href | String | Specifies the API link. |
rel | String | Specifies the relationship between the API link and the API version. |
Example Response¶
{
"routes": [
{
"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.