Consulta de la lista de conexiones
Función
Esta API se utiliza para consultar todas las conexiones directas creadas por un tenant.
URI
GET /v3/{project_id}/dcaas/direct-connects
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
limit |
No |
Integer |
Especifica el número de registros devueltos en cada página. Rango de valores: 1 a 2000 Mínimo: 1 Máximo: 2000 Predeterminado: 2000 |
marker |
No |
String |
Especifica el ID del último registro de recursos de la página anterior. Si este parámetro se deja en blanco, se consulta la primera página. Este parámetro debe usarse junto con limit. Mínimo: 0 Máximo: 36 |
fields |
No |
Array |
Especifica la lista de campos que se mostrarán. |
sort_key |
No |
String |
Especifica el campo de la ordenación. Predeterminado: created_at Mínimo: 0 Máximo: 36 |
sort_dir |
No |
Array |
Especifica el orden de clasificación de los resultados devueltos, que puede ser asc (orden ascendente) o desc (orden descendente). El valor predeterminado es asc. |
hosting_id |
No |
Array |
Especifica el identificador de conexión de operaciones por el que se filtran las conexiones alojadas. |
enterprise_project_id |
No |
Array |
Especifica el ID del proyecto de empresa por el que se filtran las redes centrales. |
id |
No |
Array |
Especifica el ID de recurso por el que se filtran las instancias. |
name |
No |
Array |
Especifica el nombre del recurso por el que se filtran las instancias. Puede especificar varios nombres. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Especifica el token de usuario. Para obtener el token, consulte la sección "Obtención del token de usuario" en la Referencia de las API de Identity and Access Management. El token es el valor de X-Subject-Token en la cabecera de respuesta. Mínimo: 0 Máximo: 10240 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
request_id |
String |
Especifica el ID de la solicitud. |
direct_connects |
Array of DirectConnect objects |
Especifica los parámetros para crear una conexión. |
page_info |
PageInfo object |
Especifica la información de consulta de paginación. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de conexión. |
tenant_id |
String |
Especifica el ID del proyecto al que pertenece la instancia. |
name |
String |
Especifica el nombre de la conexión. Mínimo: 0 Máximo: 64 |
description |
String |
Proporciona la información complementaria sobre la conexión. Mínimo: 0 Máximo: 128 |
port_type |
String |
Especifica el tipo de puerto utilizado por la conexión. El valor puede ser 1G, 10G, 40G o 100G. Valores de enumeración:
|
bandwidth |
Integer |
Especifica el ancho de banda de conexión en Mbit/s. Mínimo: 2 Máximo: 100000 |
location |
String |
Especifica la información acerca de la ubicación de Direct Connect. Mínimo: 0 Máximo: 255 |
peer_location |
String |
Especifica la ubicación de la instalación local en el otro extremo de la conexión, específica del nombre de la calle o del centro de datos. Mínimo: 0 Máximo: 255 |
device_id |
String |
Especifica el ID del dispositivo conectado a la conexión. Mínimo: 0 Máximo: 36 |
type |
String |
Especifica el tipo de conexión, que puede ser standard, hosting y hosted. Predeterminado: standard Valores de enumeración:
|
hosting_id |
String |
Especifica el identificador de la conexión de operaciones en la que se crea la conexión alojada. |
charge_mode |
String |
Especifica el modo de facturación, que puede ser prepayment, bandwidth o traffic. Valores de enumeración:
|
provider |
String |
Especifica el operador de la conexión, por ejemplo China Telecom, China Unicom, China Mobile y otros operadores dentro y fuera de China continental. |
admin_state_up |
Boolean |
Especifica el estado administrativo, que puede ser true o false. Predeterminado: true |
vlan |
Integer |
Especifica la VLAN asignada a la conexión alojada. Mínimo: 0 Máximo: 3999 |
status |
String |
Especifica el estado de la conexión, que puede ser ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT o REJECTED. Valores de enumeración:
|
apply_time |
String |
Especifica cuándo se solicitó la conexión. |
create_time |
String |
Especifica cuándo se creó la conexión. |
provider_status |
String |
Especifica el estado de la línea arrendada del operador. El estado puede ser ACTIVE o DOWN. Valores de enumeración:
|
peer_port_type |
String |
Especifica el tipo de puerto del mismo nivel. |
peer_provider |
String |
Especifica el portador conectado a la conexión. |
order_id |
String |
Especifica el ID de pedido de conexión, que se utiliza para admitir la facturación basada en la duración e identificar los pedidos de usuario. |
product_id |
String |
Especifica el ID de producto correspondiente al pedido de la conexión, que se utiliza para las políticas de facturación personalizadas, como los paquetes basados en la duración. |
spec_code |
String |
Especifica las especificaciones del producto correspondientes al pedido de la conexión, que se utilizan para las políticas de facturación personalizadas, como los paquetes basados en la duración. |
period_type |
Integer |
Especifica si una conexión en un pedido especificado se factura por año o por mes. |
period_num |
Integer |
Especifica la duración del servicio requerida de una conexión anual/mensual. |
vgw_type |
String |
Especifica el tipo de gateway requerido por una conexión directa. Predeterminado: default Valores de enumeración:
|
lag_id |
String |
Especifica el ID del LAG al que pertenece la conexión. |
signed_agreement_status |
String |
Especifica el estado de firma del acuerdo de Direct Connect. Valores de enumeración:
|
enterprise_project_id |
String |
Especifica el ID del proyecto de empresa al que pertenece la conexión. Mínimo: 36 Máximo: 36 |
tags |
Array of Tag objects |
Especifica las etiquetas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta. La clave puede contener un máximo de 36 caracteres de Unicode, incluidos letras, dígitos, guiones (-) y guiones bajos (_). Mínimo: 0 Máximo: 36 |
value |
String |
Especifica el valor de etiqueta. El valor puede contener un máximo de 43 caracteres de Unicode, incluidos letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Mínimo: 0 Máximo: 43 |
Parámetro |
Tipo |
Descripción |
---|---|---|
previous_marker |
String |
Especifica el marcador de la página anterior. El valor es el UUID del recurso. Mínimo: 0 Máximo: 36 |
current_count |
Integer |
Especifica el número de recursos de la lista actual. Mínimo: 0 Máximo: 2000 |
next_marker |
String |
Especifica el marcador de la página siguiente. El valor es el UUID del recurso. Si el valor está vacío, el recurso se encuentra en la última página. Mínimo: 0 Máximo: 36 |
Ejemplo de las solicitudes
Actualización de una conexión
GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects
Ejemplo de las respuestas
Código de estado: 200
OK
{ "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535", "direct_connects" : [ { "bandwidth" : 100, "create_time" : "2018-10-19 09:53:26.389556", "port_type" : "10G", "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "apply_time" : "2018-10-19 09:53:26.389556", "peer_location" : "", "location" : "Biere", "provider" : "OTC", "type" : "standard", "status" : "BUILD", "description" : "", "provider_status" : "ACTIVE", "order_id" : "", "vlan" : null, "device_id" : "172.16.40.2", "name" : "direct connect1", "admin_state_up" : true, "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", "hosting_id" : null, "product_id" : "", "charge_mode" : "" } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Aceptar |
Códigos de error
Consulte Códigos de error.