Documentation Powered by ReDoc

FIC-Connection (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が提供するリソースの参照・操作が可能です。

Port to Port/Router to Port/Router to Routerコネクション(XaaS接続)と、Router to Virtual Port(XaaS)【Pattern S]/Router to Virtual Port(XaaS)【Pattern X】コネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Port-to-Port-Connection

List Port to Port (XaaS)

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

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

コネクションID

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

コネクション名

tenantId
string ^[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/v2/port-to-port-connections
https://api.ntt.com/fic-eri/v2/port-to-port-connections

Response samples

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

Create Port to Port (XaaS)

始点および終点のポートを指定し、Port to Portコネクションを購入します。

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

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

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
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v2/port-to-port-connections
https://api.ntt.com/fic-eri/v2/port-to-port-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 Port to Port (XaaS)

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

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 認証エラー

403

Forbidden 未検出エラー

404

Not Found 競合エラー

get/v2/port-to-port-connections/{id}
https://api.ntt.com/fic-eri/v2/port-to-port-connections/{id}

Response samples

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

Update Port to Port(XaaS)

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

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
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

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

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

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

Response samples

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

Router-to-Port-Connection

List Router to Port(XaaS)

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

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

コネクションID

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

コネクション名

tenantId
string ^[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’(テナント間接続)

resourceGroup
string
Example: resourceGroup=UR01-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/router-to-port-connections
https://api.ntt.com/fic-eri/v1/router-to-port-connections

Response samples

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

Create Router to Port(XaaS)

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

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

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

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

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

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

Response samples

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

Update Router to Port(XaaS)

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

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

Request samples

Content type
application/json
Example
経路変更(XaaS設定: Med)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Response samples

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

Delete Router to Port(XaaS)

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

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

Response samples

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

Router-to-Router-Connection

List Router to Router(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'(テナント間接続)

resourceGroup
string
Example: resourceGroup=IR01-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/v2/router-to-xaas-router-connections
https://api.ntt.com/fic-eri/v2/router-to-xaas-router-connections

Response samples

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

Create Router to Router(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/v2/router-to-xaas-router-connections
https://api.ntt.com/fic-eri/v2/router-to-xaas-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(XaaS)

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

Response samples

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

Update Router to Router(XaaS)

指定した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-xaas-router-connections/{id}
https://api.ntt.com/fic-eri/v2/router-to-xaas-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(XaaS)

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

Response samples

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

Router-to-Virtual-Port(XaaS)【Pattern S】AWS(Private VIF)

List Router to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)

Router to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)コネクション情報の一覧を取得します。

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

コネクションID

name
string
Example: name=YourConnectionName

コネクション名

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

テナントID

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

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

resourceGroup
string
Example: resourceGroup=CR01-jpeast01

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

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/router-to-virtual-aws-private-connections
https://api.ntt.com/fic-eri/v1/router-to-virtual-aws-private-connections

Response samples

Content type
application/json
Example
List(Single)
Copy
 Expand all Collapse all
{
  • "connections":
    [
    ]
}

Create Router to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)

始点ルーターおよびXaaS事業者のConnecting Pointを指定し、Router to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)コネクションを購入します。 (approvalRequestIdに紐づく承認情報が、承認済みの場合のみ作成可能。)

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

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

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string
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-virtual-aws-private-connections
https://api.ntt.com/fic-eri/v1/router-to-virtual-aws-private-connections

Request samples

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

Response samples

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

Show Router to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)

指定したRouter to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)コネクションの詳細情報を取得します。

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/router-to-virtual-aws-private-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-virtual-aws-private-connections/{id}

Response samples

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

Update Router to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)

指定したRouter to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)コネクションを変更します。

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string
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-virtual-aws-private-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-virtual-aws-private-connections/{id}

Request samples

Content type
application/json
Example
経路変更(Single)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Response samples

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

Delete Router to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)

指定したRouter to Virtual Port(XaaS)【Pattern S】AWS(Private VIF)コネクションを廃止します。

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/router-to-virtual-aws-private-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-virtual-aws-private-connections/{id}

Response samples

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

Router-to-Virtual-Port(XaaS)【Pattern S】SDPF Cloud/Server

List Router to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Server

Router to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Serverコネクション情報の一覧を取得します。

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

コネクションID

name
string
Example: name=YourConnectionName

コネクション名

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

テナントID

operationStatus
string
Enum: "Processing" "Completed" "Cancelled"
Example: operationStatus=Completed

処理ステータス ‘Processing/Completed/Cancelled’のいずれか

bandwidth
string
Enum: "10M" "20M" "30M" "40M" "50M" "100M" "200M" "300M" "400M" "500M" "1G"
Example: bandwidth=100M

接続帯域 '10M/20M/30M/40M/50M/100M/200M/300M/400M/500M/1G/'のいずれか

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

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

resourceGroup
string
Example: resourceGroup=CR01-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/router-to-virtual-ecl-connections
https://api.ntt.com/fic-eri/v1/router-to-virtual-ecl-connections

Response samples

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

Create Router to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Server

始点ルーターおよびXaaS事業者のConnecting Pointを指定し、Router to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Serverコネクションを購入します。 (approvalRequestIdに紐づく承認情報が、承認済みの場合のみ作成可能。)

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

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

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-virtual-ecl-connections
https://api.ntt.com/fic-eri/v1/router-to-virtual-ecl-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 Virtual Port(XaaS)【Pattern S】SDPF Cloud/Server

指定したRouter to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Serverコネクションの詳細情報を取得します。

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

Response samples

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

Update Router to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Server

指定したRouter to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Serverコネクションを変更します。

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/v1/router-to-virtual-ecl-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-virtual-ecl-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 Virtual Port(XaaS)【Pattern S】SDPF Cloud/Server

指定したRouter to Virtual Port(XaaS)【Pattern S】SDPF Cloud/Serverコネクションを廃止します。

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

Response samples

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

Router-to-Virtual-Port(XaaS)【Pattern X】

List Router to Virtual Port(XaaS)【Pattern X】

Router to Virtual Port(XaaS)【Pattern X】コネクション情報の一覧を取得します。

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

コネクションID

name
string
Example: name=YourConnectionName

コネクション名

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

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

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

テナントID

interTenant
boolean

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

resourceGroup
string
Example: resourceGroup=UR01-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/router-to-virtual-port-patternx-connections
https://api.ntt.com/fic-eri/v1/router-to-virtual-port-patternx-connections

Response samples

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

Create Router to Virtual Port(XaaS)【Pattern X】

※このAPIは承認の申請をする際にApproval-Request　のAPIでbody{}の中に記述いただくAPIであり、直接お客様がお使いになられるAPIではございません。

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

画面での操作に関しましてはこちらをご参照下さい。

・Router to Virtual Port(XaaS)【Pattern X】コネクションを購入するに当たって、接続元となるFIC-Routerが必要となります。

<接続までの大まかな流れは以下のとおりです。>

STEP1 作成承認申請

Approval-Request　のAPIに必須となる項目を入力して、接続承認を申請する。

STEP2 承認/否認

接続先XaaS事業者にて承認行為は実施される。

STEP3 作成

承認された時に返ってくるapprovalRequestIdを、Approval-Request　のAPIのExecuteのパス(/v1/approval-requests/{request_id}/execute)に入力し、実行する。

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-virtual-port-patternx-connections
https://api.ntt.com/fic-eri/v1/router-to-virtual-port-patternx-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 Virtual Port(XaaS)【Pattern X】

指定したRouter to Virtual Port(XaaS)【Pattern X】コネクションの詳細情報を取得します。

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

Response samples

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

Update Router to Virtual Port(XaaS)【Pattern X】Connection

※このAPIは承認の申請をする際にApproval-Request　のAPIでbody{}の中に記述いただくAPIであり、直接お客様がお使いになられるAPIではございません。

・Router to Virtual Port(XaaS)【Pattern X】コネクションを変更するに当たって、接続元となるFIC-Routerが必要となります。

<接続までの大まかな流れは以下のとおりです。>

STEP1 作成承認申請

Approval-Request　のAPIに必須となる項目を入力して、接続承認を申請する。

STEP2 承認/否認

接続先XaaS事業者にて承認行為は実施される。

STEP3 作成

承認された時に返ってくるapprovalRequestIdを、Approval-Request　のAPIのExecuteのパス(/v1/approval-requests/{request_id}/execute)に入力し、実行する。

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

Request samples

Content type
application/json
Example
経路変更(XaaS設定: Med)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Response samples

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

Delete Router to Virtual Port(XaaS)【Pattern X】

指定したRouter to Virtual Port(XaaS)【Pattern X】コネクションを廃止します。

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

Response samples

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

Port-Virtual-Ports-PatternX

List Port Virtual Ports PatternX

指定したFIC-Port(XaaS)に紐づくVirtual Port(XaaS)【Pattern X】の件数一覧、及び、Virtual Port(XaaS)【Pattern X】の詳細情報を取得します。

path Parameters
port_id
required
string
query Parameters
tenantId
string ^[0-9a-f]{32}$
Example: tenantId=db8b0e40743f460685040c46167cf19e

テナント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 認証エラー

409

Conflict 競合エラー

get/v1/port-virtual-ports-patternx/{port_id}
https://api.ntt.com/fic-eri/v1/port-virtual-ports-patternx/{port_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "virtualPortsPatternX":
    [
    ],
  • "allocatedBandwidth": "20G"
}