Documentation Powered by ReDoc

簡易リソース取得API (1.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2023 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

  • 本APIでは、SDPF-NWが提供する各リソース（terminal, ipoe, guarantee, vpn, fic-connection, order）の参照が可能です。

terminals

ルーター簡易情報一覧取得

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

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

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

offset
integer >= 0
Default: 0

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

terminalId
string

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

cutomerNote
string

customerNoteの部分一致検索

sortKey
string
Enum: "terminalId" "customerNote" "mobileId" "ipoeId" "resourceStatus" "updateTime"

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

direction
string

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

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

リソースのステータス

terminalType
string
Enum: "rentalTerminal" "selfTerminal"

セルフ端末、レンタル端末どちらか判定用の項目

breakOutListId
string

指定した breakOutList リソースが紐づく端末を検索

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

Response samples

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

ipoe

IPoE回線簡易情報一覧取得API

IPoE回線簡易情報一覧取得

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

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

offset
integer >= 0
Default: 0

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

ipoeId
string <= 100 characters ^Z[0-9]{9}$
Example: ipoeId=Z123456789

IPoE リソースのID. 指定なしならテナント内のすべての terminal リソースが検索対象. 複数指定も可能. 複数指定の場合の例: ipoeId=Z123456788&ipoeId=Z1234556789

customerNote
string

customerNoteの部分一致検索

sortKey
string
Enum: "ipoeId" "customerNote" "ipv4Address" "resourceStatus" "updateTime"

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

direction
string
Enum: "asc" "desc"

ソート順の指定. 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

OK

get/v1/resource-summary/ipoe
https://api.ntt.com/sdpf-ztgict/v1/resource-summary/ipoe

Response samples

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

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
get/v1/resource-summary/vpns
https://api.ntt.com/sdpf-ztgict/v1/resource-summary/vpns

Response samples

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

guarantees

ギャランティ簡易情報一覧取得API

  • ギャランティリソースを一覧取得するAPI
  • ギャランティの情報としてパターン別に取得できる情報の詳細はギャランティ回線情報取得APIを参照
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 10
Example: limit=5

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

offset
integer >= 0 characters >= 0
Default: 0
Example: offset=5

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

guaranteeId
string ^Z[0-9]{9}$
Example: guaranteeId=Z123456789

guarantee リソースのID. 指定なしならテナント内のすべての guarantee リソースが検索対象

customerNote
string

customerNoteの部分一致検索

sortKey
string
Enum: "guaranteeId" "customerNote" "resourceStatus" "updateTime"

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

direction
string
Enum: "asc" "desc"

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

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

リソースのステータス

maintenance
string
Enum: "internet" "vpn"

指定したネットワーク上でメンテナンスの予定があるものを返却する

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

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

Responses

200
get/v1/resource-summary/guarantees
https://api.ntt.com/sdpf-ztgict/v1/resource-summary/guarantees

Response samples

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

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

get/v1/resource-summary/fic-connections
https://api.ntt.com/sdpf-ztgict/v1/resource-summary/fic-connections

Response samples

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

orders

申込履歴 簡易情報一覧 API

申込履歴 簡易情報一覧 API

query Parameters
orderStatus
string
Enum: "applied" "processing" "completed" "canceled" "aborted" "rejected"
Example: orderStatus=processing

order のステータスでフィルタ。- rejected は明示しない限り hit せず、無指定の場合は他のカテゴリー値のオーダーのみ返却- キーバリューペアを繰り返し指定することで最大N個まで Routings リソースを指定可能 (例: statusCategory=processing&statusCategory=completed)- 候補値 - applied: 未処理のオーダー - processing: 未処理〜処理中のオーダー - completed: 正常終了 - canceled: ユーザーからのキャンセルで、対象オーダーがこれ以上変化しない状態 - aborted: システムからの強制キャンセルで、対象オーダーがこれ以上変化しない状態 - rejected: リクエスト送信段階で内容の不整合などでエラーとなったもの。これ以上変化しない状態

limit
integer [ 1 .. 1000 ]
Default: 10

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

offset
integer >= 0
Default: 10

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

resourceId
string

リソースのIDを指定。完全一致。複数指定不可

requestType
string
Enum: "create" "update" "delete"

リクエストの種別を指定。複数選択可

sortKey
string

ソートに使用する要素を指定

direction
string
Enum: "asc" "desc"

ソート順を指定。asc: 昇順、desc: 降順

resourceType
string
Enum: "fic-connection" "vpn" "terminal" "ipoe" "contractor-setting" "mobile-setting" "phone-ticketing-support" "guarantee" "registration-address" "break-out-list"

リソースタイプを指定。完全一致。複数指定可。

bulkOrderId
string ^[0-9a-f]{32}$
Example: bulkOrderId=62ec2b62646740b5809f695dea7b2bbf

一括オーダーIDを指定。完全一致。

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

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

Responses

200

OK

get/v1/resource-summary/orders
https://api.ntt.com/sdpf-ztgict/v1/resource-summary/orders

Response samples

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