Conectar un dispositivo Network Edge mediante un token de servicio
Establezca una conexión entre su dispositivo Network Edge y un recurso de red en Fabric usando el API de tela mediante un token de servicio.
Requisitos previos de la API de Fabric
-
Autenticar - Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para OAuth2 autenticación. Consulte Autenticación de API para obtener instrucciones sobre cómo llamar a OAuth API para validar y autenticar sus credenciales.
-
Recupere la información de sus dispositivos Network Edge con el botón Obtener dispositivos virtuales o Obtener dispositivo virtual {uuid}. En caso de un dispositivo redundante, elija el ID único del dispositivo primario o secundario. Del mismo modo, para un dispositivo de clúster, elija el ID único de
node0onode1. Solo habrá una conexión incluso si su dispositivo es redundante / clúster. -
Llame al endpointObtener todos los tokens de servicio para obtener tokens de servicio disponibles junto con la configuración de conexión permitida.
Conexión mediante un token de servicio
Para crear una conexión entre el dispositivo virtual Network Edge y otra ubicación de red en Fabric mediante un token de servicio, envíe una POST solicitud al /fabric/v4/connectionspunto final. Especifique qué dispositivo virtual, token de servicio y configuración de conexión en el cuerpo de la solicitud. Los detalles de la ubicación de la red son proporcionados por el token de servicio.
Un token de servicio puede enviarse a varios destinatarios, y es válido para un único uso por cualquiera de ellos.
| PUBLICAR /fabric/v4/Connections | |
|---|---|
| Método | POST |
| Punto final | /fabric/v4/connections |
| Encabezados | Authorization, Content-Type |
| Parámetros de la ruta | No aplicable |
| Parámetros de consulta | No aplicable |
| Parámetros corporales | type, name, order, redundancy, , , , bandwidth``aSide, zSide, , notifications |
En este ejemplo, el lado a es el dispositivo Network Edge y el token de servicio es para el destino del lado z.
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": "VD",
"virtualDevice": {
"type": "EDGE",
"uuid": "fd5342f3-d067-4683-a24f-be952279630b"
},
"interface": {
"type": "NETWORK",
"id": 5
}
}
},
"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 parámetros y sus descripciones, consulte la Referencia API .
Respuesta de muestra:
{
"type": "EVPL_VC",
"href": "https://api.equinix.com/fabric/v4/connections/ebc37e2e-c36b-4e93-86a4-fc4efce7abc8",
"uuid": "ebc37e2e-c36b-4e93-86a4-fc4efce7abc8",
"name": "Test ST",
"state": "ACTIVE",
"operation": {
"providerStatus": "AVAILABLE",
"equinixStatus": "PROVISIONED"
},
"notifications": [
{
"type": "ALL",
"emails": [
"testNEuser2@equinix.com"
]
}
],
"account": {
"accountNumber": 270235,
"orgId": 92794,
"globalOrgId": "0016u000003JZ55AAG"
},
"changeLog": {
"createdBy": "testNEuser2",
"createdDateTime": "2022-10-05T19:37:12.748Z",
"updatedBy": "testNEuser2",
"updatedDateTime": "2022-10-05T19:37:12.748Z"
},
"bandwidth": 50,
"redundancy": {
"group": "b64dad2a-2763-4084-bc50-b36ef4f67137",
"priority": "PRIMARY"
},
"isRemote": true,
"direction": "INTERNAL",
"aSide": {
"accessPoint": {
"interface": {
"uuid": "11fd6067-149f-4142-a5b4-54a8dd6f53fe",
"id": 6,
"type": "CLOUD"
},
"type": "VD",
"account": {
"accountNumber": 270217,
"organizationName": "eqx-nfv"
},
"location": {
"region": "AMER",
"metroName": "Ashburn",
"metroCode": "DC"
},
"virtualDevice": {
"href": "https://api.equinix.com/ne/v1/devices/3539f96c-7f67-4696-90f3-7b6d2fdcde5f",
"uuid": "3539f96c-7f67-4696-90f3-7b6d2fdcde5f",
"name": "testing1234",
"type": "EDGE"
}
}
},
"zSide": {
"serviceToken": {
"uuid": "e05f4f23-d098-4d7c-a9ca-c2897b465107",
"account": {
"orgId": 92794
}
},
"accessPoint": {
"type": "COLO",
"account": {
"accountNumber": 270235,
"organizationName": "testNEuser2-270235"
},
"location": {
"region": "AMER",
"metroName": "Ashburn",
"metroCode": "DC"
},
"port": {
"href": "https://qa3api.corp.equinix.com/fabric/v4/ports/c791f8cb-59d0-9d00-8ce0-306a5c00a4ee",
"uuid": "c791f8cb-59d0-9d00-8ce0-306a5c00a4ee",
"name": "testNEuser2-DC6-NL-Dot1q-STD-SEC-10G-JN-216"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 553
}
}
}
}
La carga útil de respuesta incluye parámetros de configuración definidos en el cuerpo de la solicitud. Para obtener una lista completa de posibles parámetros y sus descripciones, consulte la Referencia API .
Supervisión de su conexión
Utilice el punto finalGet Specified Connection API para supervisar el estado de la conexión.