Router to Router Connection(XaaS) - Flexible InterConnect API リファレンス (1.4.0)

Download OpenAPI specification:Download

Flexible InterConnect > Connection-XaaS > Router to Router Connection(XaaS)

概要

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

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

※最新のAPIはv2にバージョンアップしておりますが、旧v1のAPIは2022年10月末までお使い頂けます。

また、旧v1/router-to-router-connectionsはXaaS接続のもので、v2/router-to-router-connectionsはエリア間接続のAPIとなります。

最新のRouter to Router コネクション(XaaS)を購入・参照・変更・廃止等の操作をする際には、v2/router-to-xaas-router-connectionsのAPIをご利用下さい。

Router-to-Router-Connection

List Router to Router Connections(XaaS)

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

query Parameters
id
string ^F[0-9]{12}$
Example: id=F031900000001

コネクションID

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

コネクション名

tenantId
string <uuid> ^[0-9a-f]{32}$
Example: tenantId=db8b0e40743f460685040c46167cf19e

テナントID

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

エリア名 'JPEAST'または'JPWEST'

interTenant
boolean
Example: interTenant=true

テナント間接続フラグ 'false'(同テナント)または'true'(テナント間接続)

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-router-connections
https://api.ntt.com/fic-eri/v1/router-to-router-connections

Response samples

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

Create Router to Router Connection(XaaS)

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

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

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

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-router-connections
https://api.ntt.com/fic-eri/v1/router-to-router-connections

Request samples

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

Response samples

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

Show Router to Router Connection(XaaS)

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

path Parameters
id
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-router-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-router-connections/{id}

Response samples

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

Update Router to Router Connection(XaaS)

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

path Parameters
id
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-router-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-router-connections/{id}

Request samples

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

Response samples

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

Delete Router to Router Connection(XaaS)

指定したRouter to Routerコネクションを廃止します。

path Parameters
id
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-router-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-router-connections/{id}

Response samples

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