Conectarse a un destino utilizando un token de servicio
Puede establecer conexiones entre sus activos o terceros utilizando la información predefinida en una Ficha de Servicio. Los Service Tokens pueden emitirse tanto para el lado a como para el lado z de una conexión.
Por ejemplo, puede crear una conexión desde un puerto a un destino proporcionado por un Service Token. Un token de servicio del lado z puede emitirse para un Puerto, un dispositivo virtual Network Edge o una Red.
Requisitos previos
-
Autenticar - Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para la autenticación OAuth2. Consulte API Authentication para obtener instrucciones sobre cómo llamar a la API OAuth para validar y autenticar sus credenciales.
-
Determine la información de su puerto a-side. Obtenga su información de puerto relevante utilizando el punto final Obtener todos los puertos.
-
Obtenga los detalles del token de servicio del lado z del proveedor. Esta información es necesaria para invocar la API de creación de conexión.
Crear una conexión desde un puerto DOT1Q a un token de servicio
Para crear una conexión desde un puerto DOT1Q a un destino definido por un token de servicio, envíe una solicitud POST al punto final /fabric/v4/connections. Especifique la información del puerto del lado a y los detalles del token de servicio del lado z en el cuerpo de la solicitud.
Un token de servicio puede enviarse a varios destinatarios, y es válido para un único uso por cualquiera de ellos.
| POST /fabric/v4/connections | |
|---|---|
| Method | POST |
| Endpoint | /fabric/v4/connections |
| Headers | Authorization, Content-Type |
| Path Parameters | Not applicable |
| Query Parameters | Not applicable |
| Body Parameters | type, name, order, bandwidth, aSide, zSide, notifications |
Para validar de forma segura esta solicitud en producción sin crear una conexión, consulte Pruebas en producción (API Dry Run).
Ejemplo de solicitud cURL:
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"type": "EVPL_VC",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {
"serviceToken": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
}
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
]
}'
Los parámetros incluidos en el cuerpo de la solicitud son específicos de este ejemplo. Para obtener una lista completa de los parámetros y sus descripciones, consulte la Referencia API.
Respuesta de muestra:
{
"href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "EVPL_VC",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"state": "PROVISIONING",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100",
"billingTier": "Up to 1 Gbps"
},
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
"type": "XF_PORT",
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {
"serviceToken": {
"href": "https://api.equinix.com/fabric/v4/serviceTokens/25acdea5-1eeb-4f0b-8ca9-6c505f46847d",
"uuid": "25acdea5-1eeb-4f0b-8ca9-6c505f46847d"
},
"accessPoint": {
"location": {
"metroHref" : "https://api.equinix.com/fabric/v4/metros/DC",
"region": "AMER",
"metroName": "Ashburn",
"metroCode": "DC"
},
"port": {
"type": "XF_PORT",
"href": "https://api.equinix.com/fabric/v4/ports/c5720fcc-4ae7-ae7e-13e0-306a5c00adaf",
"uuid": "c5720fcc-4ae7-ae7e-13e0-306a5c00adaf",
"name": "eqx-nfv-CX-DC6-L-Dot1q-BO-10G-PRI-JUN-7"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 3132
}
}
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
],
"operation": {
"equinixStatus": "PROVISIONING",
"providerStatus": "NOT_AVAILABLE"
},
"changeLog": {
"createdDateTime": "2021-07-15T19:30:29.526Z"
}
}
La carga útil de la respuesta incluye los parámetros de configuración definidos en el cuerpo de la solicitud. Para obtener una lista completa de los posibles parámetros y sus descripciones, consulte la Referencia API.
Crear una conexión desde un puerto QINQ a un token de servicio
Para crear una conexión desde un puerto QINQ a un destino definido por un token de servicio, envíe una solicitud POST al punto final /fabric/v4/connections. Especifique la información del puerto del lado a y los detalles del token de servicio del lado z en el cuerpo de la solicitud.
Ejemplo de solicitud cURL:
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"type": "EVPL_VC",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "QINQ",
"vlanCTag": 1001,
"vlanSTag": 1002
}
}
},
"zSide": {
"serviceToken": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
}
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
]
}'
Los parámetros incluidos en el cuerpo de la solicitud son específicos de este ejemplo. Para obtener una lista completa de los parámetros y sus descripciones, consulte la Referencia API.
Supervisión de la conexión
Utilice el punto final Obtener conexión especificada para supervisar el estado de la conexión.