Documentation Powered by ReDoc

装置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が提供するルーター(RINKルーター01)リソースの参照・操作が可能です。

terminals

ルーター一覧取得

テナント内の全てのルーターリソースを参照するAPI

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0
Default: 0

表示するページ番号の指定（デフォルト0）

terminalId
string

ルーターリソースのID. 指定なしならテナント内のすべての ルーターリソースが検索対象 キーバリューペアを繰り返し指定することで複数のルーターリソースを指定可能 (例: ルーターId=ox1234567890&ルーターId=ox1234567891)

cutomerNote
string

customerNoteの部分一致検索

sortKey
string
Enum: "terminalId" "customerNote" "mobileId" "ipoeId" "vpnId" "guaranteeId" "resourceStatus" "orderId" "updateTime" "breakOut"

ソート項目の指定. レスポンスボディの項目から

direction
string

ソート順の指定. asc: 昇順, desc: 降順

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/terminals
https://api.ntt.com/sdpf-ztgict/v1/terminals

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminals":
    [
    ],
  • "total": 100,
  • "offset": 0
}

ルーター申込

ルーターリソースを作成するAPI

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

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

Request Body schema: application/json

request body

customerNote
required
string <= 64 characters

ルーター名 (全角・半角・記号許容)

breakOut
Array of strings [ 1 .. 8 ] items

特定通信ブレイクアウトを指定 特定アプリケーションをローカルブレイクアウトする場合に利用 ネクストホップネットワークがVPNのとき、指定可能 特定通信ブレイクアウト対象リストリソースでユーザ定義のリストを作成し、それを指定することも可能

  • teams: Microsoft Teams 通信
  • zoom: Zoom 通信
  • webex: Cisco WebEX 通信
  • windowsUpdate: Windows Update 通信
  • googleMeet: Google Meet 通信
  • microsoft365NotTeams: Microsoft 365 通信(Teamsを除く)
  • microsoft365: Microsoft 365 通信
  • box: Box 通信
  • {uuid}: ユーザ定義の特定通信ブレイクアウトリストID
breakOutDnsServers
Array of strings [ 1 .. 4 ] items

ローカルブレイクアウト用のDNSサーバ指定 ローカルブレイクアウトを利用する場合指定必須

deliveryName
required
string

配送先　担当者名

deliveryDepartmentName
required
string

配送先　担当者部課名

deliveryPostalCode
required
string ^[0-9]{3}-[0-9]{4}$

配送先 郵便番号

deliveryAddress
required
string

配送先　住所

deliveryPhoneNumber
string ^0[5789]0-[0-9]{4}-[0-9]{4}$|^0([0-9]-[0-9]{4}|[0-9]{2}-[0-9]{3}|[0-9]{3}-[0-9]{2}|[0-9]{4}-[0-9])-[0-9]{4}$

配送先 電話番号

deliveryAddressKana
required
string

配送先　住所カナ

deliveryDate
required
string <date>

配送希望日、10営業日以降から指定可能。ただし12/28～1/3は暦日に含まない。

installationPostalCode
required
string ^[0-9]{3}-[0-9]{4}$

設置場所郵便番号

installationAddress
required
string

設置場所住所

primaryCircuitType
required
string
Enum: "ipoe" "mobile" "guarantee"

メインで利用しているアクセス回線種別。ベストエフォートIPoEアクセスか、ワイヤレスアクセスか、ギャランティアクセス。

secondaryCircuitType
string
Enum: "mobile" "ipoe"
  • バックアップで利用しているアクセス回線種別。ワイヤレスアクセスか、メインがギャランティアクセスの場合ベストエフォートIPoEアクセスも可。
  • 削除する場合は null を入力する。
ipoeId
string ^Z[0-9]{9}$

紐付けるベストエフォートIPoEアクセスID

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

紐付けるVPN接続のリソースID

guarantee
object (TerminalGuaranteeCreate)

ギャランティアクセス関連の申込情報

mobile
object (モバイル回線新規申込)

新規申込リクエストの body 文

loopbackIpv4Address
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])$
lanType
string
Enum: "switchPort" "routedPort"

ルーターのLANタイプ

  • switchPort: すべての LAN ポートでサブネットを共有する
  • routedPort: 各 LAN ポートそれぞれでサブネットを設定する 指定無しの場合スイッチポート方式扱いとする
lans
required
Array of objects (TerminalLan) [ 1 .. 4 ] items

ルーター直下セグメント

  • LAN種別が Primary となる LAN は必須。一つのみ指定可
  • LAN種別が Secondary となる LAN は三つまで指定可
defaultGateway
required
object (TerminalDefaultGateway)

デフォルトルート設定

lanStaticRoutes
Array of objects (TerminalLanStaticRoute) [ 0 .. 95 ] items
wanStaticRoutes
Array of objects (TerminalWanStaticRoute) [ 0 .. 300 ] items
vpnInFilters
object (TerminalUserFilter)
vpnOutFilters
object (TerminalUserFilter)
inet4OutFilters
object (TerminalUserFilter)
dhcpRelayServers
Array of objects (TerminalDhcpRelayServers) [ 1 .. 4 ] items

DHCP リレーの設定 DHCP サーバー と DHCP リレーはどちらか一方のみ指定可。両方を指定した場合エラーとなる。 ルーター設定変更時に一方を指定した場合、もう一方の設定は削除される。

trafficReportFlowAnalyzer
required
object (TrafficReportFlowAnalyzerRequest)

トラフィックレポート（フロー分析）オプション情報

  • ギャランティアクセスIDの紐づけを変更する場合は、trafficReportFlowAnalyzerPlanを指定をする。ギャランティアクセスID変更時にtrafficReportFlowAnalyzerPlanの指定がない場合は既存のプランを引き継ぐ
  • ギャランティアクセスIDの紐づけを外しギャランティアクセスなし構成へ変更する場合は、trafficReportFlowAnalyzerPlan:noSuscriptionを設定する
flowCollector
required
object (flowCollectorRequest)

フローコレクターオプション情報

threatDetection
required
object (ThreatDetection)

脅威検知オプション情報

behaviorDetection
required
object (BehaviorDetection)

振る舞い検知オプション情報

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "東京支店ルーター",
  • "breakOut":
    [
    ],
  • "breakOutDnsServers":
    [
    ],
  • "deliveryName": "電報 太郎",
  • "deliveryDepartmentName": "電報部電報課",
  • "deliveryPostalCode": "100-0004",
  • "deliveryAddress": "東京都千代田区大手町2-3-1",
  • "deliveryPhoneNumber": "03-1234-5678",
  • "deliveryAddressKana": "トウキョウトチヨダクオオテマチ２−３−１",
  • "deliveryDate": "2023-04-01",
  • "installationPostalCode": "100-0004",
  • "installationAddress": "東京都千代田区大手町2-3-1",
  • "primaryCircuitType": "ipoe",
  • "secondaryCircuitType": "mobile",
  • "ipoeId": "Z123456789",
  • "vpnId": "V123456789",
  • "guarantee":
    {
    },
  • "mobile":
    {
    },
  • "loopbackIpv4Address": "10.0.0.1",
  • "lans":
    [
    ],
  • "defaultGateway":
    {
    },
  • "lanStaticRoutes":
    [
    ],
  • "wanStaticRoutes":
    [
    ],
  • "vpnInFilters":
    {
    },
  • "vpnOutFilters":
    {
    },
  • "inet4OutFilters":
    {
    },
  • "dhcpRelayServers":
    [
    ],
  • "trafficReportFlowAnalyzer":
    {
    },
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    },
  • "behaviorDetection":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminalId": "Z123456789",
  • "ref": "/v1/terminals/Z000000001",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "inactive",
  • "orderId": "Z123456789",
  • "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": "東京支店ルーター",
  • "defaultGateway":
    {
    },
  • "breakOut":
    [
    ],
  • "breakOutDnsServers":
    [
    ],
  • "deliveryName": "電報 太郎",
  • "deliveryDepartmentName": "電報部電報課",
  • "deliveryPostalCode": "100-0004",
  • "deliveryAddress": "東京都千代田区大手町2-3-1",
  • "deliveryPhoneNumber": "03-1234-5678",
  • "deliveryAddressKana": "トウキョウトチヨダクオオテマチ２−３−１",
  • "deliveryDate": "2023-04-01",
  • "removalName": "電報 太郎",
  • "removalDepartmentName": "東京都千代田区大手町2-3-1",
  • "removalPostalCode": "100-0004",
  • "removalAddress": "東京都千代田区大手町2-3-1",
  • "removalAddressKana": "東京都千代田区大手町2-3-1",
  • "removalPhoneNumber": "03-1234-5678",
  • "installationPostalCode": "100-0004",
  • "installationAddress": "千代田区大手町2-3-1",
  • "vpnId": "V123456789",
  • "ipoeId": "Z123456789",
  • "ipoeIpv4Address": "192.0.2.2/32",
  • "mobileId": "Z123456789",
  • "guarantee":
    {
    },
  • "loopbackIpv4Address": "10.0.0.1",
  • "mobile":
    {
    },
  • "terminalDevices":
    [
    ],
  • "primaryCircuit":
    {
    },
  • "secondaryCircuit":
    {
    },
  • "lans":
    [
    ],
  • "lanStaticRoutes":
    [
    ],
  • "wanStaticRoutes":
    [
    ],
  • "inet4OutFilters":
    {
    },
  • "vpnInFilters":
    {
    },
  • "vpnOutFilters":
    {
    },
  • "dhcpServer":
    {
    },
  • "dhcpRelayServers":
    [
    ],
  • "trafficReportFlowAnalyzer":
    {
    },
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    },
  • "behaviorDetection":
    {
    }
}

ルーター一覧取得（ルーターID指定）

テナント内の特定のルーターIDのルーターリソースを参照するAPI

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

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

Responses

200

responseBody

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/terminals/{terminalId}
https://api.ntt.com/sdpf-ztgict/v1/terminals/{terminalId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminalId": "Z123456789",
  • "ref": "/v1/terminals/Z000000001",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "inactive",
  • "orderId": "Z123456789",
  • "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": "東京支店ルーター",
  • "defaultGateway":
    {
    },
  • "breakOut":
    [
    ],
  • "breakOutDnsServers":
    [
    ],
  • "deliveryName": "電報 太郎",
  • "deliveryDepartmentName": "電報部電報課",
  • "deliveryPostalCode": "100-0004",
  • "deliveryAddress": "東京都千代田区大手町2-3-1",
  • "deliveryPhoneNumber": "03-1234-5678",
  • "deliveryAddressKana": "トウキョウトチヨダクオオテマチ２−３−１",
  • "deliveryDate": "2023-04-01",
  • "removalName": "電報 太郎",
  • "removalDepartmentName": "東京都千代田区大手町2-3-1",
  • "removalPostalCode": "100-0004",
  • "removalAddress": "東京都千代田区大手町2-3-1",
  • "removalAddressKana": "東京都千代田区大手町2-3-1",
  • "removalPhoneNumber": "03-1234-5678",
  • "installationPostalCode": "100-0004",
  • "installationAddress": "千代田区大手町2-3-1",
  • "vpnId": "V123456789",
  • "ipoeId": "Z123456789",
  • "ipoeIpv4Address": "192.0.2.2/32",
  • "mobileId": "Z123456789",
  • "guarantee":
    {
    },
  • "loopbackIpv4Address": "10.0.0.1",
  • "mobile":
    {
    },
  • "terminalDevices":
    [
    ],
  • "primaryCircuit":
    {
    },
  • "secondaryCircuit":
    {
    },
  • "lans":
    [
    ],
  • "lanStaticRoutes":
    [
    ],
  • "wanStaticRoutes":
    [
    ],
  • "inet4OutFilters":
    {
    },
  • "vpnInFilters":
    {
    },
  • "vpnOutFilters":
    {
    },
  • "dhcpServer":
    {
    },
  • "dhcpRelayServers":
    [
    ],
  • "trafficReportFlowAnalyzer":
    {
    },
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    },
  • "behaviorDetection":
    {
    }
}

ルーター変更申込

テナント内の特定のルーターIDのルーターリソースを修正するAPI

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

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

Request Body schema:
application/json

request body

customerNote
string <= 64 characters

ルーター名　(全角・半角・記号許容)

breakOut
Array of strings [ 1 .. 8 ] items

特定通信ブレイクアウトを指定 特定アプリケーションをローカルブレイクアウトする場合に利用 ネクストホップネットワークがVPNのとき、指定可能 特定通信ブレイクアウト対象リストリソースでユーザ定義のリストを作成し、それを指定することも可能

  • teams: Microsoft Teams 通信
  • zoom: Zoom 通信
  • webex: Cisco WebEX 通信
  • windowsUpdate: Windows Update 通信
  • googleMeet: Google Meet 通信
  • microsoft365NotTeams: Microsoft 365 通信(Teamsを除く)
  • microsoft365: Microsoft 365 通信
  • box: Box 通信
  • {uuid}: ユーザ定義の特定通信ブレイクアウトリストID
breakOutDnsServers
Array of strings [ 1 .. 4 ] items

ローカルブレイクアウト用のDNSサーバ指定 ローカルブレイクアウトを利用する場合指定必須

installationPostalCode
string ^[0-9]{3}-[0-9]{4}$

設置場所郵便番号

installationAddress
string

設置場所住所

primaryCircuitType
string
Enum: "ipoe" "mobile" "guarantee"

メインで利用しているアクセス回線種別。ベストエフォートIPoEアクセスか、ワイヤレスアクセスか、ギャランティアクセス。

secondaryCircuitType
string
Enum: "mobile" "ipoe"
  • バックアップで利用しているアクセス回線種別。ワイヤレスアクセスか、メインがギャランティアクセスの場合ベストエフォートIPoEアクセスも可。
  • 削除する場合は null を入力する。
ipoeId
string ^Z[0-9]{9}$

ベストエフォートIPoEアクセスID。紐づけを解除する場合は null を入力する。 メイン回線がベストエフォートIPoEアクセスの時、別IDに変更する場合はこれ以外の項目の変更不可

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

VPN接続リソースID。docomo business RINKではVPN接続リソースに対して大文字Vから始まる残り数字9桁の10桁の番号を付与する。V番号と呼ぶ。紐づけを解除する場合は null を入力する。

guarantee
object (TerminalGuaranteeUpdate)

ギャランティアクセス関連の変更申込

loopbackIpv4Address
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])$
lanType
string
Enum: "switchPort" "routedPort"

ルーターのLANタイプ

  • switchPort: すべての LAN ポートでサブネットを共有する
  • routedPort: 各 LAN ポートそれぞれでサブネットを設定する 指定無しの場合スイッチポート方式扱いとする
lans
Array of objects (TerminalLan) [ 1 .. 4 ] items
defaultGateway
object (TerminalDefaultGateway)

デフォルトルート設定

lanStaticRoutes
Array of objects (TerminalLanStaticRoute) [ 0 .. 95 ] items
wanStaticRoutes
Array of objects (TerminalWanStaticRoute) [ 0 .. 300 ] items
vpnInFilters
object (TerminalUserFilter)
vpnOutFilters
object (TerminalUserFilter)
inet4OutFilters
object (TerminalUserFilter)
dhcpRelayServers
Array of objects (TerminalDhcpRelayServers) [ 1 .. 4 ] items

DHCP リレーの設定 DHCP サーバー と DHCP リレーはどちらか一方のみ指定可。両方を指定した場合エラーとなる。 ルーター設定変更時に一方を指定した場合、もう一方の設定は削除される。

mobile
object (モバイル回線設定変更)

変更リクエストの body 文

trafficReportFlowAnalyzer
object (TrafficReportFlowAnalyzerRequest)

トラフィックレポート（フロー分析）オプション情報

  • ギャランティアクセスIDの紐づけを変更する場合は、trafficReportFlowAnalyzerPlanを指定をする。ギャランティアクセスID変更時にtrafficReportFlowAnalyzerPlanの指定がない場合は既存のプランを引き継ぐ
  • ギャランティアクセスIDの紐づけを外しギャランティアクセスなし構成へ変更する場合は、trafficReportFlowAnalyzerPlan:noSuscriptionを設定する
flowCollector
object (flowCollectorRequest)

フローコレクターオプション情報

threatDetection
object (ThreatDetection)

脅威検知オプション情報

behaviorDetection
object (BehaviorDetection)

振る舞い検知オプション情報

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/terminals/{terminalId}
https://api.ntt.com/sdpf-ztgict/v1/terminals/{terminalId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "東京支店ルーター",
  • "breakOut":
    [
    ],
  • "breakOutDnsServers":
    [
    ],
  • "installationPostalCode": "100-0004",
  • "installationAddress": "東京都千代田区大手町2-3-1",
  • "primaryCircuitType": "ipoe",
  • "secondaryCircuitType": "mobile",
  • "ipoeId": "Z123456789",
  • "vpnId": "V123456789",
  • "guarantee":
    {
    },
  • "loopbackIpv4Address": "10.0.0.1",
  • "lans":
    [
    ],
  • "defaultGateway":
    {
    },
  • "lanStaticRoutes":
    [
    ],
  • "wanStaticRoutes":
    [
    ],
  • "vpnInFilters":
    {
    },
  • "vpnOutFilters":
    {
    },
  • "inet4OutFilters":
    {
    },
  • "dhcpServer":
    {
    },
  • "dhcpRelayServers":
    [
    ],
  • "trafficReportFlowAnalyzer":
    {
    },
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    },
  • "behaviorDetection":
    {
    },
  • "mobile":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminalId": "Z123456789",
  • "ref": "/v1/terminals/Z000000001",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "inactive",
  • "orderId": "Z123456789",
  • "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": "東京支店ルーター",
  • "defaultGateway":
    {
    },
  • "breakOut":
    [
    ],
  • "breakOutDnsServers":
    [
    ],
  • "deliveryName": "電報 太郎",
  • "deliveryDepartmentName": "電報部電報課",
  • "deliveryPostalCode": "100-0004",
  • "deliveryAddress": "東京都千代田区大手町2-3-1",
  • "deliveryPhoneNumber": "03-1234-5678",
  • "deliveryAddressKana": "トウキョウトチヨダクオオテマチ２−３−１",
  • "deliveryDate": "2023-04-01",
  • "removalName": "電報 太郎",
  • "removalDepartmentName": "東京都千代田区大手町2-3-1",
  • "removalPostalCode": "100-0004",
  • "removalAddress": "東京都千代田区大手町2-3-1",
  • "removalAddressKana": "東京都千代田区大手町2-3-1",
  • "removalPhoneNumber": "03-1234-5678",
  • "installationPostalCode": "100-0004",
  • "installationAddress": "千代田区大手町2-3-1",
  • "vpnId": "V123456789",
  • "ipoeId": "Z123456789",
  • "ipoeIpv4Address": "192.0.2.2/32",
  • "mobileId": "Z123456789",
  • "guarantee":
    {
    },
  • "loopbackIpv4Address": "10.0.0.1",
  • "mobile":
    {
    },
  • "terminalDevices":
    [
    ],
  • "primaryCircuit":
    {
    },
  • "secondaryCircuit":
    {
    },
  • "lans":
    [
    ],
  • "lanStaticRoutes":
    [
    ],
  • "wanStaticRoutes":
    [
    ],
  • "inet4OutFilters":
    {
    },
  • "vpnInFilters":
    {
    },
  • "vpnOutFilters":
    {
    },
  • "dhcpServer":
    {
    },
  • "dhcpRelayServers":
    [
    ],
  • "trafficReportFlowAnalyzer":
    {
    },
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    },
  • "behaviorDetection":
    {
    }
}

ルーター廃止

テナント内の特定のルーターIDのルーターリソースを削除するAPI

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

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

Request Body schema: application/json
removalName
required
string

返却キット送付先　担当者名

removalDepartmentName
required
string

返却キット送付先　部課名

removalPostalCode
required
string ^[0-9]{3}-[0-9]{4}$

返却キット送付先　郵便番号

removalAddress
required
string

返却キット送付先　住所カナ

removalAddressKana
required
string

返却キット送付先　住所

removalPhoneNumber
required
string ^0[5789]0-[0-9]{4}-[0-9]{4}$|^0([0-9]-[0-9]{4}|[0-9]{2}-[0-9]{3}|[0-9]{3}-[0-9]{2}|[0-9]{4}-[0-9])-[0-9]{4}$

返却キット送付先　電話番号

mobile
object (モバイル回線廃止)

廃止リクエストの body 文

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/terminals/{terminalId}
https://api.ntt.com/sdpf-ztgict/v1/terminals/{terminalId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "removalName": "電報 太郎",
  • "removalDepartmentName": "電報 太郎",
  • "removalPostalCode": "100-0004",
  • "removalAddress": "ﾄｳｷｮｳﾄﾁﾖﾀﾞｸｵｵﾃﾏﾁ2-3-1",
  • "removalAddressKana": "東京都千代田区大手町2-3-1",
  • "removalPhoneNumber": "03-1234-5678",
  • "mobile":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminalId": "Z123456789",
  • "ref": "/v1/terminals/Z000000001",
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "inactive",
  • "orderId": "Z123456789",
  • "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": "東京支店ルーター",
  • "defaultGateway":
    {
    },
  • "breakOut":
    [
    ],
  • "breakOutDnsServers":
    [
    ],
  • "deliveryName": "電報 太郎",
  • "deliveryDepartmentName": "電報部電報課",
  • "deliveryPostalCode": "100-0004",
  • "deliveryAddress": "東京都千代田区大手町2-3-1",
  • "deliveryPhoneNumber": "03-1234-5678",
  • "deliveryAddressKana": "トウキョウトチヨダクオオテマチ２−３−１",
  • "deliveryDate": "2023-04-01",
  • "removalName": "電報 太郎",
  • "removalDepartmentName": "東京都千代田区大手町2-3-1",
  • "removalPostalCode": "100-0004",
  • "removalAddress": "東京都千代田区大手町2-3-1",
  • "removalAddressKana": "東京都千代田区大手町2-3-1",
  • "removalPhoneNumber": "03-1234-5678",
  • "installationPostalCode": "100-0004",
  • "installationAddress": "千代田区大手町2-3-1",
  • "vpnId": "V123456789",
  • "ipoeId": "Z123456789",
  • "ipoeIpv4Address": "192.0.2.2/32",
  • "mobileId": "Z123456789",
  • "guarantee":
    {
    },
  • "loopbackIpv4Address": "10.0.0.1",
  • "mobile":
    {
    },
  • "terminalDevices":
    [
    ],
  • "primaryCircuit":
    {
    },
  • "secondaryCircuit":
    {
    },
  • "lans":
    [
    ],
  • "lanStaticRoutes":
    [
    ],
  • "wanStaticRoutes":
    [
    ],
  • "inet4OutFilters":
    {
    },
  • "vpnInFilters":
    {
    },
  • "vpnOutFilters":
    {
    },
  • "dhcpRelayServers":
    [
    ],
  • "trafficReportFlowAnalyzer":
    {
    },
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    },
  • "behaviorDetection":
    {
    }
}

ルーター操作API

ルーターを操作するためのAPI

path Parameters
terminalId
required
string
header Parameters
X-Auth-Token
string

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

Request Body schema: application/json
operation
required
string
Enum: "reboot" "firmwareUpdate" "firmwareUpdateNoReboot" "breakOutListUpdate"

オペレーション操作内容

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/terminals/{terminalId}/operation
https://api.ntt.com/sdpf-ztgict/v1/terminals/{terminalId}/operation

Request samples

Content type
application/json
Example
ルーター再起動
Copy
 Expand all Collapse all
{
  • "operation": "reboot"
}

Response samples

Content type
application/json
Example
ルーターファームウェア更新
Copy
 Expand all Collapse all
{
  • "operation": "firmwareUpdate",
  • "status": "processing",
  • "requestTime": "2019-05-21T10:05:50+09:00"
}

ルーター操作状況取得API

最新のルーター操作の状況を取得するAPI

path Parameters
terminalId
required
string
query Parameters
operation
string
Enum: "reboot" "firmwareUpdate" "firmwareUpdateNoReboot" "breakOutListUpdate"

ルーター操作種別。reboot, firmwareUpdate, firmwareUpdateNoReboot, breakOutListUpdate から選択。選択無しの場合は全ての status を返す

header Parameters
X-Auth-Token
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/terminals/{terminalId}/operation
https://api.ntt.com/sdpf-ztgict/v1/terminals/{terminalId}/operation

Response samples

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

terminals-bulk

ルーター一括申込

ルーターリソースを一括作成するリクエストを実行するAPI

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

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

Request Body schema: application/json

request body

mobile
object (モバイル回線新規申込)

新規申込リクエストの body 文

terminals
required
Array of objects (TerminalCreateForBulk)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "bulkOrderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "requestTime": "2023-12-01T00:00:00+00:00"
}

ルーター一括変更

ルーターリソースを一括変更するリクエストを実行するAPI

Request Body schema: application/json
terminalIds
Array of strings [ 1 .. 100 ] items

変更対象のルーターIDリスト

vpnId
string Z[0-9]{9}

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

breakOut
Array of strings [ 1 .. 8 ] items

ローカルブレイクアウトアプリケーション指定 特定アプリケーションをローカルブレイクアウトする場合に利用 defaultGatewayがvpnのとき、指定可能 特定通信ブレイクアウト対象リストリソースでユーザ定義のリストを作成し、それを指定することも可能

  • teams: Teams 通信
  • zoom: Zoom 通信
  • webex: WebEX 通信
  • windowsUpdate: Windows Update 通信
  • googleMeet: Google Meet 通信
  • microsoft365NotTeams: Microsoft 365 通信(Teamsを除く)
  • microsoft365: Microsoft 365 通信
  • box: Box 通信
  • {uuid}: ユーザ定義の特定通信ブレイクアウトリストID
breakOutDnsServers
Array of strings [ 1 .. 4 ] items

ローカルブレイクアウト用のDNSサーバ指定 ローカルブレイクアウトを利用する場合指定必須

defaultGateway
object (TerminalDefaultGateway)

デフォルトルート設定

wanStaticRoutes
Array of objects (TerminalWanStaticRoute) [ 0 .. 300 ] items
vpnInFilters
object (TerminalUserFilter)
vpnOutFilters
object (TerminalUserFilter)
inet4OutFilters
object (TerminalUserFilter)
dhcpServer
object

DHCPサーバの設定 DHCPサーバーと DHCPリレーはどちらか一方のみ指定可。両方を指定した場合エラーとなる。 ルーター設定変更時に一方を指定した場合、もう一方の設定は削除される。

dhcpRelayServers
Array of objects (TerminalDhcpRelayServers) [ 1 .. 4 ] items

DHCP リレーの設定 DHCP サーバー と DHCP リレーはどちらか一方のみ指定可。両方を指定した場合エラーとなる。 ルーター設定変更時に一方を指定した場合、もう一方の設定は削除される。

trafficReportFlowAnalyzer
object (TrafficReportFlowAnalyzerRequest)

トラフィックレポート（フロー分析）オプション情報

  • ギャランティアクセスIDの紐づけを変更する場合は、trafficReportFlowAnalyzerPlanを指定をする。ギャランティアクセスID変更時にtrafficReportFlowAnalyzerPlanの指定がない場合は既存のプランを引き継ぐ
  • ギャランティアクセスIDの紐づけを外しギャランティアクセスなし構成へ変更する場合は、trafficReportFlowAnalyzerPlan:noSuscriptionを設定する
flowCollector
object (flowCollectorRequest)

フローコレクターオプション情報

threatDetection
object (ThreatDetection)

脅威検知オプション情報

behaviorDetection
object (BehaviorDetection)

振る舞い検知オプション情報

Responses

202

Accepted

put/v1/terminals-bulk
https://api.ntt.com/sdpf-ztgict/v1/terminals-bulk

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminalIds":
    [
    ],
  • "vpnId": "Z000000004",
  • "breakOut":
    [
    ],
  • "breakOutDnsServers":
    [
    ],
  • "defaultGateway":
    {
    },
  • "wanStaticRoutes":
    [
    ],
  • "vpnInFilters":
    {
    },
  • "vpnOutFilters":
    {
    },
  • "inet4OutFilters":
    {
    },
  • "dhcpServer":
    {
    },
  • "trafficReportFlowAnalyzer":
    {
    },
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    },
  • "behaviorDetection":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "bulkOrderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "requestTime": "2023-12-01T00:00:00+00:00"
}

ルーター一括操作API

ルーターを操作するためのAPI

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

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

Request Body schema: application/json

request body

terminalIds
required
Array of strings

ルーターリソースID

operation
required
string
Value: "breakOutListUpdate"

オペレーション操作内容

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/terminals-bulk/operation
https://api.ntt.com/sdpf-ztgict/v1/terminals-bulk/operation

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminalIds":
    [
    ],
  • "operation": "breakOutListUpdate"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminalIds":
    [
    ],
  • "operation": "breakOutListUpdate",
  • "requestTime": "2023-12-01T00:00:00+00:00"
}

ルーター操作状況一括取得API

最新のルーター操作の状況を取得するAPI

query Parameters
terminalId
string

端末リソースのID

Responses

200

OK

get/v1/terminals-bulk/operation
https://api.ntt.com/sdpf-ztgict/v1/terminals-bulk/operation

Response samples

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

ルーターセキュリティフィルタ遮断カウント更新

ルーターセキュリティフィルタの遮断カウントを取得するAPI

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

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

Request Body schema: application/json

request body

terminals
required
Array of objects

ルーターリソースリスト

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/terminals-bulk/get-filter-counts
https://api.ntt.com/sdpf-ztgict/v1/terminals-bulk/get-filter-counts

Request samples

Content type
application/json
Example
ルーターセキュリティフィルタ遮断カウント更新
Copy
 Expand all Collapse all
{
  • "terminals":
    [
    ]
}

Response samples

Content type
application/json
Example
ルーターセキュリティフィルタ遮断カウント更新
Copy
 Expand all Collapse all
{
  • "requestTime": "2023-12-01T00:00:00+00:00"
}

self-terminals

自営ルーター一覧取得

テナント内の全てのお客さま自営ルーターリソースを参照するAPI

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0
Default: 0

表示するページ番号の指定（デフォルト0）

terminalId
string

ルーターリソースのID. 指定なしならテナント内のすべての ルーターリソースが検索対象 キーバリューペアを繰り返し指定することで複数のルーターリソースを指定可能 (例: terminalId=ox1234567890&terminalId=ox1234567891)

cutomerNote
string

customerNoteの部分一致検索

sortKey
string
Enum: "terminalId" "customerNote" "mobileId" "ipoeId" "vpnId" "guaranteeId" "resourceStatus" "orderId" "updateTime" "breakOut"

ソート項目の指定. レスポンスボディの項目から

direction
string

ソート順の指定. asc: 昇順, desc: 降順

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

User Not Found

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "terminals":
    [
    ],
  • "total": 1,
  • "offset": 0,
  • "limit": 10
}

自営ルーター申込

お客さま自営ルーターリソースを作成するAPI

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

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

Request Body schema: application/json

request body

customerNote
required
string <= 64 characters

ルーター名 (全角・半角・記号許容)

installationPostalCode
required
string ^[0-9]{3}-[0-9]{4}$

設置場所郵便番号

installationAddress
required
string

設置場所住所(市区町村以降)

primaryCircuitType
required
string
Value: "guarantee"

メインで利用しているアクセス回線種別

vpnId
string ^Z[0-9]{9}$

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

vpnRouteLimit
integer
Enum: 35 100 200 1000

VPN に広告できる経路の上限数 VPN 利用無しの場合指定不可 VPN 利用で指定無しの場合上限35となる 1000を指定した場合有料となる

vpnAdvertiseNetworks
Array of strings

VPN に広告する経路 入力したIPアドレスプレフィックスに包含されるアドレスをVPNに広告できる

guarantee
required
object (SelfTerminalGuaranteeCreate)

ギャランティアクセス関連の申込情報

trafficReportFlowAnalyzer
required
object (TrafficReportFlowAnalyzerRequest)

トラフィックレポート（フロー分析）オプション情報

  • ギャランティアクセスIDの紐づけを変更する場合は、trafficReportFlowAnalyzerPlanを指定をする。ギャランティアクセスID変更時にtrafficReportFlowAnalyzerPlanの指定がない場合は既存のプランを引き継ぐ
  • ギャランティアクセスIDの紐づけを外しギャランティアクセスなし構成へ変更する場合は、trafficReportFlowAnalyzerPlan:noSuscriptionを設定する
flowCollector
required
object (flowCollectorRequest)

フローコレクターオプション情報

threatDetection
required
object (ThreatDetection)

脅威検知オプション情報

behaviorDetection
required
object (BehaviorDetection)

振る舞い検知オプション情報

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

自営ルーター廃止

お客さま自営ルーターリソースを廃止するAPI

header Parameters
X-Auth-Token
required
string

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

Responses

202

Accepted

delete/v1/self-terminals
https://api.ntt.com/sdpf-ztgict/v1/self-terminals

自営ルーター一覧取得（ルーターID指定）

テナント内の特定のお客さま自営ルーターIDのルーターリソースを参照するAPI

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

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

Responses

200

responseBody

400

Bad Request

401

Unauthorized

403

Forbidden

404

User Not Found

500

Internal Server Error

get/v1/self-terminals/{selfTerminalId}
https://api.ntt.com/sdpf-ztgict/v1/self-terminals/{selfTerminalId}

Response samples

Content type
application/json
No sample

自営ルーター変更申し込み

テナント内の特定のルーターIDのルーターリソースを修正するAPI

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

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

Request Body schema:
application/json

request body

customerNote
string <= 64 characters

ルーター名 (全角・半角・記号許容)

installationPostalCode
string ^[0-9]{3}-[0-9]{4}$

設置場所郵便番号

installationAddress
string

設置場所住所(市区町村以降)

primaryCircuitType
string
Value: "guarantee"

メインで利用しているアクセス回線種別

vpnId
string ^Z[0-9]{9}$

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

vpnRouteLimit
integer
Enum: 35 100 200 1000

VPN に広告できる経路の上限数 VPN 利用無しの場合指定不可 VPN 利用で指定無しの場合上限35となる 1000を指定した場合有料となる

vpnAdvertiseNetworks
Array of strings

VPN に広告する経路 入力したIPアドレスプレフィックスに包含されるアドレスをVPNに広告できる

guarantee
object (SelfTerminalGuaranteeUpdate)

ギャランティアクセス関連の変更申し込み

trafficReportFlowAnalyzer
object (TrafficReportFlowAnalyzerRequest)

トラフィックレポート（フロー分析）オプション情報

  • ギャランティアクセスIDの紐づけを変更する場合は、trafficReportFlowAnalyzerPlanを指定をする。ギャランティアクセスID変更時にtrafficReportFlowAnalyzerPlanの指定がない場合は既存のプランを引き継ぐ
  • ギャランティアクセスIDの紐づけを外しギャランティアクセスなし構成へ変更する場合は、trafficReportFlowAnalyzerPlan:noSuscriptionを設定する
flowCollector
object (flowCollectorRequest)

フローコレクターオプション情報

threatDetection
object (ThreatDetection)

脅威検知オプション情報

behaviorDetection
object (BehaviorDetection)

振る舞い検知オプション情報

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/self-terminals/{selfTerminalId}
https://api.ntt.com/sdpf-ztgict/v1/self-terminals/{selfTerminalId}

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
No sample

terminal-util

オプションごとのルーター数取得

テナント内のルーター総数とオプション契約数を取得するAPI。取得対象はリソースステータスactiveのルーター 取得対象オプションは以下

  • フローコレクターオプション
  • 脅威検知オプション
query Parameters
optionType
string
Enum: "flowCollector" "threatDetection"
Example: optionType=flowCollector

ルーター取得対象のオプション種別。複数指定可能。指定がない場合は全てのオプションが対象

  • flowCollector:フローコレクターを契約しているルーター
  • threatDetection:脅威検知を契約しているルーター
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/terminal-util/option-count
https://api.ntt.com/sdpf-ztgict/v1/terminal-util/option-count

Response samples

Content type
application/json
Example
optionType指定なしのレスポンス
Copy
 Expand all Collapse all
{
  • "total": 10,
  • "flowCollector":
    {
    },
  • "threatDetection":
    {
    }
}