Documentation Powered by ReDoc

BreakOutListリソース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では、docomo business RINKの特定通信ブレイクアウト対象リストリソース情報の参照・操作が可能です。

本APIで作成した特定通信ブレイクアウト対象リストリソースのbreakOutListIdを端末に紐づけることでブレイクアウトの対象に利用可能

breakOutLists

特定通信ブレイクアウト対象リスト一覧取得API

特定通信ブレイクアウト対象リストリソースを一覧取得するAPI

query Parameters
cutomerNote
string

customerNoteの部分一致検索

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

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

Responses

200
get/v1/break-out-lists
https://api.ntt.com/sdpf-ztgict/v1/break-out-lists

Response samples

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

特定通信ブレイクアウト対象リストリソース作成API

特定通信ブレイクアウト対象リストリソースを作成する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

顧客が任意で付与できる識別子 (全角・半角・記号許容)

fqdnList
Array of strings

FQDNのリスト

prefixList
Array of strings

prefixのリスト

Responses

202

Accepted

post/v1/break-out-lists
https://api.ntt.com/sdpf-ztgict/v1/break-out-lists

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "list1",
  • "fqdnList":
    [
    ],
  • "prefixList":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "breakOutListId": "550e8400e29b41d4a716446655440000",
  • "ref": "/v1/break-out-lists/550e8400e29b41d4a716446655440000",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "list1",
  • "fqdnList":
    [
    ],
  • "prefixList":
    [
    ]
}

特定通信ブレイクアウト対象リスト詳細取得API

特定通信ブレイクアウト対象リストリソースを取得するAPI

path Parameters
breakOutListId
required
string

Responses

200
get/v1/break-out-lists/{breakOutListId}
https://api.ntt.com/sdpf-ztgict/v1/break-out-lists/{breakOutListId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "breakOutListId": "550e8400e29b41d4a716446655440000",
  • "ref": "/v1/break-out-lists/550e8400e29b41d4a716446655440000",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "list1",
  • "fqdnList":
    [
    ],
  • "prefixList":
    [
    ]
}

特定通信ブレイクアウト対象リストリソース更新API

特定通信ブレイクアウト対象リストリソースを更新するAPI

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

顧客が任意で付与できる識別子 (全角・半角・記号許容)

fqdnList
Array of strings

FQDNのリスト

prefixList
Array of strings

prefixのリスト

Responses

202

Accepted

put/v1/break-out-lists/{breakOutListId}
https://api.ntt.com/sdpf-ztgict/v1/break-out-lists/{breakOutListId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "list1",
  • "fqdnList":
    [
    ],
  • "prefixList":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "breakOutListId": "550e8400e29b41d4a716446655440000",
  • "ref": "/v1/break-out-lists/550e8400e29b41d4a716446655440000",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "list1",
  • "fqdnList":
    [
    ],
  • "prefixList":
    [
    ]
}

特定通信ブレイクアウト対象リストリソース削除API

特定通信ブレイクアウト対象リストリソースを削除するAPI

  • リソースとして削除するかは課金次第
  • レコード数で課金を行うのであれば残す必要がある
path Parameters
breakOutListId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

202

Accepted

delete/v1/break-out-lists/{breakOutListId}
https://api.ntt.com/sdpf-ztgict/v1/break-out-lists/{breakOutListId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "breakOutListId": "550e8400e29b41d4a716446655440000",
  • "ref": "/v1/break-out-lists/550e8400e29b41d4a716446655440000",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "list1",
  • "fqdnList":
    [
    ],
  • "prefixList":
    [
    ]
}