Consulta de la lista de instancias de red
Función
Esta API se utiliza para consultar la lista de instancias de red. Los parámetros marker y limit se utilizan para la consulta de paginación. Los dos parámetros solo tienen efecto cuando se usan juntos.
URI
GET /v3/{domain_id}/ccaas/network-instances
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
domain_id |
Sí |
String |
ID de cuenta. Mínimo: 10 Máximo: 32 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
limit |
No |
Integer |
Número de los registros devueltos en cada página durante una consulta de paginación. Mínimo: 1 Máximo: 2000 Predeterminado: 2000 |
marker |
No |
String |
ID del último registro de la página anterior. Si este parámetro se deja en blanco, se consultan los recursos de la primera página. Este parámetro debe usarse junto con limit. Mínimo: 0 Máximo: 36 |
id |
No |
Array |
ID utilizado para consultar las instancias de red. |
name |
No |
Array |
Nombre utilizado para consultar las instancias de red. |
description |
No |
Array |
Descripción utilizada para consultar las instancias de red. |
status |
No |
Array |
Estado de la instancia de red. ACTIVE: Las instancias de red están disponibles. Predeterminado: ACTIVE |
type |
No |
Array |
Tipo utilizado para consultar las instancias de red. |
cloud_connection_id |
No |
Array |
ID de conexión en la nube que se utiliza para consultar las instancias de red. |
instance_id |
No |
Array |
ID de la instancia de red utilizado para la consulta. |
region_id |
No |
Array |
Región donde se implementan las instancias de red. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Mínimo: 0 Máximo: 102400 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
network_instances |
Array of NetworkInstance objects |
Lista de las instancias de red. |
page_info |
PageInfo object |
Información de consulta de paginación. |
request_id |
String |
ID de solicitud. Mínimo: 0 Máximo: 36 |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de instancia de red. Mínimo: 0 Máximo: 36 |
name |
String |
Nombre de instancia de red. Mínimo: 0 Máximo: 64 |
description |
String |
Descripción de la instancia de red. Mínimo: 0 Máximo: 85 |
domain_id |
String |
ID de cuenta. Mínimo: 10 Máximo: 32 |
status |
String |
Estado de la instancia de red.
Mínimo: 0 Máximo: 36 |
created_at |
String |
Tiempo en el que se creó la instancia de red. Es una hora UTC en el formato aaaa-MM-ddTHH:mm:ss. |
updated_at |
String |
Tiempo en el que se actualizó la instancia de red. Es una hora UTC en el formato aaaa-MM-ddTHH:mm:ss. |
type |
String |
Tipo de instancia de red.
Mínimo: 0 Máximo: 36 |
cloud_connection_id |
String |
ID de conexión en la nube. Mínimo: 0 Máximo: 36 |
instance_id |
String |
ID de instancia de red. Mínimo: 0 Máximo: 36 |
instance_domain_id |
String |
ID de cuenta al que pertenece la instancia de red. Mínimo: 0 Máximo: 36 |
region_id |
String |
ID de región al que pertenece la instancia de red. Mínimo: 0 Máximo: 36 |
project_id |
String |
ID de proyecto del tenant al que pertenece la instancia de red. Mínimo: 0 Máximo: 36 |
cidrs |
Array of strings |
Lista de rutas anunciadas por la instancia de red. Mínimo: 0 Máximo: 64 |
Parámetro |
Tipo |
Descripción |
---|---|---|
next_marker |
String |
Marcador de la página siguiente. El valor es el UUID del recurso. Si el marcador se deja en blanco, se consultan los recursos de la última página. Mínimo: 0 Máximo: 36 |
previous_marker |
String |
Marcador de la página anterior. El valor es el UUID del recurso. Si el marcador se deja en blanco, se consultan los recursos de la primera página. Mínimo: 0 Máximo: 36 |
current_count |
Integer |
Número de los recursos en la lista. Mínimo: 0 Máximo: 2000 |
Ejemplo de las solicitudes
Consulta de las instancias de red
GET https://{cc_endpoint}/v3/{domain_id}/ccaas/network-instances
Ejemplo de las respuestas
Código de estado: 200
Se ha consultado la lista de instancias de red.
{ "request_id" : "b961d5fcda6b993b5b750f1b96e484e0", "network_instances" : [ { "id" : "XXX", "name" : "", "description" : "", "domain_id" : "XXX", "created_at" : "2022-06-24T09:33:15Z", "updated_at" : "2022-06-24T09:33:16Z", "project_id" : "XXX", "instance_domain_id" : "", "cloud_connection_id" : "XXX", "region_id" : "br-iaas-odin1", "type" : "vpc", "instance_id" : "XXX", "cidrs" : [ "192.168.1.0/24" ], "status" : "ACTIVE" } ], "page_info" : { "previous_marker" : "XXX", "current_count" : 1 } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Se ha consultado la lista de instancias de red. |
Códigos de error
Consulte Códigos de error.