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(Private VIF)コネクション情報の一覧を取得します。
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 半角英数32文字 |
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(Private VIF)コネクションの詳細情報を取得します。
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(Private VIF)コネクションを変更します。
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(Private VIF)コネクションを廃止します。
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(Public VIF)コネクション情報の一覧を取得します。
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 半角英数32文字 |
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-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}
}
]
}
Create Port to AWS(Public 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(Public VIF) Connection
指定したPort to Amazon Web Services(Public VIF)コネクションの詳細情報を取得します。
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(Public VIF) Connection
指定したPort to Amazon Web Services(Public VIF)コネクションを変更します。
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(Public VIF) Connection
指定したPort to Amazon Web Services(Public VIF)コネクションを廃止します。
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(Transit VIF) Connections
Port to Amazon Web Services(Transit VIF)コネクション情報の一覧を取得します。
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 半角英数32文字 |
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-CC2-2",
- "qosType": "guarantee",
- "awsAccountId": "123456789012"
}
}
]
}
Create Port to AWS(Transit 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(Transit VIF) Connection
指定したPort to Amazon Web Services(Transit VIF)コネクションの詳細情報を取得します。
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(Transit VIF) Connection
指定したPort to Amazon Web Services(Transit VIF)コネクションを変更します。
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": "YourConnectionNameUpdate",
- "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(Transit VIF) Connection
指定したPort to Amazon Web Services(Transit VIF)コネクションを廃止します。
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 Router to AWS(Private VIF) Connections
Router to Amazon Web Services(Private VIF)コネクション情報の一覧を取得します。
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=06a90740d6764465896091b1f0676048 テナントID 半角英数32文字 |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
resourceGroup | string Example: resourceGroup=CR01-jpeast01 Connectionの接続元のDcim Device(ccraのprimary)に付与されているResource Group名 |
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": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}
}
]
}
Create Router to AWS(Private VIF) Connections
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": {
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30"
}
}
Response samples
- 202
{- "connection": {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": null,
- "destination": null
}, - "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Show Router to AWS(Private VIF) Connection
指定したRouter to Amazon Web Services(Private VIF)コネクションの詳細情報を取得します。
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": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}
}
}
Update Router to AWS(Private VIF) Connection
指定したRouter to Amazon Web Services(Private VIF)コネクションを変更します。各種変更操作は同時実行できます。
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": "YourConnectionNameUpdate",
- "redundant": false,
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}, - "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Delete Router to AWS(Private VIF) Connection
指定したRouter to Amazon Web Services(Private VIF)コネクションを廃止します。
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": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}, - "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
List Router to AWS(Public VIF) Connections
Router to Amazon Web Services(Public VIF)コネクション情報の一覧を取得します。
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=06a90740d6764465896091b1f0676048 テナントID 半角英数32文字 |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
resourceGroup | string Example: resourceGroup=CR01-jpeast01 Connectionの接続元のDcim Device(ccraのprimary)に付与されているResource Group名 |
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": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "noRoute"
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}, - "community": {
- "out": "7224:9100"
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}
}
]
}
Create Router to AWS(Public 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": {
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "noRoute"
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}, - "community": {
- "out": "7224:9100"
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}
}
}
Response samples
- 202
{- "connection": {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "noRoute"
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}, - "community": {
- "out": "7224:9100"
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": null
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": null,
- "resourceGroup": {
- "source": null,
- "destination": null
}, - "operationId": "87e89b8f075a4ee1aa209f6ca6ce000"
}
}
Show Router to AWS(Public VIF) Connection
指定したRouter to Amazon Web Services(Public VIF)コネクションの詳細情報を取得します。
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",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "noRoute"
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}, - "community": {
- "out": "7224:9100"
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}
}
}
Update Router to AWS(Public VIF) Connection
指定したRouter to Amazon Web Services(Public VIF)コネクションを変更します。各種変更操作は同時実行できます。
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",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "noRoute"
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}, - "community": {
- "out": "7224:9100"
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}, - "operationId": "87e89b8f075a4ee1aa209f6ca6ce000"
}
}
Delete Router to AWS(Public VIF) Connection
指定したRouter to Amazon Web Services(Public VIF)コネクションを廃止します。
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",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "customRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "noRoute"
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}, - "community": {
- "out": "7224:9100"
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012",
- "advertisedPublicPrefixes": [
- "100.131.66.79/32",
- "100.131.66.80/32"
], - "awsAccountName": "aaabbb"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}, - "operationId": "87e89b8f075a4ee1aa209f6ca6ce000"
}
}
List Router to AWS(Transit VIF) Connections
Router to Amazon Web Services(Transit VIF)コネクション情報の一覧を取得します。
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=06a90740d6764465896091b1f0676048 テナントID 半角英数32文字 |
resourceGroup | string Example: resourceGroup=CR01-jpeast01 Connectionの接続元のDcim Device(ccraのprimary)に付与されているResource Group名 |
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": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}
}
]
}
Create Router to AWS(Transit 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": {
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30"
}
}
Response samples
- 202
{- "connection": {
- "id": "F030123456789",
- "name": "YourConnectionName",
- "redundant": false,
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": null,
- "destination": null
}, - "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Show Router to AWS(Transit VIF) Connection
指定したRouter to Amazon Web Services(Transit VIF)コネクションの詳細情報を取得します。
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": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}
}
}
Update Router to AWS(Transit VIF) Connection
指定したRouter to Amazon Web Services(Transit VIF)コネクションを変更します。各種変更操作は同時実行できます。
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": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}, - "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Delete Router to AWS(Transit VIF) Connection
指定したRouter to Amazon Web Services(Transit VIF)コネクションを廃止します。
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": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "in": null,
- "out": null
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "resourceGroup": {
- "source": "CR01-jpeast01",
- "destination": null
}, - "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
List Router to AWS(Private VIF) Connection Migrated
移行済みのRouter to Amazon Web Services(Private VIF)コネクション情報の一覧を取得します。
query Parameters
id | string ^F[0-9]{12}$ Example: id=F030123456789 コネクションID |
name | string Example: name=YourConnectionName コネクション名 |
tenantId | string <uuid> ^[0-9a-f]{32}$ Example: tenantId=06a90740d6764465896091b1f0676048 テナントID 半角英数32文字 |
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": true,
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "secondary": {
- "interconnect": "Equinix-TY2-2",
- "asn": "65515",
- "qosType": "guarantee"
}, - "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30"
}
]
}
Show Router to AWS(Private VIF) Connection Migrated
指定した移行済みのRouter to Amazon Web Services(Private VIF)コネクションの詳細情報を取得します。
path Parameters
id required | string |
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": true,
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "secondary": {
- "interconnect": "Equinix-TY2-2",
- "asn": "65515"
}, - "qosType": "guarantee",
- "awsAccountId": "123456789012"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30"
}
}
Update Router to AWS(Private VIF) Connection Migrated
指定した移行済みのRouter to Amazon Web Services(Private VIF)コネクションを変更します。各種変更操作は同時実行できます。
path Parameters
id required | string |
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": "YourConnectionNameUpdate",
- "redundant": true,
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "secondary": {
- "interconnect": "Equinix-TY2-2",
- "asn": "65515"
}, - "awsAccountId": "123456789012",
- "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Delete Router to AWS(Private VIF) Connection Migrated
指定した移行済みのRouter to Amazon Web Services(Private VIF)コネクションを廃止します。
path Parameters
id required | string |
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": true,
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "bandwidth": "100M",
- "source": {
- "tenantId": "f123f45c183d5cd5aca12fabc1cebc72",
- "routerId": "F020123456789",
- "groupName": "group_1",
- "routeFilter": {
- "in": "fullRoute",
- "prefixInType": "permit",
- "maxBgpPrefixListIn": 10,
- "customRoutePrefixIn": [
- {
- "address": "100.250.140.0/24",
- "filterType": "exact"
}, - {
- "address": "10.0.0.0/8",
- "filterType": "orlonger"
}
], - "out": "fullRouteWithDefaultRoute",
- "prefixOutType": "permit",
- "maxBgpPrefixListOut": 10,
- "customRoutePrefixOut": [
- {
- "address": "110.0.3.0/24",
- "filterType": "orlonger"
}, - {
- "address": "172.16.0.0/16",
- "filterType": "exact"
}, - {
- "address": "0.0.0.0/0",
- "filterType": "exact"
}
]
}, - "primary": {
- "asPathPrepend": {
- "out": null
}
}, - "secondary": {
- "asPathPrepend": {
- "out": 1
}
}
}, - "destination": {
- "primary": {
- "interconnect": "Equinix-TY2-1",
- "asn": "65515"
}, - "secondary": {
- "interconnect": "Equinix-TY2-2",
- "asn": "65515"
}, - "awsAccountId": "123456789012",
- "qosType": "guarantee"
}, - "primaryConnectedNwAddress": "10.0.0.0/30",
- "secondaryConnectedNwAddress": "10.0.1.0/30",
- "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}