Connexion à une destination à l'aide d'un jeton de service
Vous pouvez établir des connexions entre vos actifs ou des tiers en utilisant les informations prédéfinies dans un jeton de service. Les jetons de service peuvent être émis à la fois pour le côté a et le côté z d'une connexion.
Par exemple, vous pouvez créer une connexion entre un port et une destination fournie par un jeton de service. Un jeton de service côté z peut être émis pour un port, un dispositif virtuel Network Edge ou un réseau.
Conditions préalables
-
Authentifier - Soumettez vos informations d'identification de l'utilisateur, l'ID du client et le secret du client pour l'authentification OAuth2. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.
-
Déterminez vos informations sur le port a-side. Obtenez vos informations de port pertinentes à l'aide du point de terminaison Get All Ports.
-
Obtenez les détails du jeton de service z-side auprès du fournisseur. Ces informations sont nécessaires pour invoquer l'API de création de connexion.
Créer une connexion entre un port DOT1Q et un jeton de service
Pour créer une connexion à partir d'un port DOT1Q vers une destination définie par un jeton de service, envoyez une requête POST au point de terminaison /fabric/v4/connections. Spécifiez vos informations de port du côté a et les détails de votre jeton de service du côté z dans le corps de la requête.
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 | |
|---|---|
| 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 |
Pour valider cette demande en toute sécurité en production sans créer de connexion, consultez Testing in Production (API Dry Run).
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": "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"
]
}
]
}'
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 leur description, consultez la [Référence API] (/api-catalog/fabricv4#tag/Connections/operation/createConnection).
Exemple de réponse :
{
"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"
}
}
La charge utile de la réponse comprend les paramètres de configuration définis dans le corps de la demande. Pour une liste complète des paramètres possibles et de leurs descriptions, voir la [Référence API] (/api-catalog/fabricv4#tag/Connections/operation/createConnection).
Créer une connexion entre un port QINQ et un jeton de service
Pour créer une connexion à partir d'un port QINQ vers une destination définie par un jeton de service, envoyez une requête POST au point de terminaison /fabric/v4/connections. Spécifiez vos informations de port du côté a et les détails de votre jeton de service du côté z dans le corps de la requête.
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": "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"
]
}
]
}'
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 leur description, consultez la [Référence API] (/api-catalog/fabricv4#tag/Connections/operation/createConnection).
Contrôle de la connexion
Utilisez le point de terminaison Get Specified Connection pour surveiller l'état de la connexion.