Consulta de las VPC
Función
Esta API se utiliza para consultar las VPC.
Restricciones
Esta API se utiliza para consultar todas las VPC accesibles para el tenant que envía la solicitud. Se puede devolver un máximo de 2000 registros para cada consulta. Si el número de registros es superior a 2000, se devolverá el marcador de paginación.
URI
GET /v3/{project_id}/vpc/vpcs
Nombre |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
limit |
No |
Integer |
Número de registros mostrados en cada página. Rango de valores: 0 a 2000 |
marker |
No |
String |
Iniciar ID de recurso de consulta de paginación. Si el parámetro se deja en blanco, solo se consultan los recursos de la primera página. |
id |
No |
Array of strings |
ID de la VPC, que se puede utilizar para filtrar las VPC. |
name |
No |
Array of strings |
Nombre de la VPC, que se puede utilizar para filtrar las VPC. |
description |
No |
Array of strings |
Información complementaria sobre la VPC, que se puede utilizar para filtrar las VPC. |
cidr |
No |
Array of strings |
Bloque de CIDR de VPC, que se puede utilizar para filtrar las VPC. |
Parámetro de solicitud
No hay
Ejemplo de la solicitud
- Consulta de las VPC
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs"
- Consulta de las VPC por ID de VPC
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?id=01ab4be1-4447-45fb-94be-3ee787ed4ebe&id=02cd5ef2-4447-36fb-75be-3ee787ed6adf" - Consulta de las VPC por nombre de VPC
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?name=vpc-test" - Consulta de las VPC por página
"GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe"
Parámetro de respuesta
Parámetro |
Tipo |
Descripción |
|---|---|---|
request_id |
String |
ID de solicitud |
vpcs |
Array of Vpc objects |
Cuerpo de la respuesta de las VPC |
page_info |
PageInfo object |
Información de la paginación |
Parámetro |
Tipo |
Descripción |
|---|---|---|
id |
String |
El ID de VPC, que identifica de forma única la VPC El valor está en formato UUID con guiones (-). |
name |
String |
Nombre de la VPC El valor no puede contener más de 64 caracteres, incluidos letras, dígitos, guiones bajos (_), guiones (-) y puntos (.). |
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 |
Bloques CIDR de VPC disponibles Rango de valores:
Si cidr no se especifica, el valor predeterminado es "".
|
extend_cidrs |
Array of strings |
Bloques de CIDR secundarios de las VPC Rango de valores: Actualmente, solo se admiten bloques CIDR IPv4. |
status |
String |
Estado de la VPC
Rango de valores:
|
project_id |
String |
ID del proyecto al que pertenece la VPC |
enterprise_project_id |
String |
ID del proyecto de empresa al que pertenece la VPC 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. |
created_at |
String |
Hora en que se crea la VPC Tiempo de UTC en el formato de aaaa-MM-ddTHH:mmss |
updated_at |
String |
Hora en que se actualiza la VPC Tiempo de UTC en el formato de aaaa-MM-ddTHH:mm:ss |
cloud_resources |
Array of CloudResource objects |
Tipo y número de recursos asociados con la VPC Actualmente, solo se devuelven tabla de rutas y subredes de la VPC. El número de virsubnets es el número total de subredes IPv4 e IPv6. |
tags |
Array of Tag objects |
Etiquetas de VPC. Para obtener más información, consulte los objetos de etiqueta. Rango de valores: 0 a 10 pares clave-valor de etiqueta |
Parámetro |
Tipo |
Descripción |
|---|---|---|
resource_type |
String |
Tipo de recurso |
resource_count |
Integer |
Número de recursos |
Parámetro |
Tipo |
Descripción |
|---|---|---|
key |
String |
Clave de la etiqueta
Rango de valores:
|
value |
String |
Valor de la etiqueta Rango de valores:
|
Ejemplo de la respuesta
{
"request_id": "9c1838ba498249547be43dd618b58d27",
"vpcs": [
{
"id": "01da5a65-0bb9-4638-8ab7-74c64e24a9a7",
"name": "API-PERF-TEST-14bd44c121",
"description": "",
"cidr": "192.168.0.0/16",
"extend_cidrs": [ ],
"status": "ACTIVE",
"project_id": "087679f0aa80d32a2f4ec0172f5e902b",
"enterprise_project_id": "0",
"tags": [ ],
"created_at": "2020-06-16T02:32:18Z",
"updated_at": "2020-06-16T02:32:18Z",
"cloud_resources": [
{
"resource_type": "routetable",
"resource_count": 1
},
{
"resource_type": "virsubnet",
"resource_count": 0
}
]
},
{
"id": "43fd79b0-f7d7-4e9b-828b-2d4d7bfae428",
"name": "API-PERF-TEST_m2n33",
"description": "",
"cidr": "192.168.0.0/16",
"extend_cidrs": [ ],
"status": "ACTIVE",
"project_id": "087679f0aa80d32a2f4ec0172f5e902b",
"enterprise_project_id": "0",
"tags": [ ],
"created_at": "2020-06-15T06:29:40Z",
"updated_at": "2020-06-15T06:29:41Z",
"cloud_resources": [
{
"resource_type": "routetable",
"resource_count": 1
},
{
"resource_type": "virsubnet",
"resource_count": 1
}
]
},
{
"id": "5ed053ba-b46c-4dce-a1ae-e9d8a7015f21",
"name": "API-PERF-TEST-c34b1c4b12",
"description": "",
"cidr": "192.168.0.0/16",
"extend_cidrs": [ ],
"status": "ACTIVE",
"project_id": "087679f0aa80d32a2f4ec0172f5e902b",
"enterprise_project_id": "0",
"tags": [ ],
"created_at": "2020-06-16T02:32:33Z",
"updated_at": "2020-06-16T02:32:33Z",
"cloud_resources": [
{
"resource_type": "routetable",
"resource_count": 1
},
{
"resource_type": "virsubnet",
"resource_count": 0
}
]
}
],
"page_info": {
"previous_marker": "01da5a65-0bb9-4638-8ab7-74c64e24a9a7",
"current_count": 3
}
}
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.
