Documentation Powered by ReDoc

FIC-Router/FIC-Router(XaaS) - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: © NTT Communications Corporation All Rights Reserved.

Flexible InterConnect

概要

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

Routerの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。　

ルータを作成すると、Firewallコンポーネント・NATコンポーネントのIDも同時に払い出されます。 Firewall、NAT は、activate をすると、課金が開始されます。 Routerの学習経路数の上限を変更する事も可能です。

Router

List FIC-Router/FIC-Router(XaaS)

ルータ情報の一覧を取得します。

query Parameters
id
string <uuid> ^F[0-9]{12}$
Example: id=F020123456789

ルータID

tenantId
string ^[0-9a-f]{32}$
Example: tenantId=0dc3a0ff7cbc4f49b7ec70ac6af57104

テナントID

name
string [ 1 .. 64 ] characters
Example: name=YourRouterName

ルータ名

半角英数及び一部記号&()-_ 64文字

area
string
Enum: "JPEAST" "JPWEST"
Example: area=JPEAST

エリア名 ‘JPEAST’または’JPWEST’

isPublicServiceEndpoint
boolean
Example: isPublicServiceEndpoint=true

XaaS事業者対応フラグ

‘false’(対応なし)または’true’(対応あり) (Keyなしで送る場合はサーバ側でfalseとして扱われる)

resourceGroup
string
Example: resourceGroup=FW01-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/routers
https://api.ntt.com/fic-eri/v1/routers

Response samples

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

Create FIC-Router/FIC-Router(XaaS)

ルータを購入します。

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

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

また、FIC-Router(XaaS)に関するサービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

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

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
router
required
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/routers
https://api.ntt.com/fic-eri/v1/routers

Request samples

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

Response samples

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

Show FIC-Router/FIC-Router(XaaS)

指定したルータの詳細情報を取得します。

path Parameters
id
required
string
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/routers/{id}
https://api.ntt.com/fic-eri/v1/routers/{id}

Response samples

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

Update FIC-Router/FIC-Router(XaaS)

指定したルータを変更します。

経路数上限(maxprefix)の変更は、通常Routerのみ可能。Router(Xaas)の場合は変更不可です。

path Parameters
id
required
string
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
router
required
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/routers/{id}
https://api.ntt.com/fic-eri/v1/routers/{id}

Request samples

Content type
application/json
Example
リソース名変更
Copy
 Expand all Collapse all
{
  • "router":
    {
    }
}

Response samples

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

Delete FIC-Router/FIC-Router(XaaS)

指定したルータを廃止します。ただし、コネクションで使用されている場合や、FW/NATがactivateされている場合は廃止出来ません。

path Parameters
id
required
string
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/routers/{id}
https://api.ntt.com/fic-eri/v1/routers/{id}

Response samples

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

コネクション新設制限解除リクエスト

ユーザがコネクション新設制限解除リクエストを行うためのAPI。

このAPI実行時に、Routerの経路数が設定された上限経路数を下回っていた場合、コネクション新設制限が解除されます。

path Parameters
router-id
required
string
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 競合エラー

patch/v1/routers/{router-id}/restriction-release-request
https://api.ntt.com/fic-eri/v1/routers/{router-id}/restriction-release-request

Response samples

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