FIC-Port/FIC-Port(XaaS) - Flexible InterConnect API リファレンス (1.4.0)

Download OpenAPI specification:Download

概要

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

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

Port

List FIC-Port/FIC-Port(XaaS)

ポート情報の一覧を取得します。

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

ポートID

name
string
Example: name=YourPortName

ポート名

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

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

location
string
Example: location=NTTComTokyo(NW1)

データセンター名

switchName
string
Example: switchName=SwitchName

スイッチのエイリアス名

isPublicServiceEndpoint
boolean
Example: isPublicServiceEndpoint=true

XaaS事業者対応フラグ ‘false’(対応なし)または’true’(対応あり)

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

テナント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/ports
https://api.ntt.com/fic-eri/v1/ports

Response samples

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

Create FIC-Port/FIC-Port(XaaS)

Switchを指定してポートを購入します。

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

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

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

リクエストボディのスキーマとサンプル

port
required
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

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

Request samples

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

Response samples

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

Show FIC-Port/FIC-Port(XaaS)

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

path Parameters
portId
required
string ^F[0-9]{12}$
Example: F010123456789

ポート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/ports/{portId}
https://api.ntt.com/fic-eri/v1/ports/{portId}

Response samples

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

Update FIC-Port/FIC-Port(XaaS)

指定したポートを変更します。

path Parameters
portId
required
string ^F[0-9]{12}$
Example: F010123456789

ポート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

VLAN変更の場合、numOfVlans か vlanRanges のどちらかを選択します。

リソース名変更とVLAN変更の同一実行は可能です。

ステータス変更は他の変更との同一実行は不可です。

VLAN利用用途変更は、Port(XaaS)の場合のみ変更可能です。(通常Portは変更不可)

VLAN利用用途変更は他の変更との同一実行は不可です。

port
required
object

VLAN変更の場合、numOfVlans か vlanRanges のどちらかがrequired

・VLAN数を増やす場合、現在使用のVLANはそのままで追加

・VLAN数を減らす場合、現在使用のVLANを減らす

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/ports/{portId}
https://api.ntt.com/fic-eri/v1/ports/{portId}

Request samples

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

Response samples

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

Delete FIC-Port/FIC-Port(XaaS)

指定したポートを廃止します。ただし、コネクションで使用されている場合は廃止出来ません。

また、ステータスがused或いはpreparingの場合は廃止出来ません。

path Parameters
portId
required
string ^F[0-9]{12}$
Example: F010123456789

ポート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/ports/{portId}
https://api.ntt.com/fic-eri/v1/ports/{portId}

Response samples

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

Activate FIC-Port/FIC-Port(XaaS)

指定したポートのアクティベートを実行します。

path Parameters
portId
required
string ^F[0-9]{12}$
Example: F010123456789

ポート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 競合エラー

post/v1/ports/{portId}/activate
https://api.ntt.com/fic-eri/v1/ports/{portId}/activate

Response samples

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