Documentation Powered by ReDoc

IoT Connect Gateway SDP APIリファレンス (1.0.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com License: © 2021-2025 NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

IoT Connect Gateway SDP APIリファレンス

SIM

デバイス管理のSIMに関するAPI

SIMの一覧情報を取得する

SIMの一覧情報を取得する

path Parameters
tenantId
required
string ^[0-9a-fA-F]{32}$

テナントID

query Parameters
imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI（部分一致）

imei
string
Example: imei=NA

検索に使うIMEI（部分一致）

msisdn
string
Example: msisdn=NA

検索に使うMSISDN（部分一致）

deviceName
string
Example: deviceName=dummy_device_name

検索に使うデバイス名（部分一致）

ipAddress
string <ipv4>
Example: ipAddress=dummy_ip_address

検索に使うIPアドレス（部分一致）

systemId
string
Example: systemId=dummy_system_id

検索に使うシステムID（部分一致）

mqttClientId
string
Example: mqttClientId=dummy_mqtt_client_id

検索に使うMQTTクライアントID（部分一致）

hsn
string
Example: hsn=dummy_hsn

検索に使うHSN（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

azureDeviceId
string
Example: azureDeviceId=dummy_azure_device_id

検索に使うAzureデバイスID（部分一致）

gcpDeviceId
string
Example: gcpDeviceId=dummy_gcp_device_id

検索に使うGCPデバイスID（部分一致）

standardDeviceId
string
Example: standardDeviceId=dummy_standard_device_id

検索に使うスタンダードデバイスID（部分一致）

description
string
Example: description=This is sample

検索に使う詳細情報（部分一致）

appletInfo
boolean
Example: appletInfo=false

eSIMアプレットステータス

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/sims
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "sims":
    [
    ]
}

SIMの詳細情報を取得する

SIMの詳細情報を取得する

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

テナントID

imsi
required
string
Example: dummy_imsi

IMSI

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/sims/{imsi}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims/{imsi}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imsi": "dummy_imsi",
  • "imei": "NA",
  • "msisdn": "NA",
  • "deviceName": "dummy_device_name",
  • "ipAddresses":
    [
    ],
  • "groupId": "dummy_group_id",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "gcpDeviceId": "dummy_gcp_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "activation": true,
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA",
  • "description": "dummy_sim",
  • "appletInfo":
    {
    }
}

SIMを更新する

SIMを更新する

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

テナントID

imsi
required
string
Example: dummy_imsi

IMSI

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
  • imei、msisdn、deviceName、optionData1、optionData2、optionData3がnullの場合はNAが自動的に入力される
imei
string [ 1 .. 16 ] characters ^[0-9]+$

IMEI

msisdn
string [ 1 .. 15 ] characters ^[0-9]+$

MSISDN

deviceName
string <= 100 characters ^\S*$

デバイス名 (空白類文字列は含められない)

groupId
string ^[0-9a-f]{24}$

グループID

systemId
string <= 10 characters

システムID

mqttClientId
string <= 24 characters

MQTTクライアントID

azureDeviceId
string <= 24 characters

AzureデバイスID

gcpDeviceId
string <= 24 characters

GCPデバイスID

standardDeviceId
string <= 24 characters

スタンダードデバイスID

optionData1
string <= 256 characters

予備

optionData2
string <= 256 characters

予備

optionData3
string <= 256 characters

予備

description
string <= 200 characters

説明

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/sims/{imsi}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims/{imsi}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imei": "dummy_imei",
  • "msisdn": "dummy_msisdn",
  • "deviceName": "dummy_device_id",
  • "groupId": "dummy_group_id",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "gcpDeviceId": "dummy_gcp_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA",
  • "description": "dummy_sim"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imsi": "dummy_imsi",
  • "imei": "NA",
  • "msisdn": "NA",
  • "deviceName": "dummy_device_name",
  • "ipAddresses":
    [
    ],
  • "groupId": "dummy_group_id",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "gcpDeviceId": "dummy_gcp_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "activation": true,
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA",
  • "description": "dummy_sim",
  • "appletInfo":
    {
    }
}

Applet情報を取得する

該当IMSIのApplet情報を取得

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

テナントID

imsi
required
string
Example: dummy_imsi

IMSI

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/sims/{imsi}/appletInfo
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims/{imsi}/appletInfo

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imsi": "123456789012345",
  • "imei": "123456789012345",
  • "msisdn": "123456789012345",
  • "iccid": "1234567890123456789F",
  • "languageIndication": "1A23",
  • "rsrp": -100,
  • "rsrq": -10,
  • "locationInfo":
    {
    },
  • "geolocationInfo":
    {
    },
  • "appletState": "01",
  • "createdAt": "2022-12-01T01:43:28.400Z"
}

Applet情報の位置情報を更新する

該当IMSIのApplet情報の位置情報を更新する

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

テナントID

imsi
required
string
Example: dummy_imsi

IMSI

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

post/tenants/{tenantId}/sims/{imsi}/appletInfo/geolocation/refresh
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/sims/{imsi}/appletInfo/geolocation/refresh

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "UNCHANGED",
  • "message": "Geolocation remains unchanged."
}

SIMのログ機能の有効化状況を取得する

SIMのログ機能の有効化状況を取得する

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

テナントID

query Parameters
imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI（部分一致、カンマ区切りで複数指定可能）

enabled
string
Enum: "true" "false"
Example: enabled=true

検索に使うenabled

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/logs/sim-activate
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/logs/sim-activate

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "activate":
    [
    ]
}

SIMのログ機能を有効化する

SIMのログ機能を有効化する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
activate
Array of objects non-empty

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/logs/sim-activate
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/logs/sim-activate

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "activate":
    {
    }
}

モニタリング

データ利用量に関するAPI

全てのSIMの利用量を取得する

全てのSIMの利用量を取得する

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

テナントID

query Parameters
month
string
Default: "当月"
Example: month=2021-10

取得対象月

imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/usages/sims
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/usages/sims

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "month": "2022-12",
  • "tenantId": "dummy_tenant_id",
  • "sims":
    [
    ]
}

SIMの利用量を取得する

SIMの利用量を取得する

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

テナントID

imsi
required
string
Example: dummy_imsi

IMSI

query Parameters
month
string
Default: "当月"
Example: month=2021-10

取得対象月

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/usages/sims/{imsi}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/usages/sims/{imsi}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "month": "2022-12",
  • "tenantId": "dummy_tenant_id",
  • "sims":
    {
    }
}

ユーザーの利用量を取得する

ユーザーの利用量を取得する

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

テナントID

query Parameters
from
required
string <date>
Example: from=2021-10-18

取得期間の開始日

to
required
string <date>
Example: to=2021-10-19

取得期間の終了日

groupId
string
Example: groupId=dummy_group_id_1,dummy_group_id_2

検索に使うグループID（カンマ区切りで複数指定可能）

imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI（部分一致）

type
string
Enum: "pconv" "event" "func" "storage" "config"
Example: type=pconv,event

検索に使う機能種別（カンマ区切りで複数指定可能）

cloudType
string
Enum: "gcp" "aws" "azure" "things" "standard-http" "standard-mqtt/aws" "wasabi" "others" "icgw" "standard-tcp"
Example: cloudType=gcp,aws

検索に使うクラウド種別（カンマ区切りで複数指定可能）

protocol
string
Enum: "http" "mqtt" "tcp"
Example: protocol=http

検索に使うプロトコル

deviceGroupId
string
Example: deviceGroupId=dummy_device_group_id1,dummy_device_group_id2

検索に使うデバイスグループID（カンマ区切りで複数指定可能）

vconnId
string
Example: vconnId=dummy_vconn_id

検索に使う仮想コネクションID（部分一致）

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/usages/daily
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/usages/daily

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "dummy_tenant_id",
  • "usages":
    [
    ]
}

全てのvConnの利用量を取得する

全てのvConnの利用量を取得する

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

テナントID

query Parameters
vconnId
string
Example: vconnId=dummy_vconn_id

検索に使う仮想コネクションID（部分一致）

month
string
Default: "当月"
Example: month=2021-10

取得対象月

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/usages/vconns
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/usages/vconns

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "month": "2022-12",
  • "tenantId": "dummy_tenant_id",
  • "vconns":
    [
    ]
}

vConnの利用量を取得する

vConnの利用量を取得する

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

テナントID

vconnId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_vconn_id

仮想コネクションID

query Parameters
month
string
Default: "当月"
Example: month=2021-10

取得対象月

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/usages/vconns/{vconnId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/usages/vconns/{vconnId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "month": "2022-12",
  • "tenantId": "dummy_tenant_id",
  • "vconns":
    {
    }
}

認証

クラウドサービス接続の認証に関するAPI

認証の一覧情報を取得する

認証の一覧情報を取得する

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

テナントID

query Parameters
type
string
Enum: "azure-iot-credentials" "x.509-credentials" "pre-shared-key-id" "azure-sap-credentials" "gcp-sa-credentials" "aws-credentials" "things-iot-credentials" "azure-function-key" "things-iot-device-registration-credentials"
Example: type=aws-credentials

検索に使う認証種別

name
string
Example: name=sample

検索に使う名前（部分一致）

description
string
Example: description=This is sample

検索に使う詳細情報（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/authentications
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/authentications

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "authentications":
    [
    ]
}

認証を登録する

認証を登録する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • X509CredentialParams
  • AzureIotCredentialParams
  • PresharedkeyParams
  • AzureSapCredentialParams
  • GcpSaCredentialParams
  • AwsCredentialParams
  • ThingsIotCredentialParams
  • AzureFunctionKeyParams
  • ThingsIotDeviceRegistrationCredentialParams
type
required
string
Value: "x.509-credentials"

認証種別

name
string <= 50 characters

認証名

description
string <= 200 characters
Default: "X.509"

詳細情報

privateKey
required
string [ 1 .. 5000 ] characters

秘密鍵

rootCaCertificate
string [ 1 .. 5000 ] characters

ルートCA

tlsCertificate
required
string [ 1 .. 5000 ] characters

TLS証明書

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/authentications
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/authentications

Request samples

Content type
application/json
Example
x.509-credentials
Copy
 Expand all Collapse all
{
  • "type": "x.509-credentials",
  • "name": "AWS certificate",
  • "description": "For testing only",
  • "privateKey": "dummy_private_key",
  • "rootCaCertificate": "dummy_root_ca_certificate",
  • "tlsCertificate": "dummy_tls_certificate"
}

Response samples

Content type
application/json
Example
x.509-credentials
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "type": "x.509-credentials",
  • "name": "AWS certificate",
  • "description": "For testing only",
  • "privateKey": "dummy_private_key",
  • "rootCaCertificate": "dummy_root_ca_certificate",
  • "tlsCertificate": "dummy_tls_certificate"
}

認証の詳細情報を取得する

認証の詳細情報を取得する

path Parameters
authenticationId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_authentication_id

認証ID

tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/authentications/{authenticationId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/authentications/{authenticationId}

Response samples

Content type
application/json
Example
x.509-credentials
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "type": "x.509-credentials",
  • "name": "AWS certificate",
  • "description": "For testing only",
  • "privateKey": "dummy_private_key",
  • "rootCaCertificate": "dummy_root_ca_certificate",
  • "tlsCertificate": "dummy_tls_certificate"
}

認証を更新する

認証を更新する

path Parameters
authenticationId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_authentication_id

認証ID

tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • X509CredentialParams
  • AzureIotCredentialParams
  • PresharedkeyParams
  • AzureSapCredentialParams
  • GcpSaCredentialParams
  • AwsCredentialParams
  • ThingsIotCredentialParams
  • AzureFunctionKeyParams
  • ThingsIotDeviceRegistrationCredentialParams
type
required
string
Value: "x.509-credentials"

認証種別

name
string <= 50 characters

認証名

description
string <= 200 characters
Default: "X.509"

詳細情報

privateKey
required
string [ 1 .. 5000 ] characters

秘密鍵

rootCaCertificate
string [ 1 .. 5000 ] characters

ルートCA

tlsCertificate
required
string [ 1 .. 5000 ] characters

TLS証明書

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/authentications/{authenticationId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/authentications/{authenticationId}

Request samples

Content type
application/json
Example
x.509-credentials
Copy
 Expand all Collapse all
{
  • "type": "x.509-credentials",
  • "name": "AWS certificate",
  • "description": "For testing only",
  • "privateKey": "dummy_private_key",
  • "rootCaCertificate": "dummy_root_ca_certificate",
  • "tlsCertificate": "dummy_tls_certificate"
}

Response samples

Content type
application/json
Example
x.509-credentials
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "type": "x.509-credentials",
  • "name": "AWS certificate",
  • "description": "For testing only",
  • "privateKey": "dummy_private_key",
  • "rootCaCertificate": "dummy_root_ca_certificate",
  • "tlsCertificate": "dummy_tls_certificate"
}

認証を削除する

認証を削除する

path Parameters
authenticationId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_authentication_id

認証ID

tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/authentications/{authenticationId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/authentications/{authenticationId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

グループ

クラウドサービス接続のグループに関するAPI

グループの一覧情報を取得する

グループの一覧情報を取得する

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

テナントID

query Parameters
groupId
string
Example: groupId=dummy_group_id

検索に使うグループID（部分一致）

name
string
Example: name=sample

検索に使う名前（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "groups":
    [
    ]
}

グループを登録する

グループを登録する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

グループ名

sims
Array of strings (Imsi)
vconns
Array of strings

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/groups
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "sample",
  • "sims":
    [
    ],
  • "vconns":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "sample",
  • "sims":
    [
    ],
  • "vconns":
    [
    ]
}

グループの詳細情報を取得する

グループの詳細情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "sample",
  • "sims":
    [
    ],
  • "vconns":
    [
    ]
}

グループを更新する

グループを更新する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

グループ名

sims
Array of strings (Imsi)
vconns
Array of strings

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/groups/{groupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "sample",
  • "sims":
    [
    ],
  • "vconns":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "sample",
  • "sims":
    [
    ],
  • "vconns":
    [
    ]
}

グループを削除する

グループを削除する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/groups/{groupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

グループからSIMを削除する

グループからSIMを削除する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

imsi
required
string
Example: dummy_imsi

IMSI

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/groups/{groupId}/sims/{imsi}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/sims/{imsi}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

グループから仮想コネクションを削除する

グループから仮想コネクションを削除する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

vconnId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_vconn_id

仮想コネクションID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/groups/{groupId}/vconns/{vconnId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/vconns/{vconnId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

スタンダード機能

クラウドサービス接続のスタンダード機能に関するAPI

スタンダード機能の一覧情報を取得する

スタンダード機能の一覧情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

query Parameters
page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/pconv
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/pconv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "pconv":
    [
    ]
}

スタンダード機能を登録する

スタンダード機能を登録する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AzureIotMqttRequestParams
  • StandardMqttRequestParams
  • ThingsIotMqttRequestParams
  • AwsIotHttpRequestParams
  • AzureIotHttpRequestParams
  • StandardHttpRequestParams
  • ThingsIotHttpRequestParams
  • StandardHttpTcpRequestParams
  • AwsIotTcpRequestParams
  • AzureIotTcpRequestParams
  • ThingsIotTcpRequestParams
  • StandardTcpRequestParams
enabled
boolean
Default: true

有効/無効

name
required
string [ 1 .. 50 ] characters

スタンダード機能名

type
required
string
Value: "mqtt"

変換タイプ

destination
required
object
options
object
fconvId
string Nullable ^[0-9a-f]{24}$

フォーマット変換テンプレートID

appletInfo
object

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/groups/{groupId}/pconv
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/pconv

Request samples

Content type
application/json
Example
AzureIotMqttRequestParams
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "name": "sample",
  • "type": "mqtt",
  • "destination":
    {
    },
  • "options":
    {
    },
  • "fconvId": "string",
  • "appletInfo":
    {
    }
}

Response samples

Content type
application/json
Example
AzureIotMqttResponseParams
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "enabled": true,
  • "name": "sample",
  • "type": "mqtt",
  • "destination":
    {
    },
  • "options":
    {
    },
  • "fconvId": "string",
  • "appletInfo":
    {
    }
}

スタンダード機能の詳細情報を取得する

スタンダード機能の詳細情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

pconvId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_pconv_id

スタンダード機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/pconv/{pconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/pconv/{pconvId}

Response samples

Content type
application/json
Example
AzureIotMqttResponseParams
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "type": "mqtt",
  • "name": "Sample AZURE MQTT",
  • "enabled": true,
  • "destination":
    {
    },
  • "options":
    {
    },
  • "fconvId": "dummy_fconv_id",
  • "appletInfo":
    {
    }
}

スタンダード機能を更新する

スタンダード機能を更新する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

pconvId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_pconv_id

スタンダード機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AzureIotMqttRequestParams
  • StandardMqttRequestParams
  • ThingsIotMqttRequestParams
  • AwsIotHttpRequestParams
  • AzureIotHttpRequestParams
  • StandardHttpRequestParams
  • ThingsIotHttpRequestParams
  • StandardHttpTcpRequestParams
  • AwsIotTcpRequestParams
  • AzureIotTcpRequestParams
  • ThingsIotTcpRequestParams
  • StandardTcpRequestParams
enabled
boolean
Default: true

有効/無効

name
required
string [ 1 .. 50 ] characters

スタンダード機能名

type
required
string
Value: "mqtt"

変換タイプ

destination
required
object
options
object
fconvId
string Nullable ^[0-9a-f]{24}$

フォーマット変換テンプレートID

appletInfo
object

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/groups/{groupId}/pconv/{pconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/pconv/{pconvId}

Request samples

Content type
application/json
Example
AzureIotMqttRequestParams
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "name": "sample",
  • "type": "mqtt",
  • "destination":
    {
    },
  • "options":
    {
    },
  • "fconvId": "string",
  • "appletInfo":
    {
    }
}

Response samples

Content type
application/json
Example
AzureIotMqttResponseParams
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "enabled": true,
  • "name": "sample",
  • "type": "mqtt",
  • "destination":
    {
    },
  • "options":
    {
    },
  • "fconvId": "string",
  • "appletInfo":
    {
    }
}

スタンダード機能を削除する

スタンダード機能を削除する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

pconvId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_pconv_id

スタンダード機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/groups/{groupId}/pconv/{pconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/pconv/{pconvId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

イベント機能

クラウドサービス接続のイベント機能に関するAPI

イベント機能の一覧情報を取得する

イベント機能の一覧情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

query Parameters
page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/event
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/event

Response samples

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

イベント機能を登録する

イベント機能を登録する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AzureEventHubsRequestParams
  • GcpPubsubRequestParams
enabled
boolean
Default: true

有効/無効

name
required
string [ 1 .. 50 ] characters

イベント機能名

entrypoint
required
object
destination
required
object
headers
object
fconvId
string Nullable ^[0-9a-f]{24}$

フォーマット変換テンプレートID

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/groups/{groupId}/event
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/event

Request samples

Content type
application/json
Example
gcp-pubsub
Copy
 Expand all Collapse all
{
  • "name": "Sample GCP PubSub",
  • "entrypoint":
    {
    },
  • "destination":
    {
    }
}

Response samples

Content type
application/json
Example
gcp-pubsub
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "Sample GCP PubSub",
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    },
  • "fconvId": "dummy_fconv_id"
}

イベント機能の詳細情報を取得する

イベント機能の詳細情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

eventId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_event_id

イベント機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/event/{eventId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/event/{eventId}

Response samples

Content type
application/json
Example
gcp-pubsub
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "Sample GCP PubSub",
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    },
  • "fconvId": "dummy_fconv_id"
}

イベント機能を更新する

イベント機能を更新する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

eventId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_event_id

イベント機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AzureEventHubsRequestParams
  • GcpPubsubRequestParams
enabled
boolean
Default: true

有効/無効

name
required
string [ 1 .. 50 ] characters

イベント機能名

entrypoint
required
object
destination
required
object
headers
object
fconvId
string Nullable ^[0-9a-f]{24}$

フォーマット変換テンプレートID

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

put/tenants/{tenantId}/groups/{groupId}/event/{eventId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/event/{eventId}

Request samples

Content type
application/json
Example
gcp-pubsub
Copy
 Expand all Collapse all
{
  • "name": "Sample GCP PubSub",
  • "entrypoint":
    {
    },
  • "destination":
    {
    }
}

Response samples

Content type
application/json
Example
gcp-pubsub
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "Sample GCP PubSub",
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    },
  • "fconvId": "dummy_fconv_id"
}

イベント機能を削除する

イベント機能を削除する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

eventId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_event_id

イベント機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

No Content

401

Internal Server Error

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/groups/{groupId}/event/{eventId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/event/{eventId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

ファンクション機能

クラウドサービス接続のファンクション機能に関するAPI

ファンクション機能の一覧情報を取得する

ファンクション機能の一覧情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

query Parameters
page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/func
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/func

Response samples

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

ファンクション機能を登録する

ファンクション機能を登録する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AzureFunctionKeyFunctionRequestParams
  • AwsLambdaFunctionRequestParams
  • GcpFunctionsFunctionRequestParams
enabled
boolean
Default: true

有効/無効

name
required
string [ 1 .. 50 ] characters

ファンクション機能名

entrypoint
required
object
destination
required
object
metadata
object
fconvId
string Nullable ^[0-9a-f]{24}$

フォーマット変換テンプレートID

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/groups/{groupId}/func
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/func

Request samples

Content type
application/json
Example
aws-lambda
Copy
 Expand all Collapse all
{
  • "name": "Sample AWS Lambda",
  • "entrypoint":
    {
    },
  • "destination":
    {
    }
}

Response samples

Content type
application/json
Example
aws-lambda
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "Sample AWS Lambda",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    },
  • "fconvId": "dummy_fconv_id"
}

ファンクション機能の詳細情報を取得する

ファンクション機能を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

funcId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_func_id

ファンクション機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/func/{funcId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/func/{funcId}

Response samples

Content type
application/json
Example
aws-lambda
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "Sample AWS Lambda",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    },
  • "fconvId": "dummy_fconv_id"
}

ファンクション機能を更新する

ファンクション機能を更新する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

funcId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_func_id

ファンクション機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AzureFunctionKeyFunctionRequestParams
  • AwsLambdaFunctionRequestParams
  • GcpFunctionsFunctionRequestParams
enabled
boolean
Default: true

有効/無効

name
required
string [ 1 .. 50 ] characters

ファンクション機能名

entrypoint
required
object
destination
required
object
metadata
object
fconvId
string Nullable ^[0-9a-f]{24}$

フォーマット変換テンプレートID

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

put/tenants/{tenantId}/groups/{groupId}/func/{funcId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/func/{funcId}

Request samples

Content type
application/json
Example
aws-lambda
Copy
 Expand all Collapse all
{
  • "name": "Sample AWS Lambda",
  • "entrypoint":
    {
    },
  • "destination":
    {
    }
}

Response samples

Content type
application/json
Example
aws-lambda
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "name": "Sample AWS Lambda",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    },
  • "fconvId": "dummy_fconv_id"
}

ファンクション機能を削除する

ファンクション機能を削除する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

funcId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_func_id

ファンクション機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/groups/{groupId}/func/{funcId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/func/{funcId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

ストレージ機能

クラウドサービス接続のストレージ機能に関するAPI

ストレージ機能の一覧情報を取得する

ストレージ機能の一覧情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

query Parameters
page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/storage
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/storage

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "storage":
    [
    ]
}

ストレージ機能を登録する

ストレージ機能を登録する

  • typeキーのデフォルト値はhttp
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AwsS3HttpRequestParams
  • AwsS3TcpRequestParams
type
string
Default: "http"
Value: "http"

変換タイプ

name
required
string [ 1 .. 50 ] characters

ストレージ機能名

enabled
boolean
Default: true

有効/無効

entrypoint
required
object
destination
required
object
metadata
object

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/groups/{groupId}/storage
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/storage

Request samples

Content type
application/json
Example
AwsS3HttpRequestParams
Copy
 Expand all Collapse all
{
  • "type": "http",
  • "name": "sample",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
Example
AwsS3HttpResponseParams
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "type": "http",
  • "name": "dummy_name",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    }
}

ストレージ機能の詳細情報を取得する

ストレージ機能の詳細情報を取得する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

storageId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_storage_id

ストレージ機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/groups/{groupId}/storage/{storageId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/storage/{storageId}

Response samples

Content type
application/json
Example
AwsS3HttpResponseParams
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "type": "http",
  • "name": "dummy_name",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    }
}

ストレージ機能を更新する

ストレージ機能を更新する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

storageId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_storage_id

ストレージ機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • AwsS3HttpRequestParams
  • AwsS3TcpRequestParams
type
string
Default: "http"
Value: "http"

変換タイプ

name
required
string [ 1 .. 50 ] characters

ストレージ機能名

enabled
boolean
Default: true

有効/無効

entrypoint
required
object
destination
required
object
metadata
object

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/groups/{groupId}/storage/{storageId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/storage/{storageId}

Request samples

Content type
application/json
Example
AwsS3HttpRequestParams
Copy
 Expand all Collapse all
{
  • "type": "http",
  • "name": "sample",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
Example
AwsS3HttpResponseParams
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "type": "http",
  • "name": "dummy_name",
  • "enabled": true,
  • "entrypoint":
    {
    },
  • "destination":
    {
    },
  • "metadata":
    {
    }
}

ストレージ機能を削除する

ストレージ機能を削除する

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

テナントID

groupId
required
string ^[0-9a-f]{24}$
Example: dummy_group_id

グループID

storageId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_storage_id

ストレージ機能ID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/groups/{groupId}/storage/{storageId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/groups/{groupId}/storage/{storageId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

テンプレート

コンフィグマネージャーのテンプレートに関するAPI

テンプレートの一覧情報を取得する

テンプレートの一覧情報を取得する

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

テナントID

query Parameters
name
string
Example: name=sample

検索に使う名前（部分一致）

labels
string
Example: labels=label1,label2

検索に使うラベル（部分一致, カンマ区切りで複数指定可能）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/templates
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/templates

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "templates":
    [
    ]
}

テンプレートを登録する

テンプレートを登録する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

テンプレート名

labels
Array of strings [ 1 .. 10 ] items Nullable

ラベル(コンマは含められない)

description
string <= 200 characters

説明

content
required
string <Jinja2-string> [ 1 .. 10485760 ] characters

コンテンツ

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/templates
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/templates

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_template",
  • "labels":
    [
    ],
  • "description": "dummy_template",
  • "content": "dummy_content"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_template_id",
  • "name": "dummy_template",
  • "labels":
    [
    ],
  • "description": "dummy_template",
  • "content": "dummy_content",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

テンプレートの詳細情報を取得する

テンプレートの詳細情報を取得する

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

テナントID

templateId
required
string ^[0-9a-f]{24}$
Example: dummy_template_id

テンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/templates/{templateId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/templates/{templateId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_template_id",
  • "name": "dummy_template",
  • "labels":
    [
    ],
  • "description": "dummy_template",
  • "content": "dummy_content",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

テンプレートを更新する

テンプレートを更新する

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

テナントID

templateId
required
string ^[0-9a-f]{24}$
Example: dummy_template_id

テンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

テンプレート名

labels
Array of strings [ 1 .. 10 ] items Nullable

ラベル(コンマは含められない)

description
string <= 200 characters

説明

content
required
string <Jinja2-string> [ 1 .. 10485760 ] characters

コンテンツ

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/config/templates/{templateId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/templates/{templateId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_template",
  • "labels":
    [
    ],
  • "description": "dummy_template",
  • "content": "dummy_content"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_template_id",
  • "name": "dummy_template",
  • "labels":
    [
    ],
  • "description": "dummy_template",
  • "content": "dummy_content",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

テンプレートを削除する

テンプレートを削除する

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

テナントID

templateId
required
string ^[0-9a-f]{24}$
Example: dummy_template_id

テンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successfule operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/config/templates/{templateId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/templates/{templateId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

共通パラメーター

コンフィグマネージャーの共通パラメーターに関するAPI

共通パラメーターの一覧情報を取得する

共通パラメーターの一覧情報を取得する

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

テナントID

query Parameters
name
string
Example: name=sample

検索に使う名前（部分一致）

labels
string
Example: labels=label1,label2

検索に使うラベル（部分一致, カンマ区切りで複数指定可能）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/parameters
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/parameters

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "parameters":
    [
    ]
}

共通パラメーターを登録する

共通パラメーターを登録する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

共通パラメーター名

labels
Array of strings [ 1 .. 10 ] items Nullable

ラベル(コンマは含められない)

description
string <= 200 characters

説明

content
required
string <json-string> [ 1 .. 10485760 ] characters

コンテンツ

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/parameters
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/parameters

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_global_parameter",
  • "labels":
    [
    ],
  • "description": "dummy_global_parameter",
  • "content": "dummy_content"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_global_parameter_id",
  • "name": "dummy_global_parameter",
  • "labels":
    [
    ],
  • "description": "dummy_global_parameter",
  • "content": "dummy_content",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

共通パラメーターの詳細情報を取得する

共通パラメーターの詳細情報を取得する

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

テナントID

parameterId
required
string ^[0-9a-f]{24}$
Example: dummy_global_parameter_id

共通パラメータID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/parameters/{parameterId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/parameters/{parameterId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_global_parameter_id",
  • "name": "dummy_global_parameter",
  • "labels":
    [
    ],
  • "description": "dummy_global_parameter",
  • "content": "dummy_content",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

共通パラメーターを更新する

共通パラメーターを更新する

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

テナントID

parameterId
required
string ^[0-9a-f]{24}$
Example: dummy_global_parameter_id

共通パラメータID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

共通パラメーター名

labels
Array of strings [ 1 .. 10 ] items Nullable

ラベル(コンマは含められない)

description
string <= 200 characters

説明

content
required
string <json-string> [ 1 .. 10485760 ] characters

コンテンツ

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/config/parameters/{parameterId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/parameters/{parameterId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_global_parameter",
  • "labels":
    [
    ],
  • "description": "dummy_global_parameter",
  • "content": "dummy_content"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_global_parameter_id",
  • "name": "dummy_global_parameter",
  • "labels":
    [
    ],
  • "description": "dummy_global_parameter",
  • "content": "dummy_content",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

共通パラメーターを削除する

共通パラメーターを削除する

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

テナントID

parameterId
required
string ^[0-9a-f]{24}$
Example: dummy_global_parameter_id

共通パラメータID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/config/parameters/{parameterId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/parameters/{parameterId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

デバイスグループ

コンフィグマネージャーのデバイスグループに関するAPI

デバイスグループの一覧情報を取得する

デバイスグループの一覧情報を取得する

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

テナントID

query Parameters
name
string
Example: name=sample

検索に使う名前（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

sims
string

検索に使うsims（部分一致, カンマ区切りで複数指定可能）

labels
string
Example: labels=label1,label2

検索に使うラベル（部分一致, カンマ区切りで複数指定可能）

vconns
string

検索に使うvconnID（部分一致, カンマ区切りで複数指定可能）

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/device-groups
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/device-groups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "deviceGroups":
    [
    ]
}

デバイスグループを登録する

デバイスグループを登録する

  • 少なくともSIMまたは仮想コネクションを指定する必要がある
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

デバイスグループ名

sims
Array of strings

SIM

labels
Array of strings [ 1 .. 10 ] items Nullable

ラベル(コンマは含められない)

vconns
Array of strings

仮想コネクションID

description
string <= 200 characters

説明

content
string <json-string> [ 1 .. 10485740 ] characters Nullable

コンテンツ

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/device-groups
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/device-groups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy device group",
  • "sims":
    [
    ],
  • "vconns":
    [
    ],
  • "labels":
    [
    ],
  • "description": "dummy_description",
  • "content": "{ \"Default\": { \"hostname\": \"default.device\" }, \"IMSI_7123456789\": { \"hostname\": \"device.7123456789.com\" }, \"IMSI_7123456788\": { \"hostname\": \"device.7123456788.com\" }}"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "61adb1109e44c70047fddecd",
  • "name": "dummy device group",
  • "sims":
    [
    ],
  • "vconns":
    [
    ],
  • "labels":
    [
    ],
  • "description": "dummy_description",
  • "content": "{ \"Default\": { \"hostname\": \"default.device\" }, \"IMSI_7123456789\": { \"hostname\": \"device.7123456789.com\" }, \"IMSI_7123456788\": { \"hostname\": \"device.7123456788.com\" }}",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

デバイスグループの詳細情報を取得する

デバイスグループの詳細情報を取得する

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

テナントID

deviceGroupId
required
string ^[0-9a-f]{24}$
Example: dummy_device_group_id

デバイスグループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/device-groups/{deviceGroupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/device-groups/{deviceGroupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "61adb1109e44c70047fddecd",
  • "name": "dummy device group",
  • "sims":
    [
    ],
  • "vconns":
    [
    ],
  • "labels":
    [
    ],
  • "description": "dummy_description",
  • "content": "{ \"Default\": { \"hostname\": \"default.device\" }, \"IMSI_7123456789\": { \"hostname\": \"device.7123456789.com\" }, \"IMSI_7123456788\": { \"hostname\": \"device.7123456788.com\" }}",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

デバイスグループを更新する

デバイスグループを更新する

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

テナントID

deviceGroupId
required
string ^[0-9a-f]{24}$
Example: dummy_device_group_id

デバイスグループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

デバイスグループ名

sims
Array of strings

SIM

labels
Array of strings [ 1 .. 10 ] items Nullable

ラベル(コンマは含められない)

vconns
Array of strings

仮想コネクションID

description
string <= 200 characters

説明

content
string <json-string> [ 1 .. 10485740 ] characters Nullable

コンテンツ

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/config/device-groups/{deviceGroupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/device-groups/{deviceGroupId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy device group",
  • "sims":
    [
    ],
  • "vconns":
    [
    ],
  • "labels":
    [
    ],
  • "description": "dummy_description",
  • "content": "{ \"Default\": { \"hostname\": \"default.device\" }, \"IMSI_7123456789\": { \"hostname\": \"device.7123456789.com\" }, \"IMSI_7123456788\": { \"hostname\": \"device.7123456788.com\" }}"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "61adb1109e44c70047fddecd",
  • "name": "dummy device group",
  • "sims":
    [
    ],
  • "vconns":
    [
    ],
  • "labels":
    [
    ],
  • "description": "dummy_description",
  • "content": "{ \"Default\": { \"hostname\": \"default.device\" }, \"IMSI_7123456789\": { \"hostname\": \"device.7123456789.com\" }, \"IMSI_7123456788\": { \"hostname\": \"device.7123456788.com\" }}",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

デバイスグループを削除する

デバイスグループを削除する

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

テナントID

deviceGroupId
required
string ^[0-9a-f]{24}$
Example: dummy_device_group_id

デバイスグループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/config/device-groups/{deviceGroupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/device-groups/{deviceGroupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

プロファイル

コンフィグマネージャーのプロファイルに関するAPI

プロファイルの一覧情報を取得する

プロファイルの一覧情報を取得する

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

テナントID

query Parameters
name
string
Example: name=sample

検索に使う名前（部分一致）

generated
boolean

作成済みフラグ

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/profiles
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "configProfiles":
    [
    ]
}

プロファイルを登録する

プロファイルを登録する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

プロファイル名

template
required
string 24 characters

テンプレートID

globalParameter
string 24 characters Nullable

共通パラメーターID

deviceGroup
required
string 24 characters

デバイスグループID

description
string <= 200 characters

説明

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/profiles
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_config_profile",
  • "template": "dummy_template",
  • "globalParameter": "dummy_global_parameter",
  • "deviceGroup": "dummy_device_group",
  • "description": "dummy_config_profile"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_profile_id",
  • "name": "dummy_config_profile",
  • "template": "dummy_template",
  • "globalParameter": "dummy_global_parameter",
  • "deviceGroup": "dummy_device_group",
  • "generated": true,
  • "description": "dummy_config_profile",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

プロファイルの詳細情報を取得する

プロファイルの詳細情報を取得する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/profiles/{configProfileId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_profile_id",
  • "name": "dummy_config_profile",
  • "template": "dummy_template",
  • "globalParameter": "dummy_global_parameter",
  • "deviceGroup": "dummy_device_group",
  • "generated": true,
  • "description": "dummy_config_profile",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

プロファイル情報を更新する

プロファイルを更新する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

プロファイル名

template
required
string 24 characters

テンプレートID

globalParameter
string 24 characters Nullable

共通パラメーターID

deviceGroup
required
string 24 characters

デバイスグループID

description
string <= 200 characters

説明

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/config/profiles/{configProfileId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_config_profile",
  • "template": "dummy_template",
  • "globalParameter": "dummy_global_parameter",
  • "deviceGroup": "dummy_device_group",
  • "description": "dummy_config_profile"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_profile_id",
  • "name": "dummy_config_profile",
  • "template": "dummy_template",
  • "globalParameter": "dummy_global_parameter",
  • "deviceGroup": "dummy_device_group",
  • "generated": true,
  • "description": "dummy_config_profile",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

プロファイルを削除する

プロファイルを削除する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/config/profiles/{configProfileId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

プロファイルをチェックする

プロファイルをチェックする

path Parameters
tenantId
required
string
header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
template
required
string 24 characters

テンプレート

globalParameter
string 24 characters

共通パラメーター

deviceGroup
required
string 24 characters

デバイスグループ

imsi
string [ 1 .. 15 ] characters ^[0-9]*$

imsi

vconnId
string 36 characters

仮想コネクションID

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/profiles/check
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/check

Request samples

Content type
application/json
Example
checkConfigProfile with IMSI
Copy
 Expand all Collapse all
{
  • "template": "dummy_template",
  • "globalParameter": "dummy_global_parameter",
  • "deviceGroup": "dummy_device_group",
  • "imsi": "12345678"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "content": "sample"
}

プロファイルを生成する

プロファイルを生成する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/profiles/{configProfileId}/create
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}/create

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

プロファイルセットを作成する

プロファイルセットを作成する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
string [ 1 .. 50 ] characters

プロファイルセット名

description
string <= 200 characters

説明

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/profiles/{configProfileId}/histories
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}/histories

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_profile_set",
  • "description": "dummy"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_profile_id",
  • "histories":
    [
    ]
}

プロファイルセットの一覧情報を取得する

プロファイルセットの一覧情報を取得する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/profiles/{configProfileId}/histories
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}/histories

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_profile_id",
  • "histories":
    [
    ]
}

プロファイルセットを更新する

プロファイルセットを更新する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

versionId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_version_id

バージョンID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
string [ 1 .. 50 ] characters

プロファイルセット名

description
string <= 200 characters

説明

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/config/profiles/{configProfileId}/histories/{versionId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}/histories/{versionId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_profile_set",
  • "description": "dummy"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_profile_id",
  • "histories":
    [
    ]
}

プロファイルセットを削除する

プロファイルセットを削除する

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

versionId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_version_id

バージョンID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/config/profiles/{configProfileId}/histories/{versionId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}/histories/{versionId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

プロファイルをロールバックする

プロファイルをロールバックする

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

テナントID

configProfileId
required
string ^[0-9a-f]{24}$
Example: dummy_config_profile_id

プロファイルID

versionId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_version_id

バージョンID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

put/tenants/{tenantId}/config/profiles/{configProfileId}/histories/{versionId}/rollback
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/profiles/{configProfileId}/histories/{versionId}/rollback

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_profile_id",
  • "name": "dummy_config_profile",
  • "template": "dummy_template",
  • "globalParameter": "dummy_global_parameter",
  • "deviceGroup": "dummy_device_group",
  • "generated": true,
  • "description": "dummy_config_profile",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

ポリシー

コンフィグマネージャーのポリシーに関するAPI

ポリシーの一覧情報を取得する

ポリシーの一覧情報を取得する

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

テナントID

query Parameters
page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

name
string
Example: name=sample

検索に使う名前（部分一致）

protocol
string
Value: "http"
Example: protocol=http

検索に使うプロトコル

entrypoint
string
Example: entrypoint=/

検索に使うエントリーポイント（部分一致）

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/policies
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/policies

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "configPolicies":
    [
    ]
}

ポリシーを登録する

ポリシーを登録する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

ポリシー名

entrypoint
required
string [ 1 .. 200 ] characters ^\/\S*$

エントリーポイント

  • 空白類文字列は含められない
  • / から始まる文字列でなければならない
  • マルチバイト文字は含められない
  • /status は利用できない
  • /status/...は利用できない
enabled
boolean
Default: true

有効/無効

protocol
required
string
Value: "http"

プロトコル

configProfile
required
string 24 characters

プロファイル

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/config/policies
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/policies

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Dummy Config Policy",
  • "entrypoint": "/",
  • "enabled": true,
  • "protocol": "http",
  • "configProfile": "dummy_config_policy"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_id",
  • "name": "Dummy Config Policy",
  • "entrypoint": "/",
  • "enabled": true,
  • "protocol": "http",
  • "configProfile": "dummy_config_policy",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

ポリシーの詳細情報を取得する

ポリシーの詳細情報を取得する

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

テナントID

configPolicyId
required
string ^[0-9a-f]{24}$
Example: dummy_config_policy_id

ポリシーID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/config/policies/{configPolicyId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/policies/{configPolicyId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_id",
  • "name": "Dummy Config Policy",
  • "entrypoint": "/",
  • "enabled": true,
  • "protocol": "http",
  • "configProfile": "dummy_config_policy",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

ポリシーを更新する

ポリシーを更新する

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

テナントID

configPolicyId
required
string ^[0-9a-f]{24}$
Example: dummy_config_policy_id

ポリシーID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

ポリシー名

entrypoint
required
string [ 1 .. 200 ] characters ^\/\S*$

エントリーポイント

  • 空白類文字列は含められない
  • / から始まる文字列でなければならない
  • マルチバイト文字は含められない
  • /status は利用できない
  • /status/...は利用できない
enabled
boolean
Default: true

有効/無効

protocol
required
string
Value: "http"

プロトコル

configProfile
required
string 24 characters

プロファイル

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/config/policies/{configPolicyId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/policies/{configPolicyId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Dummy Config Policy",
  • "entrypoint": "/",
  • "enabled": true,
  • "protocol": "http",
  • "configProfile": "dummy_config_policy"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_config_id",
  • "name": "Dummy Config Policy",
  • "entrypoint": "/",
  • "enabled": true,
  • "protocol": "http",
  • "configProfile": "dummy_config_policy",
  • "createdAt": "2021-12-06T06:43:28.400+00:00",
  • "updatedAt": "2021-12-06T06:43:28.400+00:00"
}

ポリシーを削除する

ポリシーを削除する

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

テナントID

configPolicyId
required
string ^[0-9a-f]{24}$
Example: dummy_config_policy_id

ポリシーID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/config/policies/{configPolicyId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/config/policies/{configPolicyId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

リモートアクセス

リモートアクセス機能に関するAPI

リモートアクセス設定の一覧を取得する

リモートアクセス設定の一覧を取得する

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

テナントID

query Parameters
imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI（部分一致）

imei
string
Example: imei=NA

検索に使うIMEI（部分一致）

deviceName
string
Example: deviceName=dummy_device_name

検索に使うデバイス名（部分一致）

hsn
string
Example: hsn=dummy_hsn

検索に使うHSN（部分一致）

msisdn
string
Example: msisdn=NA

検索に使うMSISDN（部分一致）

endpointHost
string
Example: endpointHost=dummy_endpoint_host

検索に使うエンドポイントホスト（部分一致）

endpointPort
number
Example: endpointPort=1234

検索に使うエンドポイントポート（完全一致）

devicePort
number
Example: devicePort=1234

検索に使うデバイスポート（完全一致）

portStatus
boolean
Example: portStatus=false

検索に使うポートステータス（完全一致）

sourcePrefix
string
Example: sourcePrefix=1.2.3.4/32

検索に使うソースプリフィックス（部分一致）

isTls
boolean
Example: isTls=false

TLS終端機能有効/無効

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/remote/accesses
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/remote/accesses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "accesses":
    [
    ]
}

リモートアクセス設定を登録する

リモートアクセス設定を登録する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • RemoteAccessPostRequestParams
  • RemoteAccessPostRequestParamsInfinityMode
imsi
required
string [ 1 .. 15 ] characters ^[0-9]+$

IMSI

  • マルチバイト文字は含められない
sourcePrefixes
required
Array of strings <ipv4 with subnet> [ 1 .. 5 ] items

アクセス元Prefix

  • 0.0.0.0は指定できない
  • サブネットマスクの許容範囲は/24から/32の間でなければならない
  • 0パディングは許容しない
devicePort
required
number [ 1 .. 65535 ]

接続先デバイスポート

endTime
required
string <yyyy-MM-ddTHH:mm:ss.fffZ>

終了時刻

  • 現在時刻から少なくとも10分後、長くても8時間後でなければならない
infinityMode
boolean
Default: false
Value: false

infinity Mode(要別途申請)

isTls
boolean
Default: false

TLS終端機能有効/無効

Responses

201

successful operation

400

Bad Request

401

Unauthorized

403

Example response

500

Internal Server Error

post/tenants/{tenantId}/remote/accesses
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/remote/accesses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imsi": "44010123456789",
  • "devicePort": 1235,
  • "sourcePrefixes":
    [
    ],
  • "endTime": "2022-06-15T16:37:00.400Z",
  • "infinityMode": false,
  • "isTls": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "imsi": "dummy_imsi",
  • "sourcePrefixes":
    [
    ],
  • "endpointHost": "dummy_endpoint_host",
  • "endpointPort": 1234,
  • "devicePort": 1235,
  • "startTime": "2022-06-15T00:00:00.000Z",
  • "endTime": "2022-06-15T00:00:00.000Z",
  • "infinityMode": false,
  • "isTls": false,
  • "imei": "NA",
  • "msisdn": "NA",
  • "deviceName": "NA",
  • "hsn": "dummy_hsn",
  • "activeIp":
    [
    ],
  • "portStatus": true
}

リモートアクセスの設定を取得する

リモートアクセスの設定を取得する

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

テナントID

accessId
required
string ^[0-9a-f]{24}$
Example: dummy_remote_access_id

リモートアクセスID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/remote/accesses/{accessId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/remote/accesses/{accessId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "imsi": "dummy_imsi",
  • "sourcePrefixes":
    [
    ],
  • "endpointHost": "dummy_endpoint_host",
  • "endpointPort": 1234,
  • "devicePort": 1235,
  • "startTime": "2022-06-15T00:00:00.000Z",
  • "endTime": "2022-06-15T00:00:00.000Z",
  • "infinityMode": false,
  • "isTls": false,
  • "imei": "NA",
  • "msisdn": "NA",
  • "deviceName": "NA",
  • "hsn": "dummy_hsn",
  • "activeIp":
    [
    ],
  • "portStatus": true
}

リモートアクセスの設定を更新する

リモートアクセスの設定を更新する

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

テナントID

accessId
required
string ^[0-9a-f]{24}$
Example: dummy_remote_access_id

リモートアクセスID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
One of
  • RemoteAccessPutParams
  • RemoteAccessPutParamsInfinityMode
devicePort
required
integer [ 1 .. 65535 ]

接続先デバイスポート

sourcePrefixes
required
Array of strings <ipv4 with subnet> [ 1 .. 5 ] items

アクセス元Prefix

  • 0.0.0.0は指定できない
  • サブネットマスクの許容範囲は/24から/32の間でなければならない
  • 0パディングは許容しない
endTime
required
string <yyyy-MM-ddTHH:mm:ss.fffZ>

終了時刻

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/remote/accesses/{accessId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/remote/accesses/{accessId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "devicePort": 1234,
  • "sourcePrefixes":
    [
    ],
  • "endTime": "2022-06-15T00:00:00.000Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_id",
  • "imsi": "dummy_imsi",
  • "sourcePrefixes":
    [
    ],
  • "endpointHost": "dummy_endpoint_host",
  • "endpointPort": 1234,
  • "devicePort": 1235,
  • "startTime": "2022-06-15T00:00:00.000Z",
  • "endTime": "2022-06-15T00:00:00.000Z",
  • "infinityMode": false,
  • "isTls": false,
  • "imei": "NA",
  • "msisdn": "NA",
  • "deviceName": "NA",
  • "hsn": "dummy_hsn",
  • "activeIp":
    [
    ],
  • "portStatus": true
}

リモートアクセスを停止する

リモートアクセスを停止する

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

テナントID

accessId
required
string ^[0-9a-f]{24}$
Example: dummy_remote_access_id

リモートアクセスID

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/remote/accesses/{accessId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/remote/accesses/{accessId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

リモートアクセス設定の履歴を取得する

リモートアクセスの設定の履歴を取得する

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

テナントID

query Parameters
imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI（部分一致）

imei
string
Example: imei=NA

検索に使うIMEI（部分一致）

deviceName
string
Example: deviceName=dummy_device_name

検索に使うデバイス名（部分一致）

hsn
string
Example: hsn=dummy_hsn

検索に使うHSN（部分一致）

msisdn
string
Example: msisdn=NA

検索に使うMSISDN（部分一致）

sourcePrefix
string
Example: sourcePrefix=1.2.3.4/32

検索に使うソースプリフィックス（部分一致）

devicePort
number
Example: devicePort=1234

検索に使うデバイスポート（完全一致）

isTls
boolean
Example: isTls=false

TLS終端機能有効/無効

from
string
Example: from=YYYY-MM-DD hh:mm:ss

取得期間の開始日時

to
string
Example: to=YYYY-MM-DD hh:mm:ss

取得期間の終了日時

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/remote/histories
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/remote/histories

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "histories":
    [
    ]
}

グローバルIPを取得する

グローバルIPを取得する

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/global-ip
https://api.ntt.com/iot-c-icgw/v1/global-ip

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "globalIp": "1.1.1.1"
}

テナント

テナントに関するAPI

テナントに登録されたモードを取得する

テナントに登録されたモードを取得する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

500

Internal Server Error

get/tenants/{tenantId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "infinityMode": true,
  • "fixedRemoteMode": true
}

フォーマット変換機能

フォーマット変換機能に関するAPI

フォーマット変換テンプレート一覧を取得する

フォーマット変換テンプレート一覧を取得する

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

テナントID

query Parameters
name
string

検索に使う名前（部分一致）

groupId
string

検索に使うグループID

convertType
string
Enum: "csv" "json"

検索に使う変換種別

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

policyId
string

検索に使うポリシーID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/fconv
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/fconv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 10,
  • "page": 3,
  • "pageSize": 10,
  • "fconv":
    [
    ]
}

フォーマット変換テンプレートを作成する

フォーマット変換テンプレートを作成する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

フォーマット変換テンプレート名

description
string [ 0 .. 200 ] characters

説明

convertType
required
string
Enum: "csv" "json"

転送先のクラウド種別

policies
Array of objects
template
required
string [ 1 .. 1000000 ] characters

フォーマット変換テンプレート

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/fconv
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/fconv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies":
    [
    ],
  • "template": "dummy_template"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_fconv_id",
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies":
    [
    ],
  • "template": "dummy_template"
}

フォーマット変換テンプレートを取得する

フォーマット変換テンプレートを取得する

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

テナントID

fconvId
required
string ^[0-9a-f]{24}$
Example: dummy_fconv_id

フォーマット変換テンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/fconv/{fconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/fconv/{fconvId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_fconv_id",
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies":
    [
    ],
  • "template": "dummy_template"
}

フォーマット変換テンプレートを更新する

フォーマット変換テンプレートを更新する

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

テナントID

fconvId
required
string ^[0-9a-f]{24}$
Example: dummy_fconv_id

フォーマット変換テンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

フォーマット変換テンプレート名

description
string [ 0 .. 200 ] characters

説明

convertType
required
string
Enum: "csv" "json"

転送先のクラウド種別

policies
Array of objects
template
required
string [ 1 .. 1000000 ] characters

フォーマット変換テンプレート

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/fconv/{fconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/fconv/{fconvId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies":
    [
    ],
  • "template": "dummy_template"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_fconv_id",
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies":
    [
    ],
  • "template": "dummy_template"
}

フォーマット変換テンプレートを削除する

フォーマット変換テンプレートを削除する

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

テナントID

fconvId
required
string ^[0-9a-f]{24}$
Example: dummy_fconv_id

フォーマット変換テンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

No Content

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/fconv/{fconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/fconv/{fconvId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

変換結果の統計を取得する

変換結果の統計を取得する

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

テナントID

fconvId
required
string ^[0-9a-f]{24}$
Example: dummy_fconv_id

フォーマット変換テンプレートID

query Parameters
from
required
string
Example: from=2022-11-01

取得期間の開始日

to
required
string
Example: to=2022-12-01

取得期間の終了日

cloudType
string
Enum: "gcp" "aws" "azure" "things" "standard-http" "standard-mqtt/aws" "standard-tcp"

検索に使うクラウド種別

type
string
Enum: "pconv" "event" "func"

検索に使うポリシー種別

protocol
string
Enum: "mqtt" "http" "tcp"

検索に使うプロトコル種別

groupId
string

検索に使うグループID

successCountFrom
number

成功数の下限

successCountTo
number

成功数の上限

failCountFrom
number

失敗数の下限

failCountTo
number

失敗数の上限

policyId
string

検索に使うポリシーID

imsi
string

検索に使うIMSI

vconnId
string
Example: vconnId=dummy_vconn_id

検索に使う仮想コネクションID（部分一致）

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/fconv/{fconvId}/status
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/fconv/{fconvId}/status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "from": "2022-11-01",
  • "to": "2022-12-01",
  • "tenantId": "dummy_tenant_id",
  • "usages":
    [
    ]
}

フォーマット変換をテストする

フォーマット変換をテストする

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
template
required
string [ 1 .. 1000000 ] characters

バイナリーパーサーテンプレート内容

data
required
string non-empty

データ文字列

convertType
required
string
Enum: "json" "csv"

データの種類. jsonかcsv.

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/test/fconv
https://api.ntt.com/iot-c-icgw/v1/test/fconv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "template": "{ \"基本情報\": { \"名前\": \"{{ csv_data[1] }}\", \"年齢\": \"{{ csv_data[2] }}\", \"ジャンル\": \"テスト\" }, \"チーム\": \"{{ csv_data[0] }}\", \"number\": {{ csv_data[3] }} }",
  • "data": "1,2,3,4,5",
  • "convertType": "csv"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    }
}

バイナリパーサー機能

バイナリパーサー機能に関するAPI

バイナリパーサーのテンプレート一覧を取得する

バイナリパーサーのテンプレート一覧を取得する

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

テナントID

query Parameters
name
string

検索に使う名前（部分一致）

groupId
string

検索に使うグループID

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

policyId
string

検索に使うポリシーID

predefined
boolean
Example: predefined=false

検索に使う定義ステータス

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/bconv
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/bconv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 10,
  • "page": 3,
  • "pageSize": 10,
  • "bconv":
    [
    ]
}

バイナリパーサーのテンプレートを作成する

バイナリパーサーのテンプレートを作成する

テンプレート条件

  • 少なくとも以下の形式に従う必要がある：[KEY_NAME]:[INDEX]:[TYPE]
  • [KEY_NAME] に : や空白を含めることはできない
  • [INDEX] は >= 0 でなければならない
  • [TYPE]はbool、char、int、uintまたはfloatに応じて異なる
    • bool
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:bool:[BIT_OFFSET]
      • [BIT_OFFSET]はオプションで、指定する場合は0～7でなければならない (デフォルトは7)
    • char
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:char:[BYTE_LENGTH]
      • [BYTE_LENGTH]は必須で、1～64でなければならない
    • int/uint
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:int:[BIT_LENGTH]:[ENDIANNESS]:[BIT_OFFSET]
      • intの時は [BIT_LENGTH] ∈ [2,32], uintの時は [BIT_LENGTH] ∈ [1,32]
      • [ENDIANNESS]はオプションで、指定する場合はbeまたはleでなければならない（デフォルトはbe）
      • [ENDIANNESS]がleの場合、[BIT_LENGTH]は 8｜16｜24｜32 でなければならない
      • [BIT_OFFSET]はオプションで、指定する場合は0～7でなければならない (デフォルトは7)
    • float
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:float:[BIT_LENGTH]:[ENDIANNESS]:[BIT_OFFSET]
      • [BIT_LENGTH]は 32|64 でなければならない
      • [ENDIANNESS]はオプションで、指定する場合はbeまたはleでなければならない（デフォルトはbe）
      • [BIT_OFFSET]はオプションで、指定する場合は0～7でなければならない (デフォルトは7)
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

バイナリーパーサーテンプレート名

description
string <= 200 characters

説明

parserTemplate
required
string [ 1 .. 1000000 ] characters

バイナリーパーサーテンプレート

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/bconv
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/bconv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "parserTemplate": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "predefined": true,
  • "parserTemplate": "string"
}

バイナリパーサーのテンプレートを取得する

バイナリパーサーのテンプレートを取得する

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

テナントID

bconvId
required
string

バイナリーパーサーテンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/bconv/{bconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/bconv/{bconvId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "predefined": true,
  • "parserTemplate": "string",
  • "policies":
    [
    ]
}

バイナリパーサーのテンプレートを更新する

バイナリパーサーのテンプレートを更新する

テンプレート条件

  • 少なくとも以下の形式に従う必要がある：[KEY_NAME]:[INDEX]:[TYPE]
  • [KEY_NAME] に : や空白を含めることはできない
  • [INDEX] は >= 0 でなければならない
  • [TYPE]はbool、char、int、uintまたはfloatに応じて異なる
    • bool
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:bool:[BIT_OFFSET]
      • [BIT_OFFSET]はオプションで、指定する場合は0～7でなければならない (デフォルトは7)
    • char
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:char:[BYTE_LENGTH]
      • [BYTE_LENGTH]は必須で、1～64でなければならない
    • int/uint
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:int:[BIT_LENGTH]:[ENDIANNESS]:[BIT_OFFSET]
      • intの時は [BIT_LENGTH] ∈ [2,32], uintの時は [BIT_LENGTH] ∈ [1,32]
      • [ENDIANNESS]はオプションで、指定する場合はbeまたはleでなければならない（デフォルトはbe）
      • [ENDIANNESS]がleの場合、[BIT_LENGTH]は 8｜16｜24｜32 でなければならない
      • [BIT_OFFSET]はオプションで、指定する場合は0～7でなければならない (デフォルトは7)
    • float
      • 以下の形式に従う：[KEY_NAME]:[INDEX]:float:[BIT_LENGTH]:[ENDIANNESS]:[BIT_OFFSET]
      • [BIT_LENGTH]は 32|64 でなければならない
      • [ENDIANNESS]はオプションで、指定する場合はbeまたはleでなければならない（デフォルトはbe）
      • [BIT_OFFSET]はオプションで、指定する場合は0～7でなければならない (デフォルトは7)
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

bconvId
required
string

バイナリーパーサーテンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

バイナリーパーサーテンプレート名

description
string <= 200 characters

説明

parserTemplate
required
string [ 1 .. 1000000 ] characters

バイナリーパーサーテンプレート

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/bconv/{bconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/bconv/{bconvId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "parserTemplate": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "predefined": true,
  • "parserTemplate": "string"
}

バイナリパーサーのテンプレートを削除する

バイナリパーサーのテンプレートを削除する

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

テナントID

bconvId
required
string

バイナリーパーサーテンプレートID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

No Content

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/bconv/{bconvId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/bconv/{bconvId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

バイナリパーサーをテストする

バイナリパーサーをテストする

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
template
required
string [ 1 .. 1000000 ] characters

バイナリーパーサーテンプレート内容

data
required
string non-empty

データ文字列

dataType
string
Default: "hex"
Enum: "hex" "binary"

データの種類. hex（16進数）かbinary（2進数）.

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/test/bconv
https://api.ntt.com/iot-c-icgw/v1/test/bconv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "template": "key1:0:int:32:be:7 key2:4:int:32:be:7",
  • "data": "0101010123232323",
  • "dataType": "hex"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    }
}

ミラーリング機能

ミラーリング機能に関するAPI

ミラーグループ情報の一覧を取得する

ミラーグループ情報の一覧を取得する

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

テナントID

query Parameters
groupId
string

検索に使うグループID

name
string

検索に使うミラーグループ名（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/mirror-groups
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/mirror-groups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "mirrorGroups":
    [
    ]
}

ミラーグループを作成する

ミラーグループを作成する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

ミラーグループ名

entrypoint
required
string [ 1 .. 200 ] characters ^\/\S*$

エントリーポイント

  • 空白類文字列は含められない
  • / から始まる文字列でなければならない
  • ワイルドカード(*)は一つだけ使用可能
  • 転送先ポリシーのエントリーポイントとミラーグループのエントリーポイントのワイルドカードの数は同じでなければならない
  • 重複したエントリーポイントを設定できない
protocol
string
Default: "http"
Value: "http"

プロトコル

priority
integer [ 1 .. 999 ]
Default: 100

優先順位

enabled
boolean
Default: true

有効/無効

destinations
required
Array of objects <= 5 items

転送先ポリシー

  • エントリーポイントに２つ以上ワイルドカードを使用しているポリシーは設定不可
  • groupIdは全て同じでなければならない
  • MQTT Pconv IDはサポートされていない
  • primaryは一つしかtrueにできない

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/mirror-groups
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/mirror-groups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_mirror_group",
  • "entrypoint": "/dummy",
  • "enabled": true,
  • "priority": 100,
  • "protocol": "http",
  • "destinations":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_mirror_group_id",
  • "userId": "dummy_user_id",
  • "name": "dummy_mirror_group",
  • "entrypoint": "/dummy",
  • "enabled": true,
  • "priority": 100,
  • "protocol": "http",
  • "destinations":
    [
    ]
}

ミラーグループ情報を取得する

ミラーグループ情報を取得する

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

テナントID

mirrorGroupId
required
string

ミラーグループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/mirror-groups/{mirrorGroupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/mirror-groups/{mirrorGroupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_mirror_group_id",
  • "userId": "dummy_user_id",
  • "name": "dummy_mirror_group",
  • "entrypoint": "/dummy",
  • "enabled": true,
  • "priority": 100,
  • "protocol": "http",
  • "destinations":
    [
    ]
}

ミラーグループ情報を更新する

ミラーグループ情報を更新する

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

テナントID

mirrorGroupId
required
string

ミラーグループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

ミラーグループ名

entrypoint
required
string [ 1 .. 200 ] characters ^\/\S*$

エントリーポイント

  • 空白類文字列は含められない
  • / から始まる文字列でなければならない
  • ワイルドカード(*)は一つだけ使用可能
  • 転送先ポリシーのエントリーポイントとミラーグループのエントリーポイントのワイルドカードの数は同じでなければならない
  • 重複したエントリーポイントを設定できない
protocol
string
Default: "http"
Value: "http"

プロトコル

priority
integer [ 1 .. 999 ]
Default: 100

優先順位

enabled
boolean
Default: true

有効/無効

destinations
required
Array of objects <= 5 items

転送先ポリシー

  • エントリーポイントに２つ以上ワイルドカードを使用しているポリシーは設定不可
  • groupIdは全て同じでなければならない
  • MQTT Pconv IDはサポートされていない
  • primaryは一つしかtrueにできない

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/mirror-groups/{mirrorGroupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/mirror-groups/{mirrorGroupId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "dummy_mirror_group",
  • "entrypoint": "/dummy",
  • "enabled": true,
  • "priority": 100,
  • "protocol": "http",
  • "destinations":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_mirror_group_id",
  • "userId": "dummy_user_id",
  • "name": "dummy_mirror_group",
  • "entrypoint": "/dummy",
  • "enabled": true,
  • "priority": 100,
  • "protocol": "http",
  • "destinations":
    [
    ]
}

ミラーグループ情報を削除する

ミラーグループ情報を削除する

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

テナントID

mirrorGroupId
required
string

ミラーグループID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/mirror-groups/{mirrorGroupId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/mirror-groups/{mirrorGroupId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

仮想コネクション

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

仮想コネクション一覧を取得する

仮想コネクション一覧を取得する

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

テナントID

query Parameters
vconnId
string
Example: vconnId=dummy_vconn_id

検索に使う仮想コネクションID（部分一致）

hardwareId
string
Example: hardwareId=dummy_hardware_id

検索に使うハードウェアID（部分一致）

registeredIp
string
Example: registeredIp=11.22.33.44

検索に使う登録済みIPアドレス（部分一致）

vimsi
string
Example: vimsi=dummy_vimsi

検索に使う仮想IMSI（部分一致）

imei
string
Example: imei=NA

検索に使うIMEI（部分一致）

msisdn
string
Example: msisdn=NA

検索に使うMSISDN（部分一致）

deviceName
string
Example: deviceName=dummy_device_name

検索に使うデバイス名（部分一致）

systemId
string
Example: systemId=dummy_system_id

検索に使うシステムID（部分一致）

mqttClientId
string
Example: mqttClientId=dummy_mqtt_client_id

検索に使うMQTTクライアントID（部分一致）

azureDeviceId
string
Example: azureDeviceId=dummy_azure_device_id

検索に使うAzureデバイスID（部分一致）

hsn
string
Example: hsn=dummy_hsn

検索に使うHSN（部分一致）

groupId
string
Example: groupId=dummy_group_id

検索に使うグループID（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

standardDeviceId
string
Example: standardDeviceId=dummy_standard_device_id

検索に使うスタンダードデバイスID（部分一致）

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/vconns
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 1,
  • "page": 1,
  • "pageSize": 20,
  • "vconns":
    [
    ]
}

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

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

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

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

ハードウェアID

  • テナントID内でユニークでなければならない
  • アルファベット、ハイフン（-）、アンダースコア（_）、コロン（:）のみ使用可能
description
string <= 200 characters

説明

vimsi
string <= 15 characters ^[0-9]+$
Default: "NA"

仮想IMSI

imei
string <= 15 characters ^[0-9]+$
Default: "NA"

IMEI

msisdn
string <= 15 characters ^[0-9]+$
Default: "NA"

MSISDN

deviceName
string <= 100 characters ^\S*$
Default: "NA"

デバイス名

systemId
string <= 10 characters

システムID

mqttClientId
string <= 24 characters

MQTTクライアントID

azureDeviceId
string <= 24 characters

AzureデバイスID

standardDeviceId
string <= 24 characters

スタンダードデバイスID

hsn
string <= 10 characters
Default: "NA"

HSN

optionData1
string <= 256 characters
Default: "NA"

予備

optionData2
string <= 256 characters
Default: "NA"

予備

optionData3
string <= 256 characters
Default: "NA"

予備

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/vconns
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "hardwareId": "dummy_hardware_id",
  • "description": "dummy",
  • "vimsi": "dummy_vimsi",
  • "imei": "dummy_imei",
  • "msisdn": "dummy_msisdn",
  • "deviceName": "dummy_device_name",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_vconn",
  • "devicePassword": "dummy_device_password",
  • "commonPassword": "dummy_common_password",
  • "vimsi": "dummy_vimsi",
  • "hardwareId": "dummy_hardware_id",
  • "registeredIp": "11.22.33.44",
  • "imei": "dummy_imei",
  • "msisdn": "dummy_msisdn",
  • "deviceName": "dummy_device_name",
  • "groupId": "dummy_group_id",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "activation": true,
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA",
  • "description": "dummy"
}

仮想コネクションを取得する

仮想コネクションを取得する

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

テナントID

vconnId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_vconn_id

仮想コネクションID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/vconns/{vconnId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/{vconnId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_vconn",
  • "devicePassword": "dummy_device_password",
  • "commonPassword": "dummy_common_password",
  • "vimsi": "dummy_vimsi",
  • "hardwareId": "dummy_hardware_id",
  • "registeredIp": "11.22.33.44",
  • "imei": "dummy_imei",
  • "msisdn": "dummy_msisdn",
  • "deviceName": "dummy_device_name",
  • "groupId": "dummy_group_id",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "activation": true,
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA",
  • "description": "dummy"
}

仮想コネクションを更新する

仮想コネクションを更新する

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

テナントID

vconnId
required
string ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89aAbB][a-f0-9]{3}\-[a-f0-9]{12}$
Example: dummy_vconn_id

仮想コネクションID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
devicePassword
required
string [ 8 .. 64 ] characters ^[a-zA-Z0-9!"#$%&'()+,-./;<=>?@[\]^_`{|}~]$

デバイスパスワード

  • 空白文字列は含められない
  • マルチバイト文字は含められない
  • : は含められない
description
string <= 200 characters

説明

vimsi
string <= 15 characters ^[0-9]+$
Default: "NA"

仮想IMSI

imei
string <= 15 characters ^[0-9]+$
Default: "NA"

IMEI

msisdn
string <= 15 characters ^[0-9]+$
Default: "NA"

MSISDN

deviceName
string <= 100 characters ^\S*$
Default: "NA"

デバイス名

systemId
string <= 10 characters

システムID

mqttClientId
string <= 24 characters

MQTTクライアントID

azureDeviceId
string <= 24 characters

AzureデバイスID

standardDeviceId
string <= 24 characters

スタンダードデバイスID

hsn
string <= 10 characters
Default: "NA"

HSN

optionData1
string <= 256 characters
Default: "NA"

予備

optionData2
string <= 256 characters
Default: "NA"

予備

optionData3
string <= 256 characters
Default: "NA"

予備

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/vconns/{vconnId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/{vconnId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "devicePassword": "dummy_device_password",
  • "description": "dummy",
  • "vimsi": "dummy_vimsi",
  • "imei": "dummy_imei",
  • "msisdn": "dummy_msisdn",
  • "deviceName": "dummy_device_name",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_vconn",
  • "devicePassword": "dummy_device_password",
  • "commonPassword": "dummy_common_password",
  • "vimsi": "dummy_vimsi",
  • "hardwareId": "dummy_hardware_id",
  • "registeredIp": "11.22.33.44",
  • "imei": "dummy_imei",
  • "msisdn": "dummy_msisdn",
  • "deviceName": "dummy_device_name",
  • "groupId": "dummy_group_id",
  • "systemId": "dummy_system_id",
  • "mqttClientId": "dummy_mqtt_client_id",
  • "azureDeviceId": "dummy_azure_device_id",
  • "standardDeviceId": "dummy_standard_device_id",
  • "hsn": "dummy_hsn",
  • "activation": true,
  • "optionData1": "NA",
  • "optionData2": "NA",
  • "optionData3": "NA",
  • "description": "dummy"
}

仮想コネクションを無効化する

仮想コネクションを無効化する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
vconns
Array of strings non-empty

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

post/tenants/{tenantId}/vconns/deactivate
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/deactivate

Request samples

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

Response samples

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

仮想コネクションの履歴を取得する

仮想コネクションの履歴を取得する

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

テナントID

query Parameters
vconnId
string
Example: vconnId=dummy_vconn_id

検索に使う仮想コネクションID（部分一致）

hardwareId
string
Example: hardwareId=dummy_hardware_id

検索に使うハードウェアID（部分一致）

action
string
Enum: "create" "update" "delete"

検索に使うアクション

vimsi
string
Example: vimsi=dummy_vimsi

検索に使う仮想IMSI（部分一致）

deviceName
string
Example: deviceName=dummy_device_name

検索に使うデバイス名（部分一致）

registeredIp
string
Example: registeredIp=11.22.33.44

検索に使う登録済みIPアドレス（部分一致）

from
string
Example: from=2022-06-14 00:00:00

取得期間の開始日

to
string
Example: to=2022-06-14 00:00:00

取得期間の終了日

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

get/tenants/{tenantId}/vconns/histories
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/histories

Response samples

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

共通パスワードを取得する

共通パスワードを取得する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/vconns/passwords/common
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/common

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "primary": "password1",
  • "secondary": "password2",
  • "description": "dummy_common_passwords"
}

共通パスワードを作成する

共通パスワードを作成する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

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

パスワード1

  • 空白文字列は含められない
  • マルチバイト文字は含められない
  • : は含められない
secondary
required
string [ 8 .. 64 ] characters ^[a-zA-Z0-9!"#$%&'()*+,-./;<=>?@[\]^_`{|}~]*$

パスワード2

  • 空白文字列は含められない
  • マルチバイト文字は含められない
  • : は含められない
description
string <= 200 characters

説明

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/vconns/passwords/common
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/common

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "primary": "password1",
  • "secondary": "password2",
  • "description": "dummy_common_passwords"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "primary": "dummy_password_1",
  • "secondary": "dummy_password_2",
  • "description": "dummy"
}

共通パスワードを更新する

共通パスワードを更新する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

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

パスワード1

  • 空白文字列は含められない
  • マルチバイト文字は含められない
  • : は含められない
secondary
required
string [ 8 .. 64 ] characters ^[a-zA-Z0-9!"#$%&'()*+,-./;<=>?@[\]^_`{|}~]*$

パスワード2

  • 空白文字列は含められない
  • マルチバイト文字は含められない
  • : は含められない
description
string <= 200 characters

説明

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/vconns/passwords/common
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/common

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "primary": "password1",
  • "secondary": "password2",
  • "description": "dummy_common_passwords"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "primary": "password1",
  • "secondary": "password2",
  • "description": "dummy_common_passwords"
}

共通パスワードを削除する

共通パスワードを削除する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/vconns/passwords/common
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/common

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

登録パスワード一覧を取得する

登録パスワード一覧を取得する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/vconns/passwords/registrations
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/registrations

Response samples

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

登録パスワードを作成する

登録パスワードを作成する

  • enabled: false を含めて最大５つまで作成可能
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: dummy_tenant_id

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

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

パスワード

  • 空白文字列は含められない
  • マルチバイト文字は含められない
  • : は含められない
enabled
boolean
Default: true

有効/無効

description
string <= 200 characters

説明

Responses

201

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/vconns/passwords/registrations
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/registrations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "dummy_password",
  • "enabled": true,
  • "description": "dummy"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_registration_password_id",
  • "password": "dummy_registration_password",
  • "enabled": true,
  • "description": "dummy"
}

登録パスワードを取得する

登録パスワードを取得する

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

テナントID

passwordId
required
string ^[0-9a-f]{24}$
Example: dummy_password_id

登録パスワードID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/vconns/passwords/registrations/{passwordId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/registrations/{passwordId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_registration_password_id",
  • "password": "dummy_registration_password",
  • "enabled": true,
  • "description": "dummy"
}

登録パスワードを更新する

登録パスワードを更新する

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

テナントID

passwordId
required
string ^[0-9a-f]{24}$
Example: dummy_password_id

登録パスワードID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

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

パスワード

  • 空白文字列は含められない
  • マルチバイト文字は含められない
  • : は含められない
enabled
boolean
Default: true

有効/無効

description
string <= 200 characters

説明

Responses

200

successful operation

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/vconns/passwords/registrations/{passwordId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/registrations/{passwordId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "password": "dummy_password",
  • "enabled": true,
  • "description": "dummy"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "dummy_registration_password_id",
  • "password": "dummy_registration_password",
  • "enabled": true,
  • "description": "dummy"
}

登録パスワードを削除する

登録パスワードを削除する

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

テナントID

passwordId
required
string ^[0-9a-f]{24}$
Example: dummy_password_id

登録パスワードID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

204

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/vconns/passwords/registrations/{passwordId}
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/vconns/passwords/registrations/{passwordId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

仮想コネクションのログの有効化状況を取得する

仮想コネクションのログの有効化状況を取得する

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

テナントID

query Parameters
vconn
string
Example: vconn=dummy_vconn_id

検索に使う仮想コネクションID（部分一致、カンマ区切りで複数指定可能）

enabled
string
Enum: "true" "false"
Example: enabled=true

検索に使うenabled

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/logs/vconn-activate
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/logs/vconn-activate

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "activate":
    [
    ]
}

仮想コネクションのログ機能を有効化する

仮想コネクションのログ機能を有効化する

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
activate
Array of objects non-empty

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/logs/vconn-activate
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/logs/vconn-activate

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "activate":
    {
    }
}

ログ機能

ログ機能に関するAPI

ログを取得する

ログを取得する

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

テナントID

query Parameters
from
required
string <date>
Example: from=2021-10-01

取得期間の開始日

to
required
string <date>
Example: to=2021-10-31

取得期間の終了日

severity
string
Example: severity=INFO

検索に使うログレベル

groupId
string
Example: groupId=dummy_group_id_1,dummy_group_id_2

検索に使うグループID（カンマ区切りで複数指定可能）

imsi
string
Example: imsi=dummy_imsi

検索に使うIMSI（部分一致）

vconnId
string
Example: vconnId=dummy_vconn_id

検索に使う仮想コネクションID（部分一致）

message
string
Example: message=dummy_log_message

検索に使うログメッセージ（部分一致）

page
integer
Example: page=3

ページ数. デフォルトは1

pageSize
integer
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

type
string
Enum: "pconv" "event" "func" "storage"
Example: type=pconv

検索に使うポリシー種別（カンマ区切りで複数指定可能）

cloudType
string
Enum: "gcp" "aws" "azure" "things" "standard-http" "standard-mqtt/aws" "standard-tcp"
Example: cloudType=standard-http

検索に使うクラウド種別（カンマ区切りで複数指定可能）

protocol
string
Enum: "http" "mqtt" "tcp"
Example: protocol=http

検索に使うプロトコル種別

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

successful operation

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/logs
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/logs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "logs":
    [
    ]
}

eSIMメール通知

eSIMメール通知機能に関するAPI

eSIMの故障メール通知を取得

eSIM Appletの故障メール通知設定の取得

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/esim-alert
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/esim-alert

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddress": "icgw@example.com",
  • "failureThreshold": 10,
  • "recoveryNotification": false,
  • "additionalInfo": "メールの本文にメッセージを追加することができます。"
}

eSIMの故障メール通知を作成

eSIM Appletの故障メール通知設定の作成

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
mailAddress
required
string [ 6 .. 254 ] characters ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

eSIM監視アラートの通知先メールアドレス

failureThreshold
required
integer [ 10 .. 4320 ]

通知抑制期間(分)

recoveryNotification
boolean
Default: false

回復通知の有効無効設定

additionalInfo
string <= 2000 characters Nullable
Default: null

メール本文の追加メッセージ

Responses

201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/esim-alert
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/esim-alert

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddress": "icgw@example.com",
  • "failureThreshold": 10,
  • "recoveryNotification": false,
  • "additionalInfo": "メールの本文にメッセージを追加することができます。"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddress": "icgw@example.com",
  • "failureThreshold": 10,
  • "recoveryNotification": false,
  • "additionalInfo": "メールの本文にメッセージを追加することができます。"
}

eSIMの故障メール通知を変更

eSIM Appletの故障メール通知設定の更新

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
mailAddress
required
string [ 6 .. 254 ] characters ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

eSIM監視アラートの通知先メールアドレス

failureThreshold
required
integer [ 10 .. 4320 ]

通知抑制期間(分)

recoveryNotification
boolean
Default: false

回復通知の有効無効設定

additionalInfo
string <= 2000 characters Nullable
Default: null

メール本文の追加メッセージ

Responses

200

OK

401

Unauthorized

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/esim-alert
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/esim-alert

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddress": "icgw@example.com",
  • "failureThreshold": 10,
  • "recoveryNotification": false,
  • "additionalInfo": "メールの本文にメッセージを追加することができます。"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddress": "icgw@example.com",
  • "failureThreshold": 10,
  • "recoveryNotification": false,
  • "additionalInfo": "メールの本文にメッセージを追加することができます。"
}

eSIMの故障メール通知を削除

eSIM Appletの故障メール通知設定の削除

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

テナントID

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Responses

200

OK

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/esim-alert
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/esim-alert

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 0,
  • "errorMessages":
    [
    ]
}

監視機能

監視機能に関するAPI

Pingコマンドを実行する

Pingコマンドを実行する

header Parameters
X-Auth-Token
required
string
Example: dummy_token

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

Request Body schema: application/json
imsi
required
string [ 1 .. 15 ] characters ^[0-9]+$

IMSI

count
integer [ 1 .. 5 ]
Default: 3

ping送信回数(回)

timeout
integer [ 1 .. 3 ]
Default: 1

1pingあたりのタイムアウト(秒)

Responses

200

successful operation

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tenants/{tenantId}/monitor/ping/send
https://api.ntt.com/iot-c-icgw/v1/tenants/{tenantId}/monitor/ping/send

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imsi": "dummy_imsi",
  • "count": 3,
  • "timeout": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imsi": "dummy_imsi",
  • "deviceName": "dummy_device_name",
  • "ip": "dummy_address",
  • "status": "success",
  • "message": "dummy_message"
}