Documentation Powered by ReDoc

FIC-Connection Port (同一テナント内接続/テナント間接続) - 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コネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Port-to-Port-Connection

List Port to Port Connections(同一テナント内接続/テナント間接続)

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

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

コネクションID

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

コネクション名

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

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

テナント間接続フラグ

’true’(テナント間接続)または‘false’(同一テナント内接続)

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
Example
List(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connections":
    [
    ]
}

Create Port to Port Connection(同一テナント内接続/テナント間接続)

始点および終点のポートを指定し、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
required
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
Example
Create(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Response samples

Content type
application/json
Example
Create(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Show Port to Port Connection(同一テナント内接続/テナント間接続)

指定した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
Example
Show(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Update Port to Port Connection(同一テナント内接続/テナント間接続)

指定した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
required
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
Example
Update(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Delete Port to Port Connection(同一テナント内接続/テナント間接続)

指定した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
Example
Delete(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Router-to-Port-Connection

List Router to Port Connections(同一テナント内接続/テナント間接続)

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

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

コネクションID

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

コネクション名

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

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

テナント間接続フラグ

’true’(テナント間接続)または‘false’(同一テナント内接続)

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
Example
List(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connections":
    [
    ]
}

Create Router to Port Connection(同一テナント内接続/テナント間接続)

始点ルーターおよび終点ポートを指定し、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
Example
Create(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Response samples

Content type
application/json
Example
Create(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Show Router to Port Connection(同一テナント内接続/テナント間接続)

指定した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
Example
Show(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Update Router to Port Connection(同一テナント内接続/テナント間接続)

指定した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
リソース名変更
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Response samples

Content type
application/json
Example
Update(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}

Delete Router to Port Connection(同一テナント内接続/テナント間接続)

指定した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
Example
Delete(同一テナント内接続)
Copy
 Expand all Collapse all
{
  • "connection":
    {
    }
}