Documentation Powered by ReDoc

FIC接続API (1.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2023 NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

概要

本APIでは、docomo business RINKのFIC接続リソース情報の参照・操作が可能です。

ficConnections

FIC接続リソース一覧取得API

FIC接続リソースを一覧取得するAPI

query Parameters
resourceStatus
string
Enum: "inactive" "active" "terminated"

リソースステータス

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

User Found

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/fic-connections
http://api.ntt.com/sdpf-ztgict/v1/fic-connections

Response samples

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

FIC接続リソース作成API

FIC接続リソースを作成するAPI

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
vpnId
required
string ^Z[0-9]{9}$

VPNリソースに一意に与えられるID。docomo business RINKではリソースに対して大文字Zから始まる残り数字9桁の10桁の番号を付与する。Z番号と呼ぶ。

customerNote
required
string <= 64 characters

FIC接続名 (全角・半角・記号許容)

routeAdvertisement
required
string
Default: "fullRoute"
Enum: "fullRoute" "privateAll" "defaultRoute"

FIC側への経路広告方法

  • fullRoute: VPN 側の経路をそのまま広告
  • privateAll: プライベートIPアドレスレンジ (192.168.0.0/16, 172.16.0.0/12, 10.0.0.0/8) を広告
  • defaultRoute: 0.0.0.0/0 を広告

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/fic-connections
http://api.ntt.com/sdpf-ztgict/v1/fic-connections

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vpnId": "Z123456789",
  • "customerNote": "東10G",
  • "routeAdvertisement": "fullRoute"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ficConnectionId": "Z123456789",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "Z123456789",
  • "resourceStatus": "inactive",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "東10G",
  • "routeAdvertisement": "fullRoute",
  • "publicServiceKey": "vPmn7tdZfSgEDqhp62UHNyoNcDxjIMmvZB4_iflL4uipkIyLS9b1P1liBRqPGQMyTGzZL81rvM_YOGiDdqNSlkWs3DD_YKFNirhXpIUddM7jS7b4epLPgkC8BOJIZyl1Obzo3tyeDlceshhaw_lHaHiovtmCgyLUnVyvxFTUhd2cH0pHAMiW5NRYspkI0UBqft8RlmaDQBMSJe8lDTO-fvlyUfV2nrhgr9gXRhoJaP9Ghd-QCwHbgQjcO29EKG",
  • "bandwidth": "10G",
  • "ref": "/v1/fic-connections/Z123456789"
}

FIC接続リソース取得API

FIC接続リソースを取得するAPI

path Parameters
ficConnectionId
required
string
header Parameters
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

500

Internal Server Error

get/v1/fic-connections/{ficConnectionId}
http://api.ntt.com/sdpf-ztgict/v1/fic-connections/{ficConnectionId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ficConnectionId": "Z123456789",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "Z123456789",
  • "resourceStatus": "inactive",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "東10G",
  • "referenceFicConnectionId": "F1234567890123",
  • "routeAdvertisement": "fullRoute",
  • "publicServiceKey": "vPmn7tdZfSgEDqhp62UHNyoNcDxjIMmvZB4_iflL4uipkIyLS9b1P1liBRqPGQMyTGzZL81rvM_YOGiDdqNSlkWs3DD_YKFNirhXpIUddM7jS7b4epLPgkC8BOJIZyl1Obzo3tyeDlceshhaw_lHaHiovtmCgyLUnVyvxFTUhd2cH0pHAMiW5NRYspkI0UBqft8RlmaDQBMSJe8lDTO-fvlyUfV2nrhgr9gXRhoJaP9Ghd-QCwHbgQjcO29EKG",
  • "bandwidth": "10G",
  • "ref": "/v1/fic-connections/Z123456789"
}

FIC接続リソース変更API

FIC接続リソースを変更するAPI

path Parameters
ficConnectionId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
customerNote
string <= 64 characters

FIC接続名 (全角・半角・記号許容)

routeAdvertisement
string
Default: "fullRoute"
Enum: "fullRoute" "privateAll" "defaultRoute"

FIC側への経路広告方法

  • fullRoute: VPN 側の経路をそのまま広告
  • privateAll: プライベートIPアドレスレンジ (192.168.0.0/16, 172.16.0.0/12, 10.0.0.0/8) を広告
  • defaultRoute: 0.0.0.0/0 を広告

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/fic-connections/{ficConnectionId}
http://api.ntt.com/sdpf-ztgict/v1/fic-connections/{ficConnectionId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "東10G",
  • "routeAdvertisement": "fullRoute"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ficConnectionId": "Z123456789",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "Z123456789",
  • "resourceStatus": "inactive",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "東10G",
  • "referenceFicConnectionId": "F1234567890123",
  • "routeAdvertisement": "fullRoute",
  • "publicServiceKey": "vPmn7tdZfSgEDqhp62UHNyoNcDxjIMmvZB4_iflL4uipkIyLS9b1P1liBRqPGQMyTGzZL81rvM_YOGiDdqNSlkWs3DD_YKFNirhXpIUddM7jS7b4epLPgkC8BOJIZyl1Obzo3tyeDlceshhaw_lHaHiovtmCgyLUnVyvxFTUhd2cH0pHAMiW5NRYspkI0UBqft8RlmaDQBMSJe8lDTO-fvlyUfV2nrhgr9gXRhoJaP9Ghd-QCwHbgQjcO29EKG",
  • "bandwidth": "10G",
  • "ref": "/v1/fic-connections/Z123456789"
}

FIC接続リソース削除API

FIC接続リソースを削除するAPI

path Parameters
ficConnectionId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/fic-connections/{ficConnectionId}
http://api.ntt.com/sdpf-ztgict/v1/fic-connections/{ficConnectionId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ficConnectionId": "Z123456789",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "Z123456789",
  • "resourceStatus": "inactive",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "東10G",
  • "referenceFicConnectionId": "F1234567890123",
  • "routeAdvertisement": "fullRoute",
  • "publicServiceKey": "vPmn7tdZfSgEDqhp62UHNyoNcDxjIMmvZB4_iflL4uipkIyLS9b1P1liBRqPGQMyTGzZL81rvM_YOGiDdqNSlkWs3DD_YKFNirhXpIUddM7jS7b4epLPgkC8BOJIZyl1Obzo3tyeDlceshhaw_lHaHiovtmCgyLUnVyvxFTUhd2cH0pHAMiW5NRYspkI0UBqft8RlmaDQBMSJe8lDTO-fvlyUfV2nrhgr9gXRhoJaP9Ghd-QCwHbgQjcO29EKG",
  • "bandwidth": "10G",
  • "ref": "/v1/fic-connections/Z123456789"
}

FIC接続BGPリセットAPI

  • BGP セッションリセットを実行するAPI
  • 一度実行すると1時間実行不可
path Parameters
ficConnectionId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
operation
required
string
Value: "reset"

オペレーション操作内容

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

post/v1/fic-connections/{ficConnectionId}/bgp-session
http://api.ntt.com/sdpf-ztgict/v1/fic-connections/{ficConnectionId}/bgp-session

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "processing",
  • "requestTime": "2019-05-21T10:05:50+09:00",
  • "operation": "reset",
  • "ficConnectionId": "Z123456789"
}

FIC接続BGPリセット実行結果照会API

FIC接続のBGPセッションリセットの実行結果を取得する API

path Parameters
ficConnectionId
required
string
header Parameters
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

500

Internal Server Error

get/v1/fic-connections/{ficConnectionId}/bgp-session
http://api.ntt.com/sdpf-ztgict/v1/fic-connections/{ficConnectionId}/bgp-session

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "processing",
  • "requestTime": "2019-05-21T10:05:50+09:00",
  • "operation": "reset",
  • "ficConnectionId": "Z123456789"
}