Conecte o dispositivo de Network Edge usando o token de serviço
Estabeleça uma conexão entre seu dispositivo Network Edge e um recurso de rede no Fabric usando o Fabric API usando um token de serviço.
Pré-requisitos da API Fabric
-
Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para OAuth2. autenticação. Consulte Autenticação API para obter instruções sobre como chamar o OAuth API para validar e autenticar suas credenciais.
-
Recupere as informações de seus dispositivos Network Edge usando Obter dispositivos virtuais ou Obter dispositivo virtual . No caso de um dispositivo redundante, escolha o ID exclusivo do dispositivo primário ou secundário. Da mesma forma, para um dispositivo de cluster, escolha o ID exclusivo de
node0ounode1. Haverá apenas uma conexão, mesmo que seu dispositivo seja redundante/cluster. -
Chame o endpointObter todos os tokens de serviço para obter tokens de serviço disponíveis junto com as configurações de conexão permitidas.
Conexão usando um token de serviço
Para criar uma conexão entre seu dispositivo virtual Network Edge e outro local de rede no Fabric usando um token de serviço, envie uma POST solicitação para o /fabric/v4/connections endpoint. Especifique qual dispositivo virtual, token de serviço e configuração de conexão no corpo da solicitação. Os detalhes do local da rede são fornecidos pelo token de serviço.
Um token de serviço pode ser enviado para vários destinatários e é válido para uso único por qualquer um deles.
| POST /fabric/v4/connections | |
|---|---|
| Método | POST |
| Ponto de extremidade | /fabric/v4/connections |
| Cabeçalhos | Authorization, Em inglês Content-Type |
| Parâmetros do caminho | Não aplicável |
| Parâmetros de consulta | Não aplicável |
| Parâmetros Corporais | type``name, , order redundancy, , , bandwidth, , , aSide, zSideem inglês, notifications |
Neste exemplo, o lado A é o dispositivo Network Edge e o Token de Serviço é para o destino do lado Z.
Exemplo de solicitação 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"
]
}
]
}'
Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa de parâmetros e suas descrições, consulte a Referência do API .
Exemplo de resposta:
{
"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
}
}
}
}
O payload de resposta inclui parâmetros de configuração definidos no corpo da solicitação. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência do API .
Monitorando sua conexão
Use o ponto de extremidadeGet Specified Connection API para monitorar o status da conexão.