docomo business SIGN Value(閉域) APIリファレンス (1.0.0)

Download OpenAPI specification:Download

docomo business SIGN Value(閉域) APIリファレンス

Value(閉域)回線

Value(閉域)回線に関する API

SIM一覧(SIMグループ別)表示用API

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

esimStatus	string Enum: "enabled" "disabled" "deleted" 指定したeSIMステータスでプロファイルを絞り込む
profileStatus	string Enum: "inactive" "active" "suspend" "sleeping" "delete" 指定したプロファイルステータスでプロファイルを絞り込む
hsn	string Example: hsn=013AAA0026 検索に使うHSN（部分一致）
imsi	string Example: imsi=440130000096015 検索に使うIMSI（部分一致）
iccid	string Example: iccid=2234567890000002071 iccidに指定した文字を含むかでプロファイルを絞り込む（部分一致）
msisdn	string Example: msisdn=812023284118111 検索に使うMSISDN（部分一致）
cnActIpAddress	string Example: cnActIpAddress=NA cnActIpAddressに指定した文字を含むかでプロファイルを絞り込む（部分一致）
page	integer >= 1 Example: page=3 ページ数. デフォルトは1
pageSize	integer [ 1 .. 10000 ] Example: pageSize=30 1ページ中のアイテム数. デフォルトは20

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/icms/closed/sims

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"sims": 
[
{"hsn": "013AAA0026",
"eid": "89033024068002496401010005051672",
"simGrade": "normal",
"simType": "hard",
"simOrderNo": "ORDER-20201224-1056",
"additionalService": null,
"oemEncKey": null,
"oemMacKey": null,
"oemKekKey": null,
"profiles": 
[
{"imsi": "440136789000269",
"iccid": "2234567890000002071",
"msisdn": "852196310050001",
"provider": "nttc",
"profileStatus": "active",
"plan": "fixed",
"limit": null,
"totalLimit": null,
"upLimit": 1048576,
"totalUpLimit": 1048576,
"downLimit": 1048576,
"puk1": "53946056",
"puk2": "53946056",
"esimStatus": "enabled",
"cn": false,
"cnActIpAddress": null,
"cnSbyIpAddress": null,
"upStream": true,
"icgw": false,
"icgwInProgress": false,
"icgwEastIpAddress": null,
"icgwWestIpAddress": null,
"dedicatedPlan": false,
"shareName": null,
"testMode": null,
"enabledAt": null,
"testModeEndedAt": null,
"shareGroupLeftAt": null,
"globalStaticIpAddress": null,
"billingSpan": null,
"expDate": null,
"multiAccess": false,
"unoTsl": false,
"unoTslPoi1IpAddress": null,
"unoTslPoi2IpAddress": null,
"comment": "コメント"
}
],
"profileSwitching": false
},
{"hsn": "013AAA0027",
"eid": "89033024068002496401010005051673",
"simGrade": "normal",
"simType": "hard",
"simOrderNo": "ORDER-20201224-1057",
"additionalService": null,
"oemEncKey": null,
"oemMacKey": null,
"oemKekKey": null,
"profiles": 
[
{"imsi": "440136789000268",
"iccid": "2234567890000002070",
"msisdn": "852196310050000",
"provider": "nttc",
"profileStatus": "active",
"plan": "fixed",
"limit": 1048576,
"totalLimit": null,
"upLimit": null,
"totalUpLimit": null,
"downLimit": null,
"puk1": "22115413",
"puk2": "22115413",
"esimStatus": "enabled",
"cn": true,
"cnActIpAddress": "10.0.0.5",
"cnSbyIpAddress": "10.0.1.5",
"upStream": false,
"icgw": false,
"icgwInProgress": false,
"icgwEastIpAddress": null,
"icgwWestIpAddress": null,
"dedicatedPlan": false,
"shareName": null,
"testMode": null,
"enabledAt": "2020-07-07",
"testModeEndedAt": null,
"shareGroupLeftAt": null,
"globalStaticIpAddress": null,
"billingSpan": null,
"expDate": null,
"multiAccess": false,
"unoTsl": false,
"unoTslPoi1IpAddress": null,
"unoTslPoi2IpAddress": null,
"comment": null
},
{"imsi": "440136789000270",
"iccid": "2234567890000002072",
"msisdn": "852196310050002",
"provider": "nttc",
"profileStatus": "active",
"plan": "fixed",
"limit": 1048576,
"totalLimit": null,
"upLimit": null,
"totalUpLimit": null,
"downLimit": null,
"puk1": "53946057",
"puk2": "53946057",
"esimStatus": "enabled",
"cn": false,
"cnActIpAddress": null,
"cnSbyIpAddress": null,
"upStream": false,
"icgw": true,
"icgwInProgress": false,
"icgwEastIpAddress": "10.96.0.1",
"icgwWestIpAddress": "10.224.0.1",
"dedicatedPlan": false,
"shareName": null,
"testMode": false,
"enabledAt": null,
"testModeEndedAt": "2022-07-21",
"shareGroupLeftAt": "2023-03-29",
"globalStaticIpAddress": null,
"billingSpan": null,
"expDate": null,
"multiAccess": false,
"unoTsl": false,
"unoTslPoi1IpAddress": null,
"unoTslPoi2IpAddress": null
},
{"imsi": "440136789000271",
"iccid": "2234567890000002073",
"msisdn": "852196310050003",
"provider": "nttc",
"profileStatus": "active",
"plan": "fixed",
"limit": 1048576,
"totalLimit": null,
"upLimit": null,
"totalUpLimit": null,
"downLimit": null,
"puk1": "53946058",
"puk2": "53946059",
"esimStatus": "enabled",
"cn": false,
"cnActIpAddress": null,
"cnSbyIpAddress": null,
"upStream": false,
"icgw": false,
"icgwInProgress": false,
"icgwEastIpAddress": null,
"icgwWestIpAddress": null,
"dedicatedPlan": false,
"shareName": "グループA",
"testMode": true,
"enabledAt": "2020-07-07",
"testModeEndedAt": null,
"shareGroupLeftAt": "2023-03-29",
"globalStaticIpAddress": null,
"billingSpan": null,
"expDate": null,
"multiAccess": false,
"unoTsl": false,
"unoTslPoi1IpAddress": null,
"unoTslPoi2IpAddress": null,
"comment": "コメントB"
}
],
"profileSwitching": true
}
],
"total": 4,
"totalPages": 2,
"page": 1,
"pageSize": 2
}

SIM発注API

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

simType required	string Enum: "chip" "hard" SIM種別 chip:チップSIM, hard:ハードSIM
simGrade required	string Enum: "industrial" "normal" SIMグレード(Industrial:インダストリアル normal:ノーマル)
quantity required	integer [ 1 .. 20000 ] SIM枚数(simTypeが"chipSim"の場合は500-20000, simTypeがhardSimの場合は1-20000)
shippingAddressId required	string 32 characters 0-9a-f 送付先ID

Responses

202

Accepted

400

Bad Request

500

Internal Server Error

503

ServiceUnavailable

post/tenants/{tenantId}/icms/closed/sims

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"simType": "chip",
"simGrade": "industrial",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"orderId": "ORDER-20200807-0919",
"requestBody": 
{"simGroupId": "c634dd4f-8e49-4f20-a8fc-99cb6386e699",
"simType": "hard",
"simGrade": "normal",
"provider": "nttc",
"profileSwitching": false,
"quantity": 20,
"contractorName": "山田 太郎",
"shippingPostalCode": "100-0004",
"shippingPrefecture": "東京都",
"shippingCity": "千代田区",
"shippingCityAdditionalInfo": "大字通称",
"shippingAddress": "大手町2-3-1",
"shippingBuilding": "大手町プレイスウェストタワー31F",
"packageRecipient": "情報システム部 田中太郎",
"packageRecipientCompany": "NTT",
"phoneNumber": "000-0000-0000",
"contractorEmailAddress": "example@ntt.com"
}
}

SIM情報参照API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/icms/closed/sims/{hsn}

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"eid": "89033024063202496400000008151710",
"simGrade": "industrial",
"simType": "chip",
"simOrderNo": "ORDER-20200807-0913",
"profileSwitching": true
}

SIM廃止API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

delete/tenants/{tenantId}/icms/closed/sims/{hsn}

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tid": "tran-sdp-20230215-004900-0040"
}

SIMに紐付くProfile一覧参照API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"profiles": 
[
{"imsi": "440130000096015"
}
]
}

SIMを中断するAPI

SIMを中断状態にするAPI

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/suspend

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/suspend

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tid": "tran-20200807-00007",
"requestBody": 
{"hsn": "013AAA0025",
"imsi": "440130000096015"
}
}

SIMを再開するAPI

中断状態のSIMを再開させるAPI

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/resume

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/resume

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tid": "tran-20200807-00007",
"requestBody": 
{"hsn": "013AAA0025",
"imsi": "440130000096015"
}
}

料金プラン上限値変更API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

limit

required

integer

制限容量（KB単位）

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/policy

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/policy

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"plan": "fixed",
"limit": 1048576
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"tid": "tran-20200807-00007",
"requestBody": 
{"hsn": "013AAA0025",
"imsi": "440130000096015",
"plan": "fixed",
"limit": 1048576
}
}

プロファイル情報参照API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

get/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"iccid": "8981120000000830180",
"msisdn": "812023284118111",
"provider": "nttc",
"profileStatus": "active",
"esimStatus": "enabled",
"plan": "fixed",
"limit": "0,",
"upLimit": "null,",
"downLimit": "null,",
"puk1": "53946058",
"puk2": "53946058",
"cn": "true,",
"cnActIpAddress": "10.0.1.5",
"cnSbyIpAddress": "10.0.2.5",
"upStream": false,
"icgw": false,
"icgwInProgress": false,
"icgwEastIpAddress": null,
"icgwWestIpAddress": null,
"shareId": null,
"billingSpan": null,
"expDate": null,
"multiAccess": false,
"unoTsl": false,
"unoTslPoi1IpAddress": null,
"unoTslPoi2IpAddress": null,
"simGroupId": "dfec0e39-3edf-4a39-bcb3-aab8e627a0ee"
}

プロファイル開通API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

limit required	integer 制限容量（KB単位）
cnActIpAddress required	string NTTC閉域接続の場合は必須

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/activate

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/activate

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"limit": 1048576,
"cnActIpAddress": "10.0.1.5"
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"tid": "tran-20200807-00003",
"requestBody": 
{"hsn": "013AAA0025",
"imsi": "440130000096015",
"plan": "fixed",
"limit": 1048576,
"cn": false,
"icgw": true,
"unoTsl": false
}
}

プロファイル利用中断API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/sleep

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/sleep

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tid": "tran-20200807-00003",
"requestBody": 
{"hsn": "013AAA0025",
"imsi": "440130000096015"
}
}

プロファイル利用再開API

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/wake

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/wake

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tid": "tran-20200807-00003",
"requestBody": 
{"hsn": "013AAA0025",
"imsi": "440130000096015"
}
}

容量追加

プロファイルに容量を追加するAPI

path Parameters

tenantId required	string 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
hsn required	string 10 characters 0-9A-F Example: 013AAA0025 ハードウェアシリアル番号(HSN)
imsi required	string [ 1 .. 15 ] characters 0-9 Example: 440130000096015 IMSI

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

limit

required

integer

追加する容量（KB単位）

Responses

200

400

Bad Request

500

Internal Server Error

post/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/add-limit

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/sims/{hsn}/profiles/{imsi}/add-limit

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"limit": 102400
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tid": "tran-sdp-20230215-004900-0040",
"requestBody": 
{"limit": "102400"
}
}

上限値参照API

料金プラン "fixed" の上限値参照API

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/icms/policies

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/policies

Response samples

Content type

application/json

Copy

Expand all Collapse all

追加容量一覧取得

可能な追加容量の一覧を参照するAPI

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/icms/limit-pattern

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/limit-pattern

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"limits": 
[102400,
1048576,
5242880
]
}

NTTC閉域接続情報参照API

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

409

Conflict

500

Internal Server Error

get/tenants/{tenantId}/icms/closed/connection

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/connection

Response samples

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
}
],
"profileSbySegment": 
[
{"segment": "10.0.2.0/23",
"used": 5,
"unused": 5
}
],
"ping": "OK",
"createdAt": "string"
}

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

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

profileActSegment

required

Array of objects

Responses

202

Accepted

400

Bad Request

409

Conflict

500

Internal Server Error

post/tenants/{tenantId}/icms/closed/connection

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/connection

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"profileActSegment": 
[
{"segment": "10.0.0.0/23"
},
{"segment": "10.0.2.0/23"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"cnOrderId": "cnOrder_xxxx",
"sellerKey": "xxxx",
"requestBody": 
{"ficLocation": "tokyo",
"poiRedundant": false,
"ficRouterConnection": "paired",
"profileActSegment": 
[
{"segment": "10.0.0.0/23"
},
{"segment": "10.0.2.0/23"
}
]
}
}

NTTC閉域接続削除API

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

204

No Content

400

Bad Request

500

Internal Server Error

delete/tenants/{tenantId}/icms/closed/connection

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/connection

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"errorCode": 10104,
"errorMessages": 
["path parameter 'hsn' is invalid"
]
}

NTTC閉域接続開通確認API

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/icms/closed/connection/ping

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/connection/ping

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ficRouterPrimary": "OK",
"ficRouterSecondary": "OK"
}

Profile Segment参照API

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

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

status

required

string

Example: status=available

availableを指定

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/icms/closed/profile-segments

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/profile-segments

Response samples

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利用可能IPアドレス取得

NTTC閉域接続新規申し込みにて割り当てられたプロファイル用IPセグメントの中の利用可能なIPアドレスを参照するAPI

path Parameters

tenantId

required

string 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/icms/closed/segments

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/icms/closed/segments

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"segments": 
[
{"segment": "10.0.4.0/23",
"ipAddresses": 
["10.0.4.1",
"10.0.4.2",
"10.0.4.3"
]
},
{"segment": "10.0.6.0/23",
"ipAddresses": 
["10.0.6.1",
"10.0.6.2",
"10.0.6.3"
]
},
{"segment": "10.0.8.0/23",
"ipAddresses": 
["10.0.8.1",
"10.0.8.2",
"10.0.8.3"
]
}
]
}