Documentation Powered by ReDoc

VPN接続 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 セキュアドWANのVPN接続リソース情報の参照・操作が可能です。

Vpns

VPN一覧取得API

VPNリソースを一覧取得する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
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/vpns
https://api.ntt.com/sdpf-ztgict/v1/vpns

Response samples

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

VPN申込API

VPNリソースの新規作成API

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

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

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

VPN名 (全角・半角・記号許容)

internalAddress
required
string ^(((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])/26)$

VPN網内でNTTドコモビジネスが利用する予約アドレス。/26のIPv4アドレスを指定。 VPN 作成後に変更不可。

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/vpns
https://api.ntt.com/sdpf-ztgict/v1/vpns

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "東VPN",
  • "internalAddress": "10.192.0.0/26"
}

Response samples

Content type
application/json
Example
VPN申込(Terminalからの経路広報なし)
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "V123456789",
  • "ref": "/v1/vpns/V123456789",
  • "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": "東VPN",
  • "internalAddress": "10.192.0.0/26",
  • "routeCount": 0
}

VPN取得API

VPNリソースを取得するAPI

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

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

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/vpns/{vpnId}
https://api.ntt.com/sdpf-ztgict/v1/vpns/{vpnId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "V123456789",
  • "ref": "/v1/vpns/V123456789",
  • "resourceStatus": "active",
  • "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": "東VPN",
  • "internalAddress": "10.192.0.0/26",
  • "routeCount": 1,
  • "routes":
    [
    ]
}

VPN変更API

VPNリソースを変更するAPI

path Parameters
vpnId
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

VPN名 (全角・半角・記号許容)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/vpns/{vpnId}
https://api.ntt.com/sdpf-ztgict/v1/vpns/{vpnId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "東VPN"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "V123456789",
  • "ref": "/v1/vpns/V123456789",
  • "resourceStatus": "active",
  • "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": "東VPN",
  • "internalAddress": "10.192.0.0/26",
  • "routeCount": 1,
  • "routes":
    [
    ]
}

VPN削除API

VPNリソースを削除するAPI

path Parameters
vpnId
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/vpns/{vpnId}
https://api.ntt.com/sdpf-ztgict/v1/vpns/{vpnId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "V123456789",
  • "ref": "/v1/vpns/V123456789",
  • "resourceStatus": "terminated",
  • "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": "東VPN",
  • "internalAddress": "10.192.0.0/26",
  • "routeCount": 0,
  • "routes": [ ]
}

VPN経路検索API

入力した経路に対してVPN内で重複があるか確認するAPI

path Parameters
vpnId
required
string
query Parameters
ipv4Prefix
required
string

IPv4プレフィックス

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

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

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/vpns/{vpnId}/search-route
https://api.ntt.com/sdpf-ztgict/v1/vpns/{vpnId}/search-route

Response samples

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