FIC-Premium Connection AWS(Private VIF/Public VIF/Transit VIF) - Flexible InterConnect API リファレンス (18.5)

Download OpenAPI specification:Download

Flexible InterConnect

概要

本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。

Premium Router to AWS(Private VIF/Public VIF/Transit VIF) Premium コネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Premium Router-to-AWS(Private VIF)-Premium Connection

List Premium Router to AWS(Private VIF) Premium Connections

Premium Router to Amazon Web Services(Private VIF) Premium コネクション情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F930123456789 コネクションID
name	string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名半角英数及び一部記号&()-_ 64文字
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 'JPEAST'または'JPWEST'
resourceGroup	string Example: resourceGroup=PCR01-jpeast02 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/premium-router-to-aws-private-premium-connections

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-private-premium-connections

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connections": 
[
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "”65515\""
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
}
}
]
}

Create Premium Router to AWS(Private VIF) Premium Connection

始点プレミアムルーターおよび終点Amazon Web Services(Private VIF)を指定し、Premium Router to Amazon Web Services(Private VIF) Premium コネクションを購入します。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客さまにご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/premium-router-to-aws-private-premium-connections

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-private-premium-connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionName",
"bandwidth": "100M",
"source": 
{"routerId": "F920123456789",
"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": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": null,
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Show Premium Router to AWS(Private VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Private VIF) Premium コネクションの詳細情報を取得します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/premium-router-to-aws-private-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-private-premium-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
}
}
}

Update Premium Router to AWS(Private VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Private VIF) Premium コネクションを変更します。

各種変更操作は同時実行できます。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクション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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/premium-router-to-aws-private-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-private-premium-connections/{id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionNameUpdate"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Delete Premium Router to AWS(Private VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Private VIF) Premium コネクションを廃止します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/premium-router-to-aws-private-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-private-premium-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Update Premium Router to AWS(Private VIF) Premium Connection Priority

指定したPremium Router to Amazon Web Services(Private VIF) Premium コネクションのPriortyを変更します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクション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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/premium-router-to-aws-private-premium-connections/{id}/priority

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-private-premium-connections/{id}/priority

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"source": 
{"priority": 
{"active": "secondary"
}
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "secondary",
"startTime": "2026-03-01T06:48:00Z"
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Premium Router-to-AWS(Public VIF)-Premium Connection

List Premium Router to AWS(Public VIF) Premium Connections

Premium Router to Amazon Web Services(Public VIF) Premium コネクション情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F930123456789 コネクションID
name	string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名半角英数及び一部記号&()-_ 64文字
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 'JPEAST'または'JPWEST'
resourceGroup	string Example: resourceGroup=PCR01-jpeast02 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/premium-router-to-aws-public-premium-connections

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-public-premium-connections

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connections": 
[
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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": "natRoute"
},
"primary": 
{"asPathPrepend": 
{"out": null
}
},
"secondary": 
{"asPathPrepend": 
{"out": 1
}
},
"community": 
{"out": "7224:9100"
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012",
"advertisedPublicPrefixes": 
["123.1.0.0/32",
"123.1.1.0/32"
],
"awsAccountName": "aaabbb"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
}
}
]
}

Create Premium Router to AWS(Public VIF) Premium Connection

始点プレミアムルーターおよび終点Amazon Web Services(Public VIF)を指定し、Premium Router to Amazon Web Services(Public VIF) Premium コネクションを購入します。

コネクション購入後のステップとして、証明書(LOA)が必要となるため、ダウンロードしてください。

証明書(LOA)のAPIの詳細に関しましてはこちらのページをご参照ください。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客さまにご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/premium-router-to-aws-public-premium-connections

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-public-premium-connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionName",
"bandwidth": "100M",
"source": 
{"routerId": "F920123456789",
"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": "natRoute"
},
"primary": 
{"asPathPrepend": 
{"out": null
}
},
"secondry": 
{"asPathPrepend": 
{"out": 1
}
},
"community": 
{"out": "7224:9100"
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1"
},
"qosType": "guarantee",
"awsAccountId": "123456789012",
"advertisedPublicPrefixes": 
["123.1.0.0/32",
"123.1.1.0/32"
],
"awsAccountName": "aaabbb"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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": "natRoute"
},
"primary": 
{"asPathPrepend": 
{"out": null
}
},
"secondary": 
{"asPathPrepend": 
{"out": 1
}
},
"community": 
{"out": "7224:9100"
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012",
"advertisedPublicPrefixes": 
["123.1.0.0/32",
"123.1.1.0/32"
],
"awsAccountName": "aaabbb"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Show Premium Router to AWS(Public VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Public VIF) Premium コネクションの詳細情報を取得します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/premium-router-to-aws-public-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-public-premium-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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": "natRoute"
},
"primary": 
{"asPathPrepend": 
{"out": null
}
},
"secondary": 
{"asPathPrepend": 
{"out": 1
}
},
"community": 
{"out": "7224:9100"
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012",
"advertisedPublicPrefixes": 
["123.1.0.0/32",
"123.1.1.0/32"
],
"awsAccountName": "aaabbb"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
}
}
}

Update Premium Router to AWS(Public VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Public VIF) Premium コネクションを変更します。

各種変更操作は同時実行できます。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクション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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/premium-router-to-aws-public-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-public-premium-connections/{id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionNameUpdate"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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": "natRoute"
},
"primary": 
{"asPathPrepend": 
{"out": null
}
},
"secondary": 
{"asPathPrepend": 
{"out": 1
}
},
"community": 
{"out": "7224:9100"
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012",
"advertisedPublicPrefixes": 
["123.1.0.0/32",
"123.1.1.0/32"
],
"awsAccountName": "aaabbb"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Delete Premium Router to AWS(Public VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Public VIF) Premium コネクションを廃止します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/premium-router-to-aws-public-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-public-premium-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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": "natRoute"
},
"primary": 
{"asPathPrepend": 
{"out": null
}
},
"secondary": 
{"asPathPrepend": 
{"out": 1
}
},
"community": 
{"out": "7224:9100"
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012",
"advertisedPublicPrefixes": 
["123.1.0.0/32",
"123.1.1.0/32"
],
"awsAccountName": "aaabbb"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Update Premium Router to AWS(Public VIF) Premium Connection Priority

指定したPremium Router to Amazon Web Services(Public VIF) Premium コネクションのPriortyを変更します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクション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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/premium-router-to-aws-public-premium-connections/{id}/priority

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-public-premium-connections/{id}/priority

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"source": 
{"priority": 
{"active": "secondary"
}
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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": "natRoute"
},
"primary": 
{"asPathPrepend": 
{"out": null
}
},
"secondary": 
{"asPathPrepend": 
{"out": 1
}
},
"community": 
{"out": "7224:9100"
},
"priority": 
{"active": "primary",
"startTime": "2026-03-01T06:48:00Z"
}
},
"destination": 
{"primary": 
{"interconnect": "Equinix-TY2-1",
"asn": "65515"
},
"secondary": 
{"interconnect": "@Tokyo-CC2-1",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012",
"advertisedPublicPrefixes": 
["123.1.0.0/32",
"123.1.1.0/32"
],
"awsAccountName": "aaabbb"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Premium Router-to-AWS(Transit VIF)-Premium Connection

List Premium Router to AWS(Transit VIF) Premium Connections

Premium Router to Amazon Web Services(Transit VIF) Premium コネクション情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F930123456789 コネクションID
name	string [ 1 .. 64 ] characters Example: name=YourConnectionName コネクション名半角英数及び一部記号&()-_ 64文字
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=db8b0e40743f460685040c46167cf19e テナントID 半角英数32文字
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 'JPEAST'または'JPWEST'
resourceGroup	string Example: resourceGroup=CR01-jpeast01 故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/premium-router-to-aws-transit-premium-connections

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-transit-premium-connections

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connections": 
[
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "TY2",
"asn": "65515"
},
"secondary": 
{"interconnect": "CC2",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
}
}
]
}

Create Premium Router to AWS(Transit VIF) Premium Connection

始点プレミアムルーターおよび終点Amazon Web Services(Transit VIF)を指定し、Premium Router to Amazon Web Services(Transit VIF) Premium コネクションを購入します。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客さまにご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/premium-router-to-aws-transit-premium-connections

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-transit-premium-connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionName",
"bandwidth": "100M",
"source": 
{"routerId": "F920123456789",
"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": "TY2",
"asn": "65515"
},
"secondary": 
{"interconnect": "CC2",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "TY2",
"asn": "65515"
},
"secondary": 
{"interconnect": "CC2",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": null,
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Show Premium Router to AWS(Transit VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Transit VIF) Premium コネクションの詳細情報を取得します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/premium-router-to-aws-transit-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-transit-premium-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Completed",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "TY2",
"asn": "65515"
},
"secondary": 
{"interconnect": "CC2",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
}
}
}

Update Premium Router to AWS(Transit VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Transit VIF) Premium コネクションを変更します。

各種変更操作は同時実行できます。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクション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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/premium-router-to-aws-transit-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-transit-premium-connections/{id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionNameUpdate"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourPremiumConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "TY2",
"asn": "65515"
},
"secondary": 
{"interconnect": "CC2",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Delete Premium Router to AWS(Transit VIF) Premium Connection

指定したPremium Router to Amazon Web Services(Transit VIF) Premium コネクションを廃止します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクションID

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/premium-router-to-aws-transit-premium-connections/{id}

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-transit-premium-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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
}
},
"priority": 
{"active": "primary",
"startTime": null
}
},
"destination": 
{"primary": 
{"interconnect": "TY2",
"asn": "65515"
},
"secondary": 
{"interconnect": "CC2",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}

Update Premium Router to AWS(Transit VIF) Premium Connection Priority

指定したPremium Router to Amazon Web Services(Transit VIF) Premium コネクションのPriortyを変更します。

path Parameters

required

string ^F[0-9]{12}$

Example: F930123456789

対象コネクション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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/premium-router-to-aws-transit-premium-connections/{id}/priority

https://api.ntt.com/fic-eri/v1/premium-router-to-aws-transit-premium-connections/{id}/priority

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"source": 
{"priority": 
{"active": "secondary"
}
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F930123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "db8b0e40743f460685040c46167cf19e",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"tenantId": "db8b0e40743f460685040c46167cf19e",
"routerId": "F920123456789",
"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": 
{"primary": null,
"asPathPrepend": 
{"out": null
}
},
"secondary": 
{"asPathPrepend": 
{"out": 1
}
},
"priority": 
{"active": "secondary",
"startTime": "2026-03-01T06:48:00Z"
}
},
"destination": 
{"primary": 
{"interconnect": "TY2",
"asn": "65515"
},
"secondary": 
{"interconnect": "CC2",
"asn": "65515"
},
"qosType": "guarantee",
"awsAccountId": "123456789012"
},
"primaryConnectedNwAddress": "10.0.0.0/30",
"secondaryConnectedNwAddress": "10.0.1.0/30",
"resourceGroup": 
{"source": "PCR01-jpeast02",
"destination": null
},
"operationId": "2fb5baa5a5834e0b952d3f0d93c3e64a"
}
}