API - Connexion à AWS Direct Connect

Établissez une connexion directe de couche 2 entre vos actifs colocalisés IBX et vos ressources Amazon Web Services (AWS) grâce à Fabric et AWS Direct Connect. Utilisez l'API pour créer la connexion à partir d'un port, d'un dispositif Network Edge ou d'un Fabric Cloud Router.

Si vous disposez d'un jeton de service fourni par AWS, consultez Se connecter à une destination à l'aide d'un jeton de service.

Conditions préalables à l'API

Authentifier - Soumettez vos informations d'identification, votre ID client et votre secret client pour OAuth2. authentification. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.
Déterminez les informations relatives à votre face A. Soit :
- Déterminez les informations sur les ports de votre Equinix Fabric en envoyant une requête GET au point d'extrémité /fabric/v4/ports. Vous avez besoin de l'UUID du port et du type de protocole de liaison (DOT1Q ou QINQ),
OU
- Récupérez votre ou vos jetons de service a-side en envoyant une requête GET au point de terminaison /fabric/v4/serviceTokens. Vous avez besoin de l'UUID du jeton. Le jeton a-side fournit les informations nécessaires pour configurer le a-side de la connexion.
OU
- Déterminez les informations relatives à votre périphérique Network Edge. Vérifiez vos dispositifs virtuels et clusters disponibles en envoyant une requête GET au point d'extrémité /ne/v1/devices. Vous avez besoin de l'UUID de l'appareil. Envoyez une requête GET au point de terminaison /ne/v1/devices/{device_id} pour obtenir les spécificités d'un périphérique. Vous pouvez choisir n'importe quelle interface disponible sur le périphérique pour votre connexion. Si vous n'en spécifiez pas, la connexion est automatiquement attribuée à la prochaine interface disponible.
OU
- Déterminez les informations relatives à votre Fabric Cloud Router. Vérifiez vos routeurs cloud disponibles en envoyant une requête POST au point de terminaison /fabric/v4/routers/search. Vous avez besoin de l'UUID du routeur.
Identifiez le profil de service AWS Direct Connect et les informations de localisation. Vous trouverez plus d'informations sur le profil de service que vous devez choisir sur la page AWS Direct Connect Overview.
- AWS Direct Connect UUID - 69ee618d-be52-468d-bc99-00566f2dd2b9 (en anglais)
- AWS Direct Connect High Capacity UUID - de55ca94-df3b-4680-845f-6f7093f76bef
- AWS Direct Connect Redundant UUID - 8b5cbdbd-53da-4d37-9bfc-cc988eb522f1 (en anglais)
- AWS Direct Connect- High Capacity Redundant - ed48616a-c182-40b4-a462-a78ba812e961 (en anglais)
Pour trouver les informations de localisation, envoyez une requête GET au point de terminaison [/fabric/v4/serviceProfiles/{service_profile_ID}] (https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid) en utilisant l'un des identifiants de profil de service AWS Direct Connect. L'objet metros de la réponse contient une liste des Metros Equinix et de leur région AWS associée. Vous avez besoin des deux pour créer une connexion.
Identifiez et validez votre identifiant de compte Amazon. Connectez-vous à la console de gestion AWS et recherchez votre numéro de compte. Reportez-vous à la [documentation AWS] (https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) pour savoir comment trouver votre numéro de compte. Envoyez une requête POST au point de terminaison /fabric/v4/connections/validate pour vérifier que votre identifiant de compte AWS peut être utilisé pour créer une connexion au profil de service sélectionné dans le métro donné.

Connexion à partir d'un port DOT1Q

Pour créer une connexion depuis votre port DOT1Q vers AWS, envoyez une requête POST au point de terminaison /fabric/v4/connections. Le type de connexion est EVPL_VC.

Fournissez vos informations portuaires dans l'objet aSide, y compris :

accessPoint.type as COLO
Fournissez l'UUID de votre port à port.uuid
linkProtocol.type comme DOT1Q
Fournissez l'ID du VLAN à linkProtocol.vlanTag

Fournissez les détails de votre AWS Direct Connect et les détails de votre emplacement dans l'objet zSide, y compris :

Définissez accessPoint.type comme SP.
Définissez profile.type comme L2_PROFILE.
Spécifiez le profil de service AWS auquel vous vous connectez dans profile.uuid.
Spécifiez l'emplacement Metro-Connect d'Equinix auquel vous vous connectez dans location.metroCode.
Spécifiez la région AWS associée au Metro Equinix dans sellerRegion. Vous trouverez ces informations dans le point de terminaison [/fabric/v4/serviceProfiles/{service_profile_ID}] (https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid). Voir le point de terminaison API Prerequisites. Voir API Prerequisites pour plus de détails.
Définissez authenticationKey comme étant l'ID de votre compte AWS.

Spécifiez tous les autres détails de configuration de la connexion, y compris bandwidth et redundancy, dans le corps de la requête. Pour une liste complète des paramètres et de leurs descriptions, consultez la [Référence API] (/api-catalog/fabricv4#tag/Connections/operation/createConnection).

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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "accessPoint": {
      "type": "COLO",
      "port": {
        "uuid": "<port_uuid>"
      },
      "linkProtocol": {
        "type": "DOT1Q",
        "vlanTag": <vlan_ID>
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}'

Connexion à partir d'un port QINQ

Pour créer une connexion entre votre port QINQ et AWS, envoyez une requête POST au point de terminaison /fabric/v4/connections. Le type de connexion est EVPL_VC.

Fournissez vos informations portuaires dans l'objet aSide, y compris :

Définissez accessPoint.type comme COLO
Fournissez l'UUID de votre port à port.uuid
linkProtocol.type as QINQ
Fournissez l'ID du tag interne à linkProtocol.vlanCTag
Fournissez l'ID du tag externe à linkProtocol.vlanSTag

Fournissez les détails de votre AWS Direct Connect et les détails de votre emplacement dans l'objet zSide, y compris :

Définissez accessPoint.type comme SP.
Définissez profile.type comme L2_PROFILE.
Spécifiez le profil de service AWS auquel vous vous connectez dans profile.uuid.
Spécifiez l'emplacement Metro-Connect d'Equinix auquel vous vous connectez dans location.metroCode.
Spécifiez la région AWS associée au Metro Equinix dans sellerRegion. Vous trouverez ces informations dans le point de terminaison [/fabric/v4/serviceProfiles/{service_profile_ID}] (https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid). Voir le point de terminaison API Prerequisites. Voir API Prerequisites pour plus de détails.
Définissez authenticationKey comme étant l'ID de votre compte AWS.

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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "accessPoint": {
      "type": "COLO",
      "port": {
        "uuid": "<port_uuid>"
      },
      "linkProtocol": {
        "type": "QINQ",
        "vlanCTag": <inner_tag_ID>,
        "vlanSTag": <outer_tag_ID>
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}

Connexion à l'aide d'un jeton de service

Pour créer une connexion à l'aide d'un jeton de service côté A vers AWS, envoyez une requête POST au point de terminaison /fabric/v4/connections. Le type de connexion est EVPL_VC.

Provider your Service Token UUID to in the aSide object. Le jeton de service fournit toutes les autres informations nécessaires pour établir la connexion.

Fournissez les détails de votre AWS Direct Connect et les détails de votre emplacement dans l'objet zSide, y compris :

Définissez accessPoint.type comme SP.
Définissez profile.type comme L2_PROFILE.
Spécifiez le profil de service AWS auquel vous vous connectez dans profile.uuid.
Spécifiez l'emplacement Metro-Connect d'Equinix auquel vous vous connectez dans location.metroCode.
Spécifiez la région AWS associée au Metro Equinix dans sellerRegion. Vous trouverez ces informations dans le point de terminaison [/fabric/v4/serviceProfiles/{service_profile_ID}] (https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid). Voir le point de terminaison API Prerequisites. Voir API Prerequisites pour plus de détails.
Définissez authenticationKey comme étant l'ID de votre compte AWS.

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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "serviceToken": {
      "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}

Connexion à partir d'un périphérique Network Edge

Pour créer une connexion entre votre dispositif Network Edge et AWS, envoyez une requête POST au point de terminaison /fabric/v4/connections. Le type de connexion est EVPL_VC.

Définissez votre dispositif Network Edge dans l'objet aSide en incluant :

accessPoint.type as VD
virtualDevice.type as EDGE
virtualDevice.uuid as your device's UUID

Fournissez les détails de votre AWS Direct Connect et les détails de votre emplacement dans l'objet zSide, y compris :

Définissez accessPoint.type comme SP.
Définissez profile.type comme L2_PROFILE.
Spécifiez le profil de service AWS auquel vous vous connectez dans profile.uuid.
Spécifiez l'emplacement Metro-Connect d'Equinix auquel vous vous connectez dans location.metroCode.
Spécifiez la région AWS associée au Metro Equinix dans sellerRegion. Vous trouverez ces informations dans le point de terminaison [/fabric/v4/serviceProfiles/{service_profile_ID}] (https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid). Voir le point de terminaison API Prerequisites. Voir API Prerequisites pour plus de détails.
Définissez authenticationKey comme étant l'ID de votre compte AWS.

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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "accessPoint": {
      "type": "VD",
      "virtualDevice": {
        "type": "EDGE",
        "uuid": "<device_uuid>"
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}'

Connexion à partir d'un Fabric Cloud Router

Pour créer une connexion entre votre Fabric Cloud Router et AWS, envoyez une requête POST au point de terminaison /fabric/v4/connections. Le type de connexion est IP_VC.

Définissez votre Fabric Cloud Router dans l'objet aSide, notamment :

Définissez accessPoint.type comme CLOUD_ROUTER.
Définissez router.uuid comme l'UUID de votre routeur.

Fournissez les détails de votre AWS Direct Connect et les détails de votre emplacement dans l'objet zSide, y compris :

Définissez accessPoint.type comme SP.
Définissez profile.type comme L2_PROFILE.
Spécifiez le profil de service AWS auquel vous vous connectez dans profile.uuid.
Spécifiez l'emplacement Metro-Connect d'Equinix auquel vous vous connectez dans location.metroCode.
Spécifiez la région AWS associée au Metro Equinix dans sellerRegion. Vous trouverez ces informations dans le point de terminaison [/fabric/v4/serviceProfiles/{service_profile_ID}] (https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid). Voir le point de terminaison API Prerequisites. Voir API Prerequisites pour plus de détails.
Définissez authenticationKey comme l'identifiant de votre compte AWS.

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": "IP_VC",
  "name": "<your_connection_name>",
    "bandwidth": <connection_speed>,
    "redundancy": {
      "priority": "<redundancy_code>"
    },
  "aSide": {
    "accessPoint": {
      "type": "CLOUD_ROUTER",
      "router": {
        "uuid": "<cloud_router_uuid>"
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}'

Contrôle de l'état de la connexion

Envoyez une requête GET au point de terminaison fabric/v4/connections/{connection_id} pour surveiller l'état de la connexion.

`equinixStatus` attribute values	`providerStatus` attribute values	AWS Direct Connect State	Description
`PROVISIONING`	`PROVISIONING`		Connection request has not been sent to AWS yet.
`PROVISIONED`	`PENDING_APPROVAL`	Ordering -> Requested	The connection awaits for acceptance.
`PROVISIONED`	`PROVISIONING`	Pending	Connection establishment in progress.
`PROVISIONED`	`PROVISIONED`	Pending -> Available	The connection has been accepted.

Conditions préalables à l'API​

Connexion à partir d'un port DOT1Q​

Connexion à partir d'un port QINQ​

Connexion à l'aide d'un jeton de service​

Connexion à partir d'un périphérique Network Edge​

Connexion à partir d'un Fabric Cloud Router​

Contrôle de l'état de la connexion​

Conditions préalables à l'API

Connexion à partir d'un port DOT1Q

Connexion à partir d'un port QINQ

Connexion à l'aide d'un jeton de service

Connexion à partir d'un périphérique Network Edge

Connexion à partir d'un Fabric Cloud Router

Contrôle de l'état de la connexion