IoT Connect Gateway 仮想コネクション登録サーバー APIリファレンス (1.0.0)

Download OpenAPI specification:Download

IoT Connect Gateway 仮想コネクション登録サーバー APIリファレンス

仮想コネクション

仮想コネクションに関するAPI。

仮想コネクションを作成する

仮想コネクション登録サーバー経由で仮想コネクションを作成する。 「テナントID と 登録パスワード」もしくは「クライアントのIPアドレス情報」を用いて仮想コネクションを作成する。

Request Body schema: application/json
hardwareId
required
string [ 1 .. 64 ] characters ^[a-zA-Z0-9_-:]*$

ハードウェアID

  • テナントID内でユニークでなければならない
  • アルファベット、ハイフン(-)、アンダースコア(_)、コロン(:)のみ使用可能
tenantId
string <uuid> 32 characters

仮想コネクションを作成するテナントID

password
string [ 8 .. 64 ] characters ^[a-zA-Z0-9!"#$%&'()*+,-./;<=>?@[\]^_`{|}~]*$

該当テナントの登録パスワード

Responses

200

Created

400

Bad Request

404

Not Found

405

Method Not Allowed

422

Validation Error

500

Internal Server Error

post/v1/register
https://registry.gl1.icgw.ntt.com/v1/register

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "hardwareId": "dummy_hardware_id",
  • "tenantId": "dummy_tenant_id",
  • "password": "dummy_password"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "dummy_id",
  • "password": "dummy_password"
}