Documentation Powered by ReDoc

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

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

Port-to-Azure(Microsoft Peering)-Connection

List Port to Azure(Microsoft Peering) Connections

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

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

コネクションID

name
string
Example: name=YourConnectionName

コネクション名

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

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

テナントID

半角英数字32文字

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

Response samples

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

Create Port to Azure(Microsoft Peering) Connection

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

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

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

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/port-to-azure-microsoft-connections
https://api.ntt.com/fic-eri/v1/port-to-azure-microsoft-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 Azure(Microsoft Peering) Connection

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

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

Response samples

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

Update Port to Azure(Microsoft Peering) Connection

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

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/port-to-azure-microsoft-connections/{id}
https://api.ntt.com/fic-eri/v1/port-to-azure-microsoft-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 Azure(Microsoft Peering) Connection

指定したPort to Azure(Microsoft Peering)コネクションを廃止します。

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

Response samples

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

Port-to-Azure(Private Peering)-Connection

List Port to Azure(Private Peering) Connections

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

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

コネクションID

name
string
Example: name=YourConnectionName

コネクション名

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

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

テナントID

半角英数字32文字

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

Response samples

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

Create Port to Azure(Private Peering) Connection

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

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

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

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/port-to-azure-private-connections
https://api.ntt.com/fic-eri/v1/port-to-azure-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 Azure(Private Peering) Connection

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

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

Response samples

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

Update Port to Azure(Private Peering) Connection

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

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/port-to-azure-private-connections/{id}
https://api.ntt.com/fic-eri/v1/port-to-azure-private-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 Azure(Private Peering) Connection

指定したPort to Azure(Private Peering)コネクションを廃止します。

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

Response samples

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

Router-to-Azure(Microsoft Peering)-Connection

List Router to Azure(Microsoft Peering) Connections

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

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

コネクションID

name
string
Example: name=YourConnectionName

コネクション名

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

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

テナントID

半角英数字32文字

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-azure-microsoft-connections
https://api.ntt.com/fic-eri/v1/router-to-azure-microsoft-connections

Response samples

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

Create Router to Azure(Microsoft Peering) Connection

始点ルーターおよび終点Azure(Microsoft Peering)を指定し、Router to Azure(Microsoft Peering)コネクションを購入します。

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

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

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-azure-microsoft-connections
https://api.ntt.com/fic-eri/v1/router-to-azure-microsoft-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 Azure(Microsoft Peering) Connection

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

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

Response samples

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

Update Router to Azure(Microsoft Peering) Connection

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

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-azure-microsoft-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-azure-microsoft-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 Azure(Microsoft Peering) Connection

指定したRouter to Azure(Microsoft Peering)コネクションを廃止します。

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

Response samples

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

Router-to-Azure(Private Peering)-Connection

List Router to Azure(Private Peering) Connections

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

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

コネクションID

name
string
Example: name=YourConnectionName

コネクション名

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

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

テナントID

半角英数字32文字

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-azure-private-connections
https://api.ntt.com/fic-eri/v1/router-to-azure-private-connections

Response samples

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

Create Router To Azure PrivatePeering Connection

始点ルーターおよび終点Azure(Private Peering)を指定し、Router to Azure(Private Peering)コネクションを購入します。

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

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

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-azure-private-connections
https://api.ntt.com/fic-eri/v1/router-to-azure-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 Router to Azure(Private Peering) Connection

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

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

Response samples

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

Update Router to Azure(Private Peering) Connection

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

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-azure-private-connections/{id}
https://api.ntt.com/fic-eri/v1/router-to-azure-private-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 Azure(Private Peering) Connection

指定したRouter to Azure(Private Peering)コネクションを廃止します。

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

Response samples

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