Documentation Powered by ReDoc

UNO接続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のUNO接続リソース情報の参照・操作が可能です。

unoConnections

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

UNO接続リソースを一覧取得する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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "unoConnections":
    [
    ],
  • "ref": "/v1/uno-connections/Z123456789"
}

UNO接続リソース作成API

UNO接続リソースを作成する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

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

vpnId
required
string ^V[0-9]{9}$

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

  • resourceStatus が inactive のVPNは指定不可
unoContractNumber
required
string ^N[0-9]{9}$

お客様契約番号。docomo business RINK セキュアドWANでは大文字Nから始まる残り数字9桁の10桁の番号を付与する。N番号と呼ぶ。

unoVpnId
required
string ^V[0-9]{8}$

対向VPN情報のVPNリソースに一意に与えられるID。docomo business RINK セキュアドWANでは大文字Vから始まる残り数字8桁の9桁の番号を付与する。V番号と呼ぶ。

unoApplicationDate
required
string <date>

開通希望日. ISO8601 の基本形式 (YYYY-MM-DD)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "UNO接続名",
  • "vpnId": "V123456789",
  • "unoContractNumber": "N123456789",
  • "unoVpnId": "V12345678",
  • "unoApplicationDate": "2019-05-21"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "unoConnectionId": "Z123456789",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "V123456789",
  • "resourceStatus": "inactive",
  • "orderId": "660f9511f3ac52e5b827557766551111",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "UNO接続#1",
  • "unoContractNumber": "N123456789",
  • "unoVpnId": "V87654321",
  • "rinkConnectivityAddress": "10.192.0.2",
  • "unoApplicationDate": "2019-05-21",
  • "ref": "/v1/uno-connections/Z123456789"
}

UNO接続リソース取得API

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

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "unoConnectionId": "Z123456789",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "V123456789",
  • "resourceStatus": "inactive",
  • "orderId": "660f9511f3ac52e5b827557766551111",
  • "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": "UNO接続#1",
  • "unoContractNumber": "N123456789",
  • "unoVpnId": "V87654321",
  • "rinkConnectivityAddress": "10.192.0.2",
  • "unoApplicationDate": "2019-05-21",
  • "ref": "/v1/uno-connections/Z123456789"
}

UNO接続リソース廃止API

UNO接続リソースを廃止するAPI

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "unoConnectionId": "Z123456789",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "vpnId": "V123456789",
  • "resourceStatus": "inactive",
  • "orderId": "660f9511f3ac52e5b827557766551111",
  • "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": "UNO接続名",
  • "unoContractNumber": "N123456789",
  • "unoVpnId": "V87654321",
  • "rinkConnectivityAddress": "10.192.0.2",
  • "unoApplicationDate": "2019-05-21",
  • "ref": "/v1/uno-connections/Z123456789"
}