Consultar la lista de conexiones de la nube
Función
Esta API se utiliza para consultar la lista de conexiones en la nube. 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/cloud-connections
|
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 conexiones en la nube. |
|
name |
No |
Array |
Nombre utilizado para consultar conexiones en la nube. |
|
description |
No |
Array |
Descripción utilizada para consultar conexiones en la nube. |
|
status |
No |
Array |
Estado de conexión en la nube. ACTIVE: las conexiones en la nube están disponibles. Predeterminado: ACTIVE |
|
enterprise_project_id |
No |
Array |
ID de proyecto empresarial utilizado para consultar una conexión a la nube. |
|
type |
No |
Array |
Tipo (escenario de aplicación) utilizado para consultar conexiones en la nube. |
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 |
|---|---|---|
|
cloud_connections |
Array of CloudConnection objects |
Lista de conexiones en la nube. |
|
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 conexión en la nube. Mínimo: 0 Máximo: 36 |
|
name |
String |
Nombre de conexión en la nube. Mínimo: 1 Máximo: 64 |
|
description |
String |
Descripción de conexión en la nube. Mínimo: 0 Máximo: 255 |
|
domain_id |
String |
ID de cuenta. Mínimo: 10 Máximo: 32 |
|
enterprise_project_id |
String |
ID del proyecto empresarial al que pertenece la conexión a la nube. Predeterminado: 0 Mínimo: 0 Máximo: 36 |
|
status |
String |
Estado de conexión en la nube. ACTIVE: las conexiones en la nube están disponibles. Mínimo: 0 Máximo: 36 |
|
admin_state_up |
Boolean |
Estado administrativo de la conexión a la nube. |
|
created_at |
String |
Tiempo en el que se creó la conexión a la nube, que está en el formato aaaa-MM-ddTHH:mm:ss. |
|
updated_at |
String |
Tiempo en el que se actualizó la conexión a la nube, que está en el formato aaaa-MM-ddTHH:mm:ss. |
|
used_scene |
String |
Escenario de aplicación de Cloud Connect. vpc: nube privada virtual Predeterminado: vpc Mínimo: 0 Máximo: 36 |
|
network_instance_number |
Integer |
Número de las instancias de red cargadas en la conexión a la nube. Mínimo: 0 Máximo: 10000 |
|
bandwidth_package_number |
Integer |
Número de los paquetes de ancho de banda vinculados a la conexión a la nube. Mínimo: 0 Máximo: 10000 |
|
inter_region_bandwidth_number |
Integer |
Número de los anchos de banda entre regiones configurados para la conexión a la nube. Mínimo: 0 Máximo: 10000 |
|
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 conexiones en la nube
GET https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connections
Ejemplo de las respuestas
Código de estado: 200
Se ha consultado la lista de conexiones en la nube.
{
"request_id" : "ab44eb7776995d84a7580fe6a7bd7629",
"cloud_connections" : [ {
"status" : "ACTIVE",
"id" : "XXX",
"name" : "test",
"description" : "",
"domain_id" : "XXX",
"created_at" : "2022-06-24T08:28:28Z",
"updated_at" : "2022-06-24T08:28:28Z",
"admin_state_up" : true,
"used_scene" : "vpc",
"enterprise_project_id" : "0",
"network_instance_number" : 0,
"bandwidth_package_number" : 0,
"inter_region_bandwidth_number" : 0
} ],
"page_info" : {
"previous_marker" : "XXX",
"current_count" : 30
}
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Se ha consultado la lista de conexiones en la nube. |
Códigos de error
Consulte Códigos de error.