Documentation Powered by ReDoc

SIMS - IoT Connect Mobile Type S リファレンス (3.0.0)

Download OpenAPI specification:Download

URL: https://developer.ntt.com/ License: © 2020 NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

概要

本APIでは、IoT Connect Mobile Type S に関するリソースの参照・操作が可能です。

TSL Closed Network

TSL閉域(UNO)接続に関するAPI

TSL閉域接続情報参照API

TSL閉域接続情報参照API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

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

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

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/unoTslNw-connection/self-only
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/unoTslNw-connection/self-only

Response samples

Content type
application/json
Example
example-1
Copy
 Expand all Collapse all
{
  • "unoTslId": "1001",
  • "unoRouterPrimarySegment": "192.168.0.0/30",
  • "unoRouterSecondarySegment": "192.168.0.4/30",
  • "profilePoi1Segment":
    [
    ],
  • "profilePoi2Segment":
    [
    ],
  • "ping": "OK",
  • "createdAt": "2024-01-05 18:11:11"
}

TSL閉域接続新規申し込みAPI

TSL閉域接続新規申し込みAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

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

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

Request Body schema: application/json
profilePoi1Segment
required
Array of strings non-empty
profilePoi2Segment
required
Array of strings non-empty
unoRouterPrimarySegment
required
string

Primary側のIPアドレスセグメント

unoRouterSecondarySegment
required
string

Secondary側のIPアドレスセグメント

Responses

202

Accepted

400

Bad Request

post/tenants/{tenantId}/unoTslNw-connection/self-only
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/unoTslNw-connection/self-only

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "profilePoi1Segment":
    [
    ],
  • "profilePoi2Segment":
    [
    ],
  • "unoRouterPrimarySegment": "192.168.0.0/30",
  • "unoRouterSecondarySegment": "192.168.0.4/30"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "unoTslOrderId": "cnOrder_tsl_xxxx",
  • "vlanId": "xxxx",
  • "requestBody":
    {
    }
}

TSL閉域接続削除API

TSL閉域接続削除API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

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

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

Responses

204

No Content

400

Bad Request

delete/tenants/{tenantId}/unoTslNw-connection/self-only
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/unoTslNw-connection/self-only

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "Bad Request",
  • "detail": "path parameter 'tenantId' is invalid"
}

TSL閉域接続開通確認API

TSL閉域接続開通確認API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

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

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

Responses

200

OK

400

Bad Request | すでに開通確認済みの場合

404

Not Found

get/tenants/{tenantId}/unoTslNw-connection/ping
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/unoTslNw-connection/ping

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "unoRouterPrimarySegment": "OK",
  • "unoRouterSecondarySegment": "OK"
}

Profile Segment用在庫参照API（TSL閉域）

割り当てられた profile segment の中の利用可能な IP アドレスを参照する API（TSL閉域）

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

profileSegment
required
string <ipv4>
Example: 10.32.0.0

profileSegment のネットワークアドレス

prefixLength
required
integer [ 0 .. 32 ]
Example: 23

profileSegment のプレフィクス長

query Parameters
status
required
any
Value: "available"
Example: status=available

IPアドレスのステータス

segmentType
required
any
Enum: "poi1" "poi2"
Example: segmentType=poi1

プロファイル用IPセグメントの種別

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

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

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/unoTslNw-profileSegments/ipAddress/{profileSegment}/{prefixLength}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/unoTslNw-profileSegments/ipAddress/{profileSegment}/{prefixLength}

Response samples

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

Profile Segment参照API

当該テナントが獲得したプロファイル用IPセグメントを一覧参照するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

query Parameters
segmentType
required
any
Enum: "poi1" "poi2"
Example: segmentType=poi1

プロファイル用IPセグメントの種別

status
required
any
Value: "available"
Example: status=available

availableを指定

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

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

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/unoTslNw-profileSegments/self-only
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/unoTslNw-profileSegments/self-only

Response samples

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