Connecter un périphérique Network Edge à l'aide d'un jeton de service
Établissez une connexion entre votre périphérique Network Edge et une ressource réseau sur Fabric à l'aide de Fabric API à l'aide d'un jeton de service.
Conditions préalables pour l'API Fabric
-
Authentifier - Soumettez vos informations d'identification, votre ID client et votre secret client pour OAuth2. authentification. Reportez-vous à authentification API pour obtenir des instructions sur la façon d'appeler OAuth API pour valider et authentifier vos informations d'identification.
-
Récupérez les informations sur vos périphériques Network Edge à l'aide de l'option obtenir des périphériques virtuels ou obtenir un périphérique virtuel {UUID}. Dans le cas d'un périphérique redondant, choisissez l'ID unique du périphérique principal ou secondaire. De même, pour un périphérique de cluster, choisissez l'ID unique de
node0ounode1. Il n'y aura qu'une seule connexion même si votre périphérique est redondant/cluster. -
Appelez le point de terminaisonobtenir tous les tokens de service pour obtenir les tokens de service disponibles ainsi que les paramètres de connexion autorisés.
Connexion à l'aide d'un jeton de service
Pour créer une connexion entre votre périphérique virtuel Network Edge et un autre emplacement réseau sur Fabric à l'aide d'un jeton de service, envoyez POSTune demande au /fabric/v4/connectionspoint final. Spécifiez le périphérique virtuel, le jeton de service et la configuration de connexion dans le corps de la demande. Les détails de l'emplacement réseau sont fournis par le jeton de service.
Un jeton de service peut être envoyé à un certain nombre de destinataires et n'est valable que pour une seule utilisation par chacun d'entre eux.
| POST /fabric/v4/connections | |
|---|---|
| Méthode | POST |
| Point d'extrémité | /fabric/v4/connections |
| En-têtes | Authorization Content-Type |
| Paramètres du chemin d'accès | Non applicable |
| Paramètres d'interrogation | Non applicable |
| Paramètres du corps | type, name, order, redundancy, , bandwidth``aSide, zSide, notifications |
Dans cet exemple, le côté a correspond au périphérique Network Edge et le jeton de service est destiné à la destination côté z.
Exemple de requête 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"
]
}
]
}'
Les paramètres inclus dans le corps de la requête sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, reportez-vous à la référence API .
Exemple de réponse :
{
"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 charge utile de réponse comprend des paramètres de configuration définis dans le corps de la requête. Pour une liste complète des paramètres possibles et leurs descriptions, reportez-vous à la référence API .
Contrôle de votre connexion
Utilisez le point de terminaisonGet Specified Connection API pour surveiller l'état de la connexion.