Routings - Super OCN Flexible Connect API リファレンス (1.1.0-BGP-1)
Download OpenAPI specification:Download
Routings リソース 申込 API
Routings リソース 申込 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
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
request body
customerNote | string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容) |
circuitId required | string ^ox[0-9]{10}$ 関連付ける circuit リソースの ID. |
ipv4Enabled required | boolean IPv4 を利用するかどうか |
ipv6Enabled required | boolean IPv6 を利用するかどうか |
healthNotificationEnabled | boolean Default: true routing 健全性に関する通知機能の有効・無効化 |
routingProtocol required | string Enum: "static" "bgp" ルーティングプロトコル |
accessListId | string Nullable ^ox[0-9]{10}$ アクセスリストID nullで送った場合、アクセスリストとの紐付けが解消する |
bgpRouting | object BGP 接続関係の情報 |
customerIp required | object ユーザーのネットワーク内の経路情報 |
Responses
Accepted
Request samples
- Payload
{- "customerNote": "Static Routing Dualstack example",
- "circuitId": "ox0000000000",
- "ipv4Enabled": true,
- "ipv6Enabled": true,
- "healthNotificationEnabled": true,
- "routingProtocol": "static",
- "customerIp": {
- "ipv4CidrType": "ocnAssigned",
- "ipv4CidrIds": [
- "ox4444444444"
], - "ipv6CidrType": "ocnAssigned",
- "ipv6CidrIds": [
- "ox6666666666"
]
}
}
Response samples
- 202
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000001",
- "resourceStatus": "inactive",
- "orderId": "097d4feec2f743f0873c3280b09e75be",
- "orderStatus": "applied",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-21T10:05:48+09:00",
- "customerNote": "project-A 用のリソース",
- "circuitId": "ox0000000000",
- "ipv4Enabled": true,
- "ipv6Enabled": true,
- "healthNotificationEnabled": true,
- "routingProtocol": "static",
- "wanIp": {
- "wanIpv4NetworkAddress": "192.0.2.0/30",
- "providerWanIpv4Address": "192.0.2.1",
- "customerWanIpv4Address": "192.0.2.2",
- "wanIpv6NetworkAddress": "2001:db8:1000::/64",
- "providerWanIpv6Address": "2001:db8:1000::1",
- "customerWanIpv6Address": "2001:db8:1000::2"
}, - "customerIp": {
- "ipv4CidrType": "ocnAssigned",
- "ipv4CidrIds": [
- "ox4444444444"
], - "ipv6CidrType": "ocnAssigned",
- "ipv6CidrIds": [
- "ox6666666666"
]
}
}
Routings リソース 一覧 API
Routings リソース 一覧 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "routings": [
- {
- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000000",
- "resourceStatus": "inactive",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf",
- "orderStatus": "applied",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-21T10:05:48+09:00",
- "serviceStartDate": "2020-01-15",
- "customerNote": "project-A 用のリソース",
- "circuitId": "ox0000000000",
- "ipv4Enabled": true,
- "ipv6Enabled": true,
- "healthNotificationEnabled": true,
- "routingProtocol": "static",
- "accessListId": "ox0000000001",
- "bgpRouting": {
- "asType": "private",
- "priority": "A",
- "routeAdvertisementType": "defaultRoute",
- "ipv4Password": "0123abcdEFGH",
- "ipv6Password": "0123abcdEFGH",
- "providerAsNumber": 4713,
- "customerAsNumber": 55391,
- "providerPeerIpv4Address": "192.0.2.1",
- "customerPeerIpv4Address": "192.0.2.2",
- "providerPeerIpv6Address": "2001:db8:1000::1",
- "customerPeerIpv6Address": "2001:db8:1000::2"
}, - "wanIp": {
- "wanIpv4NetworkAddress": "192.0.2.0/30",
- "providerWanIpv4Address": "192.0.2.1",
- "customerWanIpv4Address": "192.0.2.2",
- "wanIpv6NetworkAddress": "2001:db8:1000::/64",
- "providerWanIpv6Address": "2001:db8:1000::1",
- "customerWanIpv6Address": "2001:db8:1000::2"
}, - "customerIp": {
- "ipv4CidrType": "ocnAssigned",
- "ipv4CidrIds": [
- "ox1234567890"
], - "ipv6CidrType": "ocnAssigned",
- "ipv6CidrIds": [
- "ox1234567890"
]
}
}
]
}
Routings リソース 参照 API
Routings リソース 参照 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000001",
- "resourceStatus": "active",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-21T10:05:48+09:00",
- "serviceStartDate": "2020-01-15",
- "customerNote": "project-A 用のリソース",
- "circuitId": "ox0000000000",
- "ipv4Enabled": true,
- "ipv6Enabled": true,
- "healthNotificationEnabled": true,
- "routingProtocol": "static",
- "wanIp": {
- "wanIpv4NetworkAddress": "192.0.2.0/30",
- "providerWanIpv4Address": "192.0.2.1",
- "customerWanIpv4Address": "192.0.2.2",
- "wanIpv6NetworkAddress": "2001:db8:1000::/64",
- "providerWanIpv6Address": "2001:db8:1000::1",
- "customerWanIpv6Address": "2001:db8:1000::2"
}, - "customerIp": {
- "ipv4CidrType": "ocnAssigned",
- "ipv4CidrIds": [
- "ox4444444444"
], - "ipv6CidrType": "ocnAssigned",
- "ipv6CidrIds": [
- "ox6666666666"
]
}
}
Routings リソース 変更 API
Routings リソース 変更 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
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
request body
customerNote | string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容) |
circuitId | string ^ox[0-9]{10}$ 関連付ける circuit リソースの ID. |
ipv4Enabled | boolean IPv4 を利用するかどうか |
ipv6Enabled | boolean IPv6 を利用するかどうか |
healthNotificationEnabled | boolean Default: true routing 健全性に関する通知機能の有効・無効化 |
routingProtocol | string Enum: "static" "bgp" ルーティングプロトコル |
accessListId | string Nullable ^ox[0-9]{10}$ アクセスリストID nullで送った場合、アクセスリストとの紐付けが解消する |
bgpRouting | object BGP 接続関係の情報 |
customerIp | object ユーザーのネットワーク内の経路情報 |
Responses
Accepted
Request samples
- Payload
{- "ipv6Enabled": true,
- "customerIp": {
- "ipv6CidrType": "ocnAssigned",
- "ipv6CidrIds": [
- "ox6666666666"
]
}, - "bgpRouting": {
- "ipv6Password": "0123abcdEFGH"
}
}
Response samples
- 202
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000001",
- "resourceStatus": "inactive",
- "orderId": "097d4feec2f743f0873c3280b09e75be",
- "orderStatus": "applied",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-21T10:05:48+09:00",
- "customerNote": "Private AS IPv4 only のリソース",
- "circuitId": "ox0000000000",
- "ipv4Enabled": true,
- "ipv6Enabled": true,
- "healthNotificationEnabled": true,
- "routingProtocol": "bgp",
- "bgpRouting": {
- "asType": "private",
- "routeAdvertisementType": "defaultRoute",
- "ipv4Password": "0123abcdEFGH",
- "ipv6Password": "0123abcdEFGH",
- "providerAsNumber": 4713,
- "customerAsNumber": 65510,
- "providerPeerIpv4Address": "192.0.2.1",
- "customerPeerIpv4Address": "192.0.2.2",
- "providerPeerIpv6Address": "2001:db8:1000::1",
- "customerPeerIpv6Address": "2001:db8:1000::2"
}, - "wanIp": {
- "wanIpv4NetworkAddress": "192.0.2.0/30",
- "providerWanIpv4Address": "192.0.2.1",
- "customerWanIpv4Address": "192.0.2.2",
- "wanIpv6NetworkAddress": "2001:db8:1000::/64",
- "providerWanIpv6Address": "2001:db8:1000::1",
- "customerWanIpv6Address": "2001:db8:1000::2"
}, - "customerIp": {
- "ipv4CidrType": "ocnAssigned",
- "ipv4CidrIds": [
- "ox4444444444"
], - "ipv6CidrType": "ocnAssigned",
- "ipv6CidrIds": [
- "ox6666666666"
]
}
}
Routings リソース 削除 API
Routings リソース 削除 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted
Response samples
- 202
{- "tenantId": "f0000000000000000000000000000000",
- "routingId": "ox0000000203",
- "resourceStatus": "active",
- "orderStatus": "applied",
- "orderId": "b849390cd9fc11eabbc136f09c4125a5",
- "creationTime": "2020-08-09T13:51:36+09:00",
- "updateTime": "2020-08-09T13:51:38+09:00",
- "serviceStartDate": "2020-08-09",
- "customerNote": "Routing Test",
- "circuitId": "ox0000000199",
- "ipv4Enabled": true,
- "ipv6Enabled": true,
- "healthNotificationEnabled": true,
- "routingProtocol": "bgp",
- "bgpRouting": {
- "asType": "private",
- "priority": "B",
- "routeAdvertisementType": "defaultRoute",
- "providerAsNumber": 4713,
- "customerAsNumber": 64512,
- "providerPeerIpv4Address": "192.0.6.93",
- "customerPeerIpv4Address": "192.0.6.94",
- "ipv4Password": "qyxA2barMGJW",
- "providerPeerIpv6Address": "2f00:7:0:17::1",
- "customerPeerIpv6Address": "2f00:7:0:17::2",
- "ipv6Password": "UKcN6tvRecQT"
}, - "wanIp": {
- "wanIpv4NetworkAddress": "192.0.6.92/30",
- "providerWanIpv4Address": "192.0.6.93",
- "customerWanIpv4Address": "192.0.6.94",
- "wanIpv6NetworkAddress": "2f00:7:0:17::/64",
- "providerWanIpv6Address": "2f00:7:0:17::1",
- "customerWanIpv6Address": "2f00:7:0:17::2"
}, - "customerIp": {
- "ipv4CidrType": "ocnAssigned",
- "ipv4CidrIds": [
- "ox0000000201"
], - "ipv6CidrType": "ocnAssigned",
- "ipv6CidrIds": [
- "ox0000000202"
]
}
}
申込履歴情報を一覧参照する API
申込履歴情報を一覧参照する API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "orders": [
- { }
]
}
指定の申込履歴情報を参照する API
指定の申込履歴情報を参照する API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
orderId required | string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{ }
申込内容に変更を加える API
申込内容に変更を加える API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
orderId required | string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される |
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
request body
Responses
Accepted
Request samples
- Payload
{ }
Response samples
- 202
{ }
指定の申込を取り消す API
指定の申込を取り消す API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
orderId required | string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted
Response samples
- 202
{ }
OCN 装置から見たBGP送受信経路数を更新する API
OCN装置が送受信しているBGP経路数を取得するAPI 再実行条件: 最後のリクエストの処理が完了しており、かつリクエストから1時間以上間隔を空ける必要がある ただし、BGP セッションリセット実施後はそのタイマーは一度クリアされる。
path Parameters
tenantId required | string ^[a-f0-9]{32}$ Example: 56b15fe666d34926a0fcd0a73c456c11 SSS管理のテナントID |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 サービスリソースのID. 接頭辞 ox + 数字10桁 |
addressFamily required | string Enum: "IPv4" "IPv6" Example: IPv4 IP アドレスバージョン |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
request body
operation required | string Value: "refresh" オペレーション操作内容 |
Responses
Accepted
Too Many Requests
Request samples
- Payload
{- "operation": "refresh"
}
Response samples
- 202
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000000",
- "operation": "refresh",
- "requestTime": "2021-01-18T10:05:48+09:00",
- "status": "processing"
}
OCN 装置から見た BGP 送受信経路数を参照する API
OCN 装置から見た BGP 送受信経路数を参照する API
path Parameters
tenantId required | string ^[a-f0-9]{32}$ Example: 56b15fe666d34926a0fcd0a73c456c11 SSS管理のテナントID |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 サービスリソースのID. 接頭辞 ox + 数字10桁 |
addressFamily required | string Enum: "IPv4" "IPv6" Example: IPv4 IP アドレスバージョン |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000000"
}
BGP セッションリセットを実行するAPI
対象のルーティングリソースの BGP セッションをリセットする API 一度実行すると1時間実行不可。
path Parameters
tenantId required | string ^[a-f0-9]{32}$ Example: 56b15fe666d34926a0fcd0a73c456c11 SSS管理のテナントID |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 サービスリソースのID. 接頭辞 ox + 数字10桁 |
addressFamily required | string Enum: "IPv4" "IPv6" Example: IPv4 IP アドレスバージョン |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
request body
operation required | string オペレーション操作内容 |
Responses
Accepted
Too Many Requests
Request samples
- Payload
{- "operation": "reset"
}
Response samples
- 202
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000000",
- "operation": "reset",
- "requestTime": "2021-01-18T10:05:48+09:00",
- "status": "processing"
}
BGP セッションリセットの実行結果を取得する API
BGP セッションリセットの実行結果を取得する API
path Parameters
tenantId required | string ^[a-f0-9]{32}$ Example: 56b15fe666d34926a0fcd0a73c456c11 SSS管理のテナントID |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 サービスリソースのID. 接頭辞 ox + 数字10桁 |
addressFamily required | string Enum: "IPv4" "IPv6" Example: IPv4 IP アドレスバージョン |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "routingId": "ox0000000000"
}
OCN の経路フィルタ設定状況を参照する API
OCN の経路フィルタ設定状況を参照する API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
routingId required | string ^ox[0-9]{10}$ Example: ox0000000000 サービスリソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "ipv4Prefixes": [
- "192.168.2.0/23",
- "192.168.6.0/23"
], - "ipv6Prefixes": [
- "2001:db8:2::/47",
- "2001:db8:6::/47"
], - "originAutNums": [
- "AS65000",
- "AS65001",
- "AS65002"
], - "updateTime": "2019-05-21T10:05:48+09:00"
}