FIC-Connection AWS(Private VIF/Transit VIF/Public VIF/Migrated) - Flexible InterConnect API リファレンス (2.0.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
AWS(Private VIF/Transit VIF/Public VIF/Migrated)コネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。
Paired Connectionにおいて、接続先の Connecting Point が「Equinix-TY2-M1/@Tokyo-CC2-M1」「Equinix-OS1-M1/Equinix-OS1-M2」に該当している場合は、Router to AWS(Private VIF) Connection Migrated APIをご利用ください。
留意事項および機能制限に関しては、こちらをご参照下さい。
List Port to AWS(Private VIF) Connections
Port to Amazon Web Servicesコネクション情報の一覧を取得します。
query Parameters
id | string ^F[0-9]{12}$ Example: id=F030123456789 コネクションID |
name | string Example: name=YourConnectionName コネクション名 半角英数及び一部記号&()-_ 64文字 |
tenantId | string <uuid> ^[0-9a-f]{32}$ Example: tenantId=87e89b8f075a4ee1aa209f6ca6ce242c テナントID |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Response samples
- 200
{- "connections": [
- {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "portId": "F010123456789",
- "vlan": 113
}, - "destination": {
- "interconnect": "@Tokyo-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}
}
]
}
Create Port to AWS(Private VIF) Connection
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
connection required | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionName",
- "bandwidth": "100M",
- "source": {
- "portId": "F010123456789",
- "vlan": 113
}, - "destination": {
- "interconnect": "@Tokyo-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}
}
}
Response samples
- 202
{- "connection": {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "portId": "F010123456789",
- "vlan": 113
}, - "destination": {
- "interconnect": "@Tokyo-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "operationId": "75f4cad2afcc436ebe3039275cdf0a7e"
}
}
Show Port to AWS(Private VIF) Connection
指定したPort to Amazon Web Servicesコネクションの詳細情報を取得します。
path Parameters
id required | string 対象コネクションID |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 200
{- "connection": {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "portId": "F010123456789",
- "vlan": 113
}, - "destination": {
- "interconnect": "@Tokyo-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}
}
}
Update Port to AWS(Private VIF) Connection
指定したPort to Amazon Web Servicesコネクションを変更します。
path Parameters
id required | string 対象コネクションID |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
connection required | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "connection": {
- "name": "YourConnectionNameUpdate"
}
}
Response samples
- 202
{- "connection": {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "portId": "F010123456789",
- "vlan": 113
}, - "destination": {
- "interconnect": "@Tokyo-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "operationId": "934165e7e3cc483d9cc2248c78614337"
}
}
Delete Port to AWS(Private VIF) Connection
指定したPort to Amazon Web Servicesコネクションを廃止します。
path Parameters
id required | string 対象コネクションID |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 202
{- "connection": {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "portId": "F010123456789",
- "vlan": 113
}, - "destination": {
- "interconnect": "@Tokyo-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "operationId": "5198439df3414296bde8babdac3b705a"
}
}
List Port to AWS(Public VIF) Connections
Port to Amazon Web Servicesコネクション情報の一覧を取得します。
query Parameters
id | string ^F[0-9]{12}$ Example: id=F030123456789 コネクションID |
name | string Example: name=YourConnectionName コネクション名 半角英数及び一部記号&()-_ 64文字 |
tenantId | string <uuid> ^[0-9a-f]{32}$ Example: tenantId=87e89b8f075a4ee1aa209f6ca6ce242c テナントID |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
bandwidth | string Enum: "50M" "100M" "200M" "300M" "400M" "500M" "1G" "2G" "5G" "10G" Example: bandwidth=1G 接続帯域 ‘50M/100M/200M/300M/400M/500M/1G/2G/5G/10G’のいずれか |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Response samples
- 200
{- "connections": [
- {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "portId": "F010123456789",
- "vlan": 113
}, - "destination": {
- "interconnect": "@Tokyo