SIMS - IoT Connect Mobile Type S リファレンス (2.0.0)
Download OpenAPI specification:Download
閉域接続情報参照API
閉域接続情報参照API
path Parameters
| tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
header Parameters
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: 9dc03494823a841338430052e9ee95e0 クライアントが Keystone を利用して取得した認証 Token |
Responses
200
OK
400
Bad Request
get/tenants/{tenantId}/closedNw/connection
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/closedNw/connection
Response samples
- 200
- 400
Content type
application/json
Copy
Expand all Collapse all {- "cnId": "xxxx",
- "sellerKey": "xxxx",
- "ficVlanPrimary": 1111,
- "ficVlanSecondary": 2222,
- "ficLocation": "tokyo",
- "poiRedundant": true,
- "ficRouterConnection": "paired",
- "ficRouterPrimarySegment": "192.168.0.0/30",
- "ficRouterSecondarySegment": "192.168.0.4/30",
- "ficRouterPrimaryAS": 65001,
- "ficRouterSecondaryAS": 65002,
- "profileActSegment": [
- {
- "segment": "10.0.0.0/23",
- "used": 100,
- "unused": 410
}, - {
- "segment": "10.0.2.0/23",
- "used": 5,
- "unused": 5
}
], - "profileSbySegment": [
- {
- "segment": "10.0.4.0/23",
- "used": 100,
- "unused": 410
}, - {
- "segment": "10.0.6.0/23",
- "used": 5,
- "unused": 5
}
], - "ping": "OK",
- "createdAt": "2021-01-05 18:11:11"
}閉域接続新規申し込みAPI
閉域接続新規申し込みAPI
path Parameters
| tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
header Parameters
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: 9dc03494823a841338430052e9ee95e0 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
| ficLocation required | string ^(tokyo|osaka) FIC-Connection(XaaS)の接続先エリア |
| poiRedundant required | boolean |
| ficRouterConnection required | string ^(paired|single) FIC-Connection(XaaS)における接続タイプ |
| profileActSegment required | Array of objects non-empty |
| profileSbySegment | Array of objects non-empty |
Responses
202
Accepted
400
Bad Request
post/tenants/{tenantId}/closedNw/connection
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/closedNw/connection
Request samples
- Payload
Content type
application/json
Example
example-tokyo-redundant-paired
Copy
Expand all Collapse all {- "ficLocation": "tokyo",
- "poiRedundant": true,
- "ficRouterConnection": "paired",
- "profileActSegment": [
- {
- "segment": "10.0.0.0/23"
}, - {
- "segment": "10.0.2.0/23"
}
], - "profileSbySegment": [
- {
- "segment": "10.0.4.0/23"
}, - {
- "segment": "10.0.6.0/23"
}
]
}Response samples
- 202
- 400
Content type
application/json
Example
example-tokyo-redundant-paired
Copy
Expand all Collapse all {- "cnOrderId": "cnOrder_xxxx",
- "sellerKey": "xxxx",
- "requestBody": {
- "ficLocation": "tokyo",
- "poiRedundant": true,
- "ficRouterConnection": "paired",
- "profileActSegment": [
- {
- "segment": "10.0.0.0/23"
}, - {
- "segment": "10.0.2.0/23"
}
], - "profileSbySegment": [
- {
- "segment": "10.0.4.0/23"
}, - {
- "segment": "10.0.6.0/23"
}
]
}
}閉域接続削除API
閉域接続削除API
path Parameters
| tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
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}/closedNw/connection
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/closedNw/connection
Response samples
- 400
Content type
application/json
Copy
Expand all Collapse all {- "message": "Bad Request",
- "detail": "path parameter 'tenantId' is invalid"
}profile segment参照API
当該テナントが獲得したプロファイル用IPセグメントを一覧参照するAPI
path Parameters
| tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
query Parameters
| status required | string Example: status=available availableを指定 |
| segment required | string ^(act|sby) Example: segment=act act or sbyを指定 |
header Parameters
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: 9dc03494823a841338430052e9ee95e0 クライアントが Keystone を利用して取得した認証 Token |
Responses
200
OK
400
Bad Request
get/tenants/{tenantId}/closedNw/profileSegments
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/closedNw/profileSegments
Response samples
- 200
- 400
Content type
application/json
Copy
Expand all Collapse all {- "segments": [
- {
- "segment": "10.0.4.0/23"
}, - {
- "segment": "10.0.6.0/23"
}, - {
- "segment": "10.0.8.0/23"
}
]
}profile segment用在庫参照API
割り当てられた profile segment の中の利用可能な IP アドレスを参照する API
path Parameters
| tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
| profileSegment required | string <ipv4> Example: 10.2.3.0 profileSegment のネットワークアドレス |
| prefixLength required | integer [ 0 .. 32 ] Example: 23 profileSegment のプレフィクス長 |
query Parameters
| status required | string 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}/closedNw/profileSegments/{profileSegment}/{prefixLength}/ipAddress
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/closedNw/profileSegments/{profileSegment}/{prefixLength}/ipAddress
Response samples
- 200
- 400
Content type
application/json
Copy
Expand all Collapse all {- "ipAddress": [
- {
- "ipAddress": "10.0.6.1"
}, - {
- "ipAddress": "10.0.6.2"
}
]
}閉域接続開通確認API
閉域接続開通確認API
path Parameters
| tenantId required | string |
header Parameters
| X-Auth-Token required | string ^[0-9a-f]{32}$ Example: 9dc03494823a841338430052e9ee95e0 クライアントが Keystone を利用して取得した認証 Token |
Responses
200
OK
404
Not Found
get/tenants/{tenantId}/closedNw/connection/ping
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/closedNw/connection/ping
Response samples
- 200
Content type
application/json
Copy
Expand all Collapse all {- "ficRouterPrimary": "OK",
- "ficRouterSecondary": "OK"
}