Consulta de rutas de VPC
Función
Esta API se utiliza para consultar todas las rutas del tenant que envía la solicitud. Las rutas se filtran en función de la condición de filtrado. Para obtener más información sobre el formato de respuesta de la consulta de paginación, consulte la sección Paginación.
URI
GET /v2.0/vpc/routes
Ejemplo:
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}
Nombre |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
No |
String |
Especifica que el ID de ruta se utiliza como condición de filtrado. |
tenant_id |
No |
String |
Especifica que el ID del tenant se utiliza como condición de filtrado. |
vpc_id |
No |
String |
Especifica que el ID de VPC se utiliza como condición de filtrado. |
destination |
No |
String |
Especifica que la dirección de destino de la ruta (CIDR) se utiliza como condición de filtrado. |
type |
No |
String |
Especifica que el tipo se utiliza como condición de filtrado. Actualmente, el valor solo puede ser peering. |
marker |
No |
String |
Especifica un ID de recurso para la consulta de paginación, que indica que la consulta comienza en el siguiente registro del ID de recurso especificado. Este parámetro puede funcionar junto con el parámetro limit.
|
limit |
No |
Integer |
Especifica el número de registros que se devolverán en cada página. El valor es de 0 a intmax (2^31-1). limit se puede utilizar junto con marker. Para obtener más información, consulte la descripción de parámetros de marker. El valor predeterminado es 2000. |
Mensaje de solicitud
- Ejemplo de solicitud
GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff
Mensaje de respuesta
- Parámetro de respuesta
Tabla 2 Parámetro de respuesta Parámetro
Tipo
Descripción
routes
Array of route objects
Especifica la lista de objetos de ruta. Para más detalles, consulte Tabla 3.
routes_links
Array of routes_link objects
Especifica la lista de objetos de ruta. Para más detalles, consulte Tabla 4.
El valor de rel será next y el de href será un enlace solo cuando limit se use para el filtrado y el número de recursos exceda el valor de limit o 2000 (valor predeterminado de limit).
Tabla 3 Objetos de route Atributo
Tipo
Descripción
id
String
Especifica el ID de ruta.
destination
String
Especifica la dirección de destino en el formato de notación CIDR, por ejemplo, 192.168.200.0/24.
nexthop
String
Especifica el salto siguiente. Si el tipo de ruta es peering, ingrese el ID de la interconexión de VPC.
type
String
Especifica el tipo de ruta. Actualmente, el valor solo puede ser peering.
vpc_id
String
Especifica la VPC de la ruta. Establezca este parámetro en el ID de VPC existente.
tenant_id
String
Especifica el ID del proyecto.
- Ejemplo de respuesta
{ "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" } ] }
Código de estado
Consulte Códigos de estado.
Código de error
Consulte Códigos de error.