API - Connexion à IBM Cloud Direct Link 2.0
Établissez une connexion avec IBM Cloud™ Direct Link 2.0 pour connecter vos actifs colocalisés IBX à vos ressources IBM Cloud.
Identifiez votre identifiant de compte IBM
Connectez-vous à la console IBM Cloud et sélectionnez gérer > compte pour localiser votre identifiant de compte IBM.
Conditions préalables pour l'API Fabric
-
Authentifier - Soumettez vos informations d'identification, votre ID client et votre secret client pour OAuth2. authentification. Pour savoir comment appeler OAuth API pour valider et authentifier vos identifiants, reportez-vous à authentification API.
-
Déterminez vos informations A-Side. Soit :
- Récupérez les informations de vos ports Equinix Fabric à l'aide de la demandeGet All ports API.
OU
- Déterminez les informations relatives à votre appareil Network Edge. Vous avez besoin d'un dispositif virtuel Equinix/de dispositifs redondants/de clusters provisionnés avec une licence enregistrée. Vérifiez vos dispositifs virtuels et clusters disponibles en appelant GetVirtualDevices ou Get Virtual Device {UUID}. Vous pouvez choisir n'importe quelle interface disponible sur l'appareil pour votre connexion. Cependant, Equinix sélectionnera une interface si vous n'en spécifiez pas.
-
Choisissez l'emplacement métropolitain Z-Side. Utilisez la demandeGet All Metros API pour trouver toutes lesmétros où Equinix Fabric est disponible et déterminer l'emplacement de destination.
-
Identifiez le profil de service. Utilisez la demande Retrieve Service Profiles API pour rechercher un profil de service spécifique ou la demandeGet Service Profiles API pour répertorier tous les profils deservice disponibles et identifier le système profil auquel vous souhaitez vous connecter.
Connexion à IBM Cloud Direct Link 2.0 à partir d'un port DOT1Q
Pour créer une connexion entre votre port DOT1Q et IBM Cloud Direct Link 2,0, envoyez POSTune demande au /fabric/v4/connectionspoint final. Spécifiez les détails de configuration de votre connexion dans le corps de la demande.
| POST /fabric/v4/connections | |
|---|---|
| Méthode | POST |
| Terminal | /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, bandwidth, , redundancy``aSide, zSide, , additionalInfo``notifications |
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,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV"
},
"authenticationKey": "xx-xxx-xx",
"sellerRegion": "us-west-1"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": "12345"
},
{
"key": "CER IPv4 CIDR",
"value": "11.1.1.10/30"
},
{
"key": "IBM IPv4 CIDR",
"value": "11.1.1.10/30"
}
],
"notifications": {
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
}'
Les paramètres inclus dans le corps de la demande 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 :
{
"href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "EVPL_VC",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"name": "Conn-1",
"state": "PROVISIONING",
"order": {
"purchaseOrderNumber": "1-129105284100",
"billingTier": "Up to 1 Gbps"
},
"bandwidth": 1000,
"redundancy": {
"group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
"priority": "PRIMARY"
},
"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": {
"accessPoint": {
"type": "SP",
"profile": {
"href": "https://api.equinix.com/fabric/v4/services/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5",
"type": "L2_PROFILE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"href": "https://api.equinix.com/v4/metros/SV",
"metroCode": "SV",
"region": "AMER"
},
"authenticationKey": "xx-xxx-xx",
"sellerRegion": "us-west-1"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": "12345"
},
{
"key": "CER IPv4 CIDR",
"value": "11.1.1.10/30"
},
{
"key": "IBM IPv4 CIDR",
"value": "11.1.1.10/30"
}
],
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
],
"operation": {
"equinixStatus": "PROVISIONING",
"providerStatus": "PROVISIONING"
},
"changeLog": {
"createdDateTime": "2021-07-15T19:30:29.526Z"
}
}
La charge utile de réponse comprend les paramètres de configuration définis dans le corps de la demande. Pour obtenir la liste complète des paramètres possibles et leurs descriptions, reportez-vous à la référence API .
Connexion à IBM Cloud Direct Link 2.0 à partir d'un port QINQ
Pour créer une connexion entre votre port QINQ et IBM Cloud Direct Link 2,0, envoyez POSTune demande au /fabric/v4/connectionspoint de terminaison. Spécifiez les détails de configuration de votre connexion dans le corps de la demande.
| POST /fabric/v4/connections | |
|---|---|
| Méthode | POST |
| Terminal | /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, bandwidth, , redundancy``aSide, zSide, , additionalInfo``notifications |
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,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "QINQ",
"vlanCTag": 1001,
"vlanSTag": 1002
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV"
},
"authenticationKey": "xx-xxx-xx",
"sellerRegion": "us-west-1"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": "12345"
},
{
"key": "CER IPv4 CIDR",
"value": "11.1.1.10/30"
},
{
"key": "IBM IPv4 CIDR",
"value": "11.1.1.10/30"
}
],
"notifications": {
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
}'
Les paramètres inclus dans le corps de la demande sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, reportez-vous à la référence API .
Connexion à IBM Cloud Direct Link 2.0 à partir d'un périphérique Network Edge
Pour créer une connexion entre votre appareil Network Edge et IBM Cloud Direct Link 2,0, envoyez une POST demande au /fabric/v4/connectionsterminal. Spécifiez les détails de configuration de votre connexion dans le corps de la demande.
| POST /fabric/v4/connections | |
|---|---|
| Méthode | POST |
| Terminal | /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, bandwidth, , redundancy``aSide, zSide, , additionalInfo``notifications |
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": "port2ibm2-vvv-0425f",
"bandwidth": "50",
"aSide": {
"accessPoint": {
"type": "VD",
"virtualDevice": {
"type": "EDGE",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"type": "L2_PROFILE",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"location": {
"metroCode": "SV"
},
"authenticationKey": "XXXXXXXXXX",
"sellerRegion": "San Jose 2"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": 12345
},
{
"key": "BGP_CER_CIDR",
"value": "172.16.0.17/30"
},
{
"key": "BGP_IBM_CIDR",
"value": "172.16.0.18/30"
},
{
"key": "Global",
"value": false
}
],
"project": {
"projectId": "16799d66-ef43-445c-ba29-d17522d8a137"
},
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"notifications": [
{
"type": "ALL",
"emails": [
"x@gmail.com"
]
}
]
}
'
Les paramètres inclus dans le corps de la demande 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/0175e136-8be7-4b04-8d57-c33c20555501",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"name": "port2ibm2-vvv-0425f",
"operation": {
"providerStatus": "PROVISIONING",
"equinixStatus": "PROVISIONING"
},
"order": {
"purchaseOrderNumber": "1-129105284100",
"billingTier": "Up to 50 MB"
},
"notifications": [
{
"type": "ALL",
"emails": [
"x@gmail.com"
]
}
],
"changeLog": {
"createdBy": "fabricamcrh1",
"createdByFullName": "XXXXX XXXXXX",
"createdByEmail": "x@gmail.com",
"createdDateTime": "2024-04-25T20:41:37.805Z",
"updatedBy": "fabricamcrh1",
"updatedByFullName": "XXXXXX XXXXXX",
"updatedByEmail": "x@gmail.com",
"updatedDateTime": "2024-04-25T20:41:37.805Z"
},
"bandwidth": 50,
"redundancy": {
"group": "d1f11356-91ca-4550-8488-ba434a771e09",
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"interface": {
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"id": 8,
"type": "CLOUD"
},
"location": {
"metroCode": "DC"
},
"virtualDevice": {
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"type": "EDGE"
}
}
},
"zSide": {
"accessPoint": {
"location": {
"metroCode": "SV"
},
"profile": {
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/e092ed47-63d2-4f4a-87a0-82e3b08eefe5",
"type": "L2_PROFILE",
"name": "IBM Cloud Direct Link 2",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"sellerRegion": "San Jose 2",
"authenticationKey": "XXXXXXXXXXXXXXXXXXX"
}
}
}
La charge utile de réponse comprend les paramètres de configuration définis dans le corps de la demande. Pour obtenir la liste complète des paramètres possibles et leurs descriptions, reportez-vous à la référence API .
Contrôle de l'état de la connexion
Envoyer une GET demande au fabric/v4/connections/{connectionId}point final pour surveiller l'état de la connexion.
equinixStatusvaleurs d'attribut | providerStatusvaleurs d'attribut | État d'IBM Direct Link | Description |
|---|---|---|---|
PROVISIONING | PROVISIONING | - | La demande de connexion n'a pas encore été envoyée à IBM. |
PENDING_PROVIDER_VLAN | PENDING_APPROVAL | Créer une approbation en attente | La connexion est en attente d'approbation. |
PROVISIONED | PROVISIONING / PROVISIONED | Création en cours | Établissement de la connexion en cours. |
PROVISIONED | PROVISIONED | Provisionné | Connexion établie. |
Accepter la connexion
Connectez-vous à la console IBM Cloud et accédez à la page IBM Cloud Direct Link Exchange pour vérifier et accepter la connexion en attente.