Conectar-se a um destino usando um token de serviço
Você pode estabelecer conexões entre seus ativos ou terceiros usando as informações predefinidas em um Token de Serviço. Tokens de Serviço podem ser emitidos tanto para o lado A quanto para o lado Z de uma conexão.
Por exemplo, você pode criar uma conexão de uma porta para um destino fornecido por um Token de Serviço. Um token de serviço do lado z pode ser emitido para uma Porta, um dispositivo virtual de Network Edge ou uma Rede.
Pré-requisitos
-
Autenticar - Envie suas credenciais de usuário, ID do Cliente e Segredo do Cliente para autenticação OAuth2. Consulte Autenticação de API para obter instruções sobre como chamar a API OAuth para validar e autenticar suas credenciais.
-
Determine as informações da sua porta do lado A. Obtenha as informações relevantes da porta usando o endpoint Obter todas as portas.
-
Obtenha os detalhes do token de serviço do lado Z junto ao provedor . Essas informações são necessárias para invocar a API de criação de conexão .
Criar uma conexão de uma porta DOT1Q para um token de serviço
Para criar uma conexão de uma porta DOT1Q para um destino definido por um token de serviço, envie uma solicitação POST para o endpoint /fabric/v4/connections. Especifique as informações da porta do lado A e os detalhes do token de serviço do lado Z no corpo da solicitaçã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 | |
|---|---|
| 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 esta solicitação com segurança em produção sem criar uma conexão, consulte Testando em Produção (Simulação de API).
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": "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"
]
}
]
}'
Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.
Exemplo de resposta:
{
"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"
}
}
A resposta inclui parâmetros de configuração definidos no corpo da requisição. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência da API.
Crie uma conexão de uma porta QINQ para um token de serviço
Para criar uma conexão de uma porta QINQ para um destino definido por um token de serviço, envie uma solicitação POST para o endpoint /fabric/v4/connections. Especifique as informações da porta do lado A e os detalhes do token de serviço do lado Z no corpo da solicitação.
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": "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"
]
}
]
}'
Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.
Monitorando a Conexão
Use o endpoint Obter conexão especificada para monitorar o status da conexão.