Routings - Super OCN Flexible Connect API リファレンス (1.1.0-BGP-1)

Download OpenAPI specification:Download

概要

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

routings

L3 の接続性, トランジット提供 に関する API カテゴリ

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

202

Accepted

post/v1/tenants/{tenantId}/routings
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "customerNote": "Static Routing Dualstack example",
  • "circuitId": "ox0000000000",
  • "ipv4Enabled": true,
  • "ipv6Enabled": true,
  • "healthNotificationEnabled": true,
  • "routingProtocol": "static",
  • "customerIp":
    {
    }
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "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":
    {
    },
  • "customerIp":
    {
    }
}

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

200

OK

get/v1/tenants/{tenantId}/routings
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "routings":
    [
    ]
}

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

200

OK

get/v1/tenants/{tenantId}/routings/{routingId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "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":
    {
    },
  • "customerIp":
    {
    }
}

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

202

Accepted

put/v1/tenants/{tenantId}/routings/{routingId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "ipv6Enabled": true,
  • "customerIp":
    {
    },
  • "bgpRouting":
    {
    }
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "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":
    {
    },
  • "wanIp":
    {
    },
  • "customerIp":
    {
    }
}

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

202

Accepted

delete/v1/tenants/{tenantId}/routings/{routingId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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":
    {
    },
  • "wanIp":
    {
    },
  • "customerIp":
    {
    }
}

orders

申込履歴に関する API カテゴリ

申込履歴情報を一覧参照する 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

200

OK

get/v1/tenants/{tenantId}/routings/{routingId}/orders
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/orders

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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

200

OK

get/v1/tenants/{tenantId}/routings/{routingId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/orders/{orderId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{ }

申込内容に変更を加える 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

202

Accepted

put/v1/tenants/{tenantId}/routings/{routingId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/orders/{orderId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{ }

Response samples

Content type
application/json
Copy
Expand all Collapse all
{ }

指定の申込を取り消す 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

202

Accepted

delete/v1/tenants/{tenantId}/routings/{routingId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/orders/{orderId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{ }

bgp-operations

オペレーションAPI

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

202

Accepted

429

Too Many Requests

put/v1/tenants/{tenantId}/routings/{routingId}/bgp-stats/{addressFamily}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/bgp-stats/{addressFamily}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "operation": "refresh"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/tenants/{tenantId}/routings/{routingId}/bgp-stats/{addressFamily}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/bgp-stats/{addressFamily}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "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

202

Accepted

429

Too Many Requests

put/v1/tenants/{tenantId}/routings/{routingId}/bgp-session/{addressFamily}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/bgp-session/{addressFamily}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "operation": "reset"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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

200

OK

get/v1/tenants/{tenantId}/routings/{routingId}/bgp-session/{addressFamily}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/bgp-session/{addressFamily}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "routingId": "ox0000000000"
}

bgp-filter

BGPの経路フィルタに関する API カテゴリ

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

200

OK

get/v1/tenants/{tenantId}/routings/{routingId}/bgp-filter
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/routings/{routingId}/bgp-filter

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ipv4Prefixes":
    [
    ],
  • "ipv6Prefixes":
    [
    ],
  • "originAutNums":
    [
    ],
  • "updateTime": "2019-05-21T10:05:48+09:00"
}