FIC-Connection AWS(Private VIF/Transit VIF/Public VIF/Migrated) - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

概要

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

AWS(Private VIF/Transit VIF/Public VIF/Migrated)コネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Router to AWS(Private VIF) Connection Migrated APIについて

Paired Connectionにおいて、接続先の Connecting Point が「Equinix-TY2-M1/@Tokyo-CC2-M1」「Equinix-OS1-M1/Equinix-OS1-M2」に該当している場合は、Router to AWS(Private VIF) Connection Migrated APIをご利用ください。

留意事項および機能制限に関しては、こちらをご参照下さい。

Port-to-AWS(Private VIF)-Connection

List Port to AWS(Private VIF) Connections

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

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’

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

Response samples

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

Create Port to AWS(Private VIF) Connection

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

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

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

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-aws-private-connections
https://api.ntt.com/fic-eri/v2/port-to-aws-private-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 AWS(Private VIF) Connection

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

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

Response samples

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

Update Port to AWS(Private VIF) Connection

指定したPort to Amazon Web Servicesコネクションを変更します。

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
name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9&()-_]{1,64})$

対象コネクション名

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

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

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

Request samples

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

Response samples

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

Delete Port to AWS(Private VIF) Connection

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

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

Response samples

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

Port-to-AWS(Public VIF)-Connection

List Port to AWS(Public VIF) Connections

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

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’

bandwidth
string
Enum: "50M" "100M" "200M" "300M" "400M" "500M" "1G" "2G" "5G" "10G"
Example: bandwidth=1G

接続帯域 ‘50M/100M/200M/300M/400M/500M/1G/2G/5G/10G’のいずれか

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

Response samples

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

Create Port to AWS(Public VIF) Connection