2つのサービス・トークンを使った接続
サービス・トークンで事前に定義された情報を使用して、アセットまたはサードパーティ間の接続を確立できます。サービス・トークンは、接続のAサイドとZサイドの両方に対して発行できます。
たとえば、aサイドのサービス・トークンで定義されたオリジンから、zサイドのサービス・トークンで定義されたデスティネーションへの接続を作成できます。
前提条件
-
Authenticate - OAuth2認証のためのユーザー認証情報、クライアントID、クライアントシークレットを送信します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API Authenticationを参照してください。
-
プロバイダからA側サービス・トークンの詳細を取得します。
-
プロバイダからサイド・サービス・トークンの詳細を取得します。
この情報は、接続作成APIを呼び出すために必要です。
A サイドから Z サイドへの接続を作成する サービストークン
Service Tokens との接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。リクエストの本文には、サイドとゾーンのサービス・トークンの詳細を指定します。
サービストークンは、複数の受信者に送信することができ、どの受信者も1回だけ使用することができます。
| 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 |
接続を作成せずに本番環境でこのリクエストを安全に検証するには、［本番環境でのテスト（APIドライラン）］（../../equinix-api/testing/testing-in-production-dry-run.md）を参照してください。
サンプル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": "AST_TO_ZST_CONNECTION",
"order": {
"purchaseOrderNumber": "1-129105284100" },
"bandwidth": 100,
"redundancy": {
"priority": "PRIMARY" },
"aSide": {
"serviceToken": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5" }
},
"zSide": {
"serviceToken": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5" }
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com" ]
}
]
}'
リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。
回答例
{
"href": "https://api.equinix.com/fabric/v4/connections/b067f685-49b0-1a09-6fe0-360a5d00a",
"type": "EVPL_VC",
"uuid": "b067f685-49b0-1a09-6fe0-360a5d00a",
"name": "AST_TO_ZST_CONNECTION",
"state": "ACTIVE",
"operation": {
"providerStatus": "PROVISIONED",
"equinixStatus": "PROVISIONED" },
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com" ]
}
],
"account": {
"accountNumber": 201246,
"orgId": 92610,
"globalOrgId": "0017i000011X250AAC" },
"changeLog": {
"createdBy": "testuser",
"createdDateTime": "2022-05-16T07:50:49.749Z" },
"bandwidth": 100,
"redundancy": {
"group": "b067f685-49b0-1a09-6fe0-360a5d00afdg",
"priority": "PRIMARY" },
"isRemote": true,
"direction": "OUTGOING",
"aSide": {
"serviceToken": {
"href": "https://api.equinix.com/fabric/v4/serviceTokens/b067f685-49b0-1a09-6fe0-360a5d00afdg",
"uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg" },
"accessPoint": {
"location": {
"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV" },
"port": {
"href": "https://api.equinix.com/fabric/v4/ports/b067f685-49b0-1a09-6fe0-360a5d00afdg",
"uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg" },
"linkProtocol": {
"type": "DOT1Q" }
}
},
"zSide": {
"serviceToken": {
"href": "https://api.equinix.com/fabric/v4/serviceTokens/b067f685-49b0-1a09-6fe0-360a5d00afdg",
"uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg" },
"accessPoint": {
"location": {
"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV" },
"port": {
"href": "https://api.equinix.com/fabric/v4/ports/b067f685-49b0-1a09-6fe0-360a5d00afdg",
"uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg" },
"linkProtocol": {
"type": "DOT1Q" }
}
},
"order": {
"purchaseOrderNumber": "1122334",
"billingTier": "Up to 50 MB" }
}
レスポンスペイロードには、リクエストボディで定義された設定パラメータが含まれます。使用可能なパラメータの一覧とその説明については、API リファレンス を参照してください。
接続の監視
接続ステータスを監視するには、Get Specified Connection エンドポイントを使用します。