Documentation Powered by ReDoc

FIC-Connection Router (エリア間接続) - 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 to Routerコネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Router-to-Router-Connection

List Router to Router Connections

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

query Parameters
name
string
Example: name=YourConnectionName

コネクション名

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

tenantId
string
Example: tenantId=db8b0e40743f460685040c46167cf19e

テナントID

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

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

interTenant
boolean
Example: interTenant=false

テナント間接続フラグ

'false'(同テナント)固定

resourceGroup
string
Example: resourceGroup=AI01-jpeast01

故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

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

接続元エリア名

destinationArea
string
Enum: "JPEAST" "JPWEST"
Example: destinationArea=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/v2/router-to-router-connections
https://api.ntt.com/fic-eri/v2/router-to-router-connections

Response samples

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

Create Router to Router Connection

始点ルーターおよび終点ルーターを指定し、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/v2/router-to-router-connections
https://api.ntt.com/fic-eri/v2/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

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

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

Response samples

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

Update Router to Router Connection

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

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

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

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

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

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

Response samples

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