Connecter un périphérique Network Edge périphérique à l'aide d'un jeton de service
Établissez une connexion entre votre périphérique de périphérie de réseau et une ressource réseau sur Fabric à l'aide de l'API Fabric à l'aide d'un jeton de service.
Prérequis de l'API Fabric
-
Authentification - Soumettez vos identifiants utilisateur, votre identifiant client et votre clé secrète client pour OAuth2 Authentification. Consultez Authentification API pour obtenir des instructions sur la façon d'appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.
-
Récupérez les informations de vos périphériques Network Edge à l'aide de l'API Get Virtual Devices ou Get Virtual Device {uuid}. Dans le cas d'un appareil redondant, choisissez l'identifiant unique de l'appareil principal ou secondaire. De même, pour un périphérique en grappe, choisissez l'identifiant unique de
node0ounode1. Une seule connexion sera établie, même si votre appareil est redondant ou en cluster. -
Appelez le point de terminaison Get All Service Tokens pour obtenir les jetons de service disponibles ainsi que les paramètres de connexion autorisés.
Connexion à l'aide d'un jeton de service
Pour établir 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 une requête POST au point de terminaison /fabric/v4/connections. Spécifiez le périphérique virtuel, le jeton de service et la configuration de connexion dans le corps de la requête. Les informations relatives à l'emplacement du réseau sont fournies par le jeton de service.
Un jeton de service peut être envoyé à plusieurs destinataires et est valable pour une seule utilisation par chacun d'entre eux.
| 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, redundancy, bandwidth, aSide, zSide, notifications |
Dans cet exemple, le côté A est le 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 propres à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, consultez la référence de l'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 la réponse inclut les paramètres de configuration définis dans le corps de la requête. Pour obtenir la liste complète des paramètres possibles et leurs descriptions, consultez la référence de l'API.
Surveiller votre connexion
Utilisez le point de terminaison API Get Specified Connection pour surveiller l'état de la connexion.