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

Download OpenAPI specification:Download

Flexible InterConnect

概要

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

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

Port-to-Azure(Microsoft Peering)-Connection

List Port to Azure(Microsoft Peering) Connections

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

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=87e89b8f075a4ee1aa209f6ca6ce242c テナントID
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’

header Parameters

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

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/port-to-azure-microsoft-connections

https://api.ntt.com/fic-eri/v1/port-to-azure-microsoft-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",
"bandwidth": "100M",
"source": 
{"asn": "65530",
"primary": 
{"portId": "F010123456789",
"vlan": 113
},
"secondary": 
{"portId": "F019876543210",
"vlan": 114
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee",
"serviceKey": "6191af11-82f9-4c15-9894-9a69c8f8628a",
"sharedKey": "a8268f8c96a9",
"advertisedPublicPrefixes": 
["100.100.1.1/32",
"100.100.1.2/32",
"100.100.1.3/32"
],
"routingRegistryName": "ARIN"
},
"primaryConnectedNwAddress": "10.10.0.0/30",
"secondaryConnectedNwAddress": "10.20.0.0/30"
}
]
}

Create Port to Azure(Microsoft Peering) Connection

始点ポートおよび終点Azure(Microsoft Peering)を指定し、Port to Azure(Microsoft Peering)コネクションを購入します。

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

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

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/port-to-azure-microsoft-connections

https://api.ntt.com/fic-eri/v1/port-to-azure-microsoft-connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionName",
"source": 
{"primary": 
{"portId": "F010123456789",
"vlan": 113
},
"secondary": 
{"portId": "F019876543210",
"vlan": 114
},
"asn": "65530"
},
"destination": 
{"interconnect": "Tokyo-1",
"serviceKey": "6191af11-82f9-4c15-9894-9a69c8f8628a",
"sharedKey": "a8268f8c96a9",
"qosType": "guarantee",
"advertisedPublicPrefixes": 
["100.100.1.1/32",
"100.100.1.2/32"
],
"routingRegistryName": "APNIC"
},
"bandwidth": "100M",
"primaryConnectedNwAddress": "10.10.0.0/30",
"secondaryConnectedNwAddress": "10.20.0.0/30"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F030123456789",
"name": "YourConnectionName",
"redundant": true,
"tenantId": "87e89b8f075a4ee1aa209f6ca6ce242c",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"asn": "65530",
"primary": 
{"portId": "F010123456789",
"vlan": 113
},
"secondary": 
{"portId": "F019876543210",
"vlan": 114
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee",
"serviceKey": "6191af11-82f9-4c15-9894-9a69c8f8628a",
"sharedKey": "a8268f8c96a9",
"advertisedPublicPrefixes": 
["100.100.1.1/32",
"100.100.1.2/32"
],
"routingRegistryName": "APNIC"
},
"primaryConnectedNwAddress": "10.10.0.0/30",
"secondaryConnectedNwAddress": "10.20.0.0/30",
"operationId": "0c6449e13ad7454ba1d487e7615a2b39"
}
}

Show Port to Azure(Microsoft Peering) Connection

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

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/port-to-azure-microsoft-connections/{id}

https://api.ntt.com/fic-eri/v1/port-to-azure-microsoft-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",
"bandwidth": "100M",
"source": 
{"asn": "65530",
"primary": 
{"portId": "F010123456789",
"vlan": 113
},
"secondary": 
{"portId": "F019876543210",
"vlan": 114
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee",
"serviceKey": "6191af11-82f9-4c15-9894-9a69c8f8628a",
"sharedKey": "a8268f8c96a9",
"advertisedPublicPrefixes": 
["100.100.1.1/32",
"100.100.1.2/32",
"100.100.1.3/32"
],
"routingRegistryName": "ARIN"
},
"primaryConnectedNwAddress": "10.10.0.0/30",
"secondaryConnectedNwAddress": "10.20.0.0/30"
}
}

Update Port to Azure(Microsoft Peering) Connection

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

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

name	string [ 1 .. 64 ] characters ^([a-zA-Z0-9&()-_]{1,64})$ コネクション名半角英数及び一部記号&()-_ 64文字
bandwidth	string Enum: "10M" "20M" "30M" "40M" "50M" "100M" "200M" "300M" "400M" "500M" "1G" "2G" "3G" "4G" "5G" "10G" 接続帯域 ‘10M/20M/30M/40M/50M/100M/200M/300M/400M/500M/1G/2G/3G/4G/5G/10G’のいずれか
destination	object BGPオプション変更(経路変更)

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/port-to-azure-microsoft-connections/{id}

https://api.ntt.com/fic-eri/v1/port-to-azure-microsoft-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",
"bandwidth": "200M",
"source": 
{"asn": "65530",
"primary": 
{"portId": "F010123456789",
"vlan": 113
},
"secondary": 
{"portId": "F019876543210",
"vlan": 114
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee",
"serviceKey": "6191af11-82f9-4c15-9894-9a69c8f8628a",
"sharedKey": "a8268f8c96a9",
"advertisedPublicPrefixes": 
["100.100.1.1/32",
"100.100.1.2/32",
"100.100.1.3/32"
],
"routingRegistryName": "ARIN"
},
"primaryConnectedNwAddress": "10.10.0.0/30",
"secondaryConnectedNwAddress": "10.20.0.0/30",
"operationId": "8f3a27d111714af3b50830ab8a7f81d5"
}
}

Delete Port to Azure(Microsoft Peering) Connection

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

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/port-to-azure-microsoft-connections/{id}

https://api.ntt.com/fic-eri/v1/port-to-azure-microsoft-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",
"bandwidth": "100M",
"source": 
{"asn": "65530",
"primary": 
{"portId": "F010123456789",
"vlan": 113
},
"secondary": 
{"portId": "F019876543210",
"vlan": 114
}
},
"destination": 
{"interconnect": "Tokyo-1",
"qosType": "guarantee",
"serviceKey": "6191af11-82f9-4c15-9894-9a69c8f8628a",
"sharedKey": "a8268f8c96a9",
"advertisedPublicPrefixes": 
["100.100.1.1/32",
"100.100.1.2/32",
"100.100.1.3/32"
],
"routingRegistryName": "ARIN"
},
"primaryConnectedNwAddress": "10.10.0.0/30",
"secondaryConnectedNwAddress": "10.20.0.0/30",
"operationId": "738e3b14255849659e1100c6ca69a872"
}
}

Port-to-Azure(Private Peering)-Connection

List Port to Azure(Private Peering) Connections

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

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=87e89b8f075a4ee1aa209f6ca6ce242c テナントID
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’