Consulta de las VPC
Función
Esta API se utiliza para consultar las VPC mediante criterios de búsqueda y para mostrar las VPC en una lista.
URI
GET /v1/{project_id}/vpcs
GET https://{Endpoint}/v1/{project_id}/vpcs?limit=10&marker=13551d6b-755d-4757-b956-536f674975c0
Nombre |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID de proyecto. |
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. |
enterprise_project_id |
No |
String |
|
Mensaje de solicitud
Mensaje de la respuesta
- Parámetro de respuesta
Tabla 2 Parámetro de respuesta Nombre
Tipo
Descripción
vpcs
Array of vpcs objects
Especifica las VPC.
Tabla 3 Descripción del campo vpcs Nombre
Tipo
Descripción
id
String
Especifica un ID de recurso en formato UUID.
name
String
- Especifica el nombre de la VPC.
- El valor no puede contener más de 64 caracteres, incluidos letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
- Cada nombre de VPC de un tenant debe ser único si el nombre de VPC no se deja en blanco.
description
String
- Proporciona la información adicional sobre la VPC.
- El valor no puede contener más de 255 caracteres y no puede contener los corchetes angulares (< o >).
cidr
String
- Especifica los intervalos de direcciones IP disponibles para las subredes de la VPC.
- Los valores posibles son los siguientes:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- Si no se especifica cidr, el valor predeterminado se deja en blanco.
- El valor debe estar en formato CIDR, por ejemplo, 192.168.0.0/16.
status
String
- Especifica el estado de la VPC.
- Los valores posibles son los siguientes:
- CREATING: Se está creando la VPC.
- OK: La VPC se ha creado correctamente.
enterprise_project_id
String
- Especifica el ID del proyecto de empresa.
- El valor es 0 o una string que contiene un máximo de 36 caracteres en formato UUID con guiones (-). El valor 0 indica el proyecto de empresa predeterminado.
NOTA:
Para obtener más información acerca de los proyectos de empresa y cómo obtener los ID de proyecto de empresa, consulte la Guía del usuario de Enterprise Management.
routes
Array of route objects
- Especifica la información de ruta.
- Para obtener más información, véase Tabla 4.
tenant_id
String
Especifica el ID del proyecto de empresa.
created_at
String
- Especifica la hora (UTC) en la que se crea la VPC.
- Formato: aaaa-MM-ddTHH:mm:ss
updated_at
String
- Especifica la hora (UTC) en la que se crea la VPC.
- Formato: aaaa-MM-ddTHH:mm:ss
Tabla 4 Objetos de route Nombre
Tipo
Descripción
destination
String
- Especifica el segmento de red de destino de una ruta.
- El valor debe estar en el formato de CIDR. Actualmente, solo se admite el valor 0.0.0.0/0.
nexthop
String
- Especifica el salto siguiente de una ruta.
- El valor debe ser una dirección IP y debe pertenecer a la subred de la VPC. De lo contrario, este valor no tiene efecto.
- Ejemplo de la respuesta
{ "vpcs": [ { "id": "13551d6b-755d-4757-b956-536f674975c0", "name": "default", "description": "test", "cidr": "172.16.0.0/16", "status": "OK" , "routes": [], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:11:13", "updated_at": "2022-12-15T02:11:13" }, { "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "name": "222", "description": "test", "cidr": "192.168.0.0/16", "status": "OK" , "routes": [], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T04:01:21", "updated_at": "2022-12-15T04:01:21" }, { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name": "vpc", "description": "test", "cidr": "192.168.0.0/16", "status": "OK", "enterprise_project_id": "0", "routes": [], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T05:36:29", "updated_at": "2022-12-15T05:36:29" } ] }
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.