Documentation Powered by ReDoc

FIC-Premium Connection Azure(Peering Service) - Flexible InterConnect API リファレンス (4.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: © NTT DOCOMO BUSINESS, Inc. All Rights Reserved.

Flexible InterConnect

概要

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

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

Premium Router-to-Azure(Peering Service)-Premium Connection

List Premium Router to Azure(Peering Service) Premium Connections

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

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

コネクションID

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

コネクション名

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

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

テナントID

半角英数32文字

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

エリア名 'JPEAST'または'JPWEST'

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

処理ステータス

'Processing/Completed/Cancelled'のいずれか

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

接続帯域

'100M/200M/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/premium-router-to-azure-peering-service-premium-connections
https://api.ntt.com/fic-eri/v1/premium-router-to-azure-peering-service-premium-connections

Response samples

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

Create Premium Router to Azure(Peering Service) Premium Connection

始点プレミアムルーターおよび終点Azure(Peering Service)を指定し、Premium Router to Azure(Peering Service) Premium コネクションを購入します。

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

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

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

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

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

対象コネクション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/premium-router-to-azure-peering-service-premium-connections/{id}
https://api.ntt.com/fic-eri/v1/premium-router-to-azure-peering-service-premium-connections/{id}

Response samples

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

Update Premium Router to Azure(Peering Service) Premium Connection

指定したPremium Router to Azure(Peering Service) Premium コネクションを変更します。

各種変更操作は同時実行できます。

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

対象コネクション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/premium-router-to-azure-peering-service-premium-connections/{id}
https://api.ntt.com/fic-eri/v1/premium-router-to-azure-peering-service-premium-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 Premium Router to Azure(Peering Service) Premium Connection

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

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

対象コネクション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/premium-router-to-azure-peering-service-premium-connections/{id}
https://api.ntt.com/fic-eri/v1/premium-router-to-azure-peering-service-premium-connections/{id}

Response samples

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