FIC-Connection Azure(Peering Service) - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

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

Router-to-Azure(Peering Service)-Connection

List Router to Azure(Peering Service) Connections

Router to Azure(Peering Service)コネクション情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F030123456789 コネクションID
name	string Example: name=YourConnectionName コネクション名半角英数及び一部記号&()-_ 64文字
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=87e89b8f075a4ee1aa209f6ca6ce242c テナントID
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’
operationStatus	string Enum: "Processing" "Completed" "Cancelled" Example: operationStatus=Completed 処理ステータス 'Processing/Completed/Cancelled'のいずれか
bandwidth	string Enum: "10M" "20M" "30M" "40M" "50M" "100M" "200M" "300M" "400M" "500M" "1G" "2G" "3G" "4G" "5G" "10G" Example: bandwidth=100M 接続帯域 '10M/20M/30M/40M/50M/100M/200M/300M/400M/500M/1G/2G/3G/4G/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

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/router-to-azure-peering-service-connections

https://api.ntt.com/fic-eri/v1/router-to-azure-peering-service-connections

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connections": 
[
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
"area": "JPEAST",
"operationStatus": "Completed",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"enableIn": true,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
]
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee"
},
"bandwidth": "100M"
}
]
}

Create Router to Azure(Peering Service) Connection

始点ルーターおよび終点Azure(Peering Service)を指定し、Router to Azure(Peering Service)コネクションを購入します。

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

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

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/router-to-azure-peering-service-connections

https://api.ntt.com/fic-eri/v1/router-to-azure-peering-service-connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionName",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"enableIn": false,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
]
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee"
},
"bandwidth": "100M"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
"area": "JPEAST",
"operationStatus": "Processing",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"enableIn": false,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
]
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee"
},
"bandwidth": "100M",
"operationId": "03b866d316734e6d9a33a61142437397"
}
}

Show Router to Azure(Peering Service) Connection

指定したRouter to Azure(Peering Service)コネクションの詳細情報を取得します。

path Parameters

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

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/router-to-azure-peering-service-connections/{id}

https://api.ntt.com/fic-eri/v1/router-to-azure-peering-service-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
"area": "JPEAST",
"operationStatus": "Processing",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"enableIn": false,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
]
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee"
},
"bandwidth": "100M"
}
}

Update Router to Azure(Peering Service) Connection

指定したRouter to Azure(Peering Service)コネクションを変更します。各種変更操作は同時実行できます。

path Parameters

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

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/router-to-azure-peering-service-connections/{id}

https://api.ntt.com/fic-eri/v1/router-to-azure-peering-service-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": "F030123456789",
"name": "YourConnectionNameUpdate",
"redundant": true,
"tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
"area": "JPEAST",
"operationStatus": "Processing",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"enableIn": false,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
]
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee"
},
"bandwidth": "200M",
"operationId": "b9ec0743f2e34b28b6353fdbab847659"
}
}

Delete Router to Azure(Peering Service) Connection

指定したRouter to Azure(Peering Service)コネクションを廃止します。

path Parameters

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

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/router-to-azure-peering-service-connections/{id}

https://api.ntt.com/fic-eri/v1/router-to-azure-peering-service-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
"area": "JPEAST",
"operationStatus": "Processing",
"source": 
{"routerId": "F020123456789",
"groupName": "group_1",
"routeFilter": 
{"in": "fullRoute",
"enableIn": false,
"customRoutePrefixIn": 
[
{"address": "100.250.140.0/24",
"filterType": "exact"
},
{"address": "10.0.0.0/8",
"filterType": "orlonger"
}
]
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee"
},
"bandwidth": "100M",
"operationId": "dcd3c5726714494a8469d0ea5784f281"
}
}