API docs by Redocly

docomo business SIGN アプリケーション接続(MEC)/デバイスアクセス APIリファレンス (1.0.0)

Download OpenAPI specification:

URL: https://sdpf.ntt.com License: (c) 2021-2022 NTT Communications Corporation All Rights Reserved. Terms of Service

docomo business SIGN アプリケーション接続(MEC)/デバイスアクセス APIリファレンス

SIM

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

SIMの一覧情報を取得する

SIMの一覧情報を取得する

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

テナントID

query Parameters
imei
string
Example: imei=NA

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

msisdn
string
Example: msisdn=812023284118111

検索に使う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=013AAA0026

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

page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
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

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

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

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

Responses

Response samples

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

SIMの詳細情報を取得する

SIMの詳細情報を取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

msisdn
required
string
Example: dummy_msisdn

MSISDN

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "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 = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

msisdn
required
string
Example: dummy_msisdn

MSISDN

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

IMEI

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

Request samples

Content type
application/json
{
  • "imei": "dummy_imei",
  • "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
{
  • "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": {
    }
}

認証

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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 >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

認証を登録する

認証を登録する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Request Body schema: application/json
One of
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

Request samples

Content type
application/json
Example
{
  • "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
{
  • "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}\-[89a...
Example: dummy_authentication_id

認証ID

tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
Example
{
  • "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}\-[89a...
Example: dummy_authentication_id

認証ID

tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Request Body schema: application/json
One of
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

Request samples

Content type
application/json
Example
{
  • "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
{
  • "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}\-[89a...
Example: dummy_authentication_id

認証ID

tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

グループ

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
groupId
string
Example: groupId=dummy_group_id

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

name
string
Example: name=sample

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

page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

グループを登録する

グループを登録する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

グループ名

sims
Array of strings (Msisdn) unique [ items [ 5 .. 15 ] characters ^[0-9]+$ ]

Responses

Request samples

Content type
application/json
{
  • "name": "sample",
  • "sims": [
    ]
}

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

グループを更新する

グループを更新する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

グループ名

sims
Array of strings (Msisdn) unique [ items [ 5 .. 15 ] characters ^[0-9]+$ ]

Responses

Request samples

Content type
application/json
{
  • "name": "sample",
  • "sims": [
    ]
}

Response samples

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

グループを削除する

グループを削除する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

バイナリパーサー機能

バイナリパーサー機能に関するAPI

バイナリパーサーのテンプレート一覧を取得する

バイナリパーサーのテンプレート一覧を取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
name
string

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

groupId
string

検索に使うグループID

page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

policyId
string

検索に使うポリシーID

predefined
boolean
Example: predefined=false

検索に使う定義ステータス

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "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 = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

バイナリーパーサーテンプレート名

description
string <= 200 characters

説明

parserTemplate
required
string [ 1 .. 1000000 ] characters

バイナリーパーサーテンプレート

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "parserTemplate": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "predefined": true,
  • "parserTemplate": "string"
}

バイナリパーサーのテンプレートを取得する

バイナリパーサーのテンプレートを取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

bconvId
required
string

バイナリーパーサーテンプレートID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "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 = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

bconvId
required
string

バイナリーパーサーテンプレートID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

バイナリーパーサーテンプレート名

description
string <= 200 characters

説明

parserTemplate
required
string [ 1 .. 1000000 ] characters

バイナリーパーサーテンプレート

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "parserTemplate": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "predefined": true,
  • "parserTemplate": "string"
}

バイナリパーサーのテンプレートを削除する

バイナリパーサーのテンプレートを削除する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

bconvId
required
string

バイナリーパーサーテンプレートID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

フォーマット変換機能

フォーマット変換機能に関するAPI

フォーマット変換テンプレート一覧を取得する

フォーマット変換テンプレート一覧を取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
name
string

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

groupId
string

検索に使うグループID

convertType
string
Enum: "csv" "json"

検索に使う変換種別

page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

policyId
string

検索に使うポリシーID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "totalPages": 10,
  • "page": 3,
  • "pageSize": 10,
  • "fconv": [
    ]
}

フォーマット変換テンプレートを作成する

フォーマット変換テンプレートを作成する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

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

description
string [ 0 .. 200 ] characters

説明

convertType
required
string
Enum: "csv" "json"

転送先のクラウド種別

Array of objects
template
required
string [ 1 .. 1000000 ] characters

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

Responses

Request samples

Content type
application/json
{
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies": [
    ],
  • "template": "dummy_template"
}

Response samples

Content type
application/json
{
  • "id": "dummy_fconv_id",
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies": [
    ],
  • "template": "dummy_template"
}

フォーマット変換テンプレートを取得する

フォーマット変換テンプレートを取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "id": "dummy_fconv_id",
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies": [
    ],
  • "template": "dummy_template"
}

フォーマット変換テンプレートを更新する

フォーマット変換テンプレートを更新する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

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

description
string [ 0 .. 200 ] characters

説明

convertType
required
string
Enum: "csv" "json"

転送先のクラウド種別

Array of objects
template
required
string [ 1 .. 1000000 ] characters

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

Responses

Request samples

Content type
application/json
{
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies": [
    ],
  • "template": "dummy_template"
}

Response samples

Content type
application/json
{
  • "id": "dummy_fconv_id",
  • "name": "Sample Format Conversion Template",
  • "description": "Sample Format Conversion",
  • "convertType": "csv",
  • "policies": [
    ],
  • "template": "dummy_template"
}

フォーマット変換テンプレートを削除する

フォーマット変換テンプレートを削除する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

変換結果の統計を取得する

変換結果の統計を取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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

msisdn
string

検索に使うMSISDN

vconnId
string
Example: vconnId=dummy_vconn_id

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "from": "2022-11-01",
  • "to": "2022-12-01",
  • "tenantId": "dummy_tenant_id",
  • "usages": [
    ]
}

イベント機能

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

query Parameters
page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "event": [
    ]
}

イベント機能を登録する

イベント機能を登録する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

有効/無効

name
required
string [ 1 .. 50 ] characters

イベント機能名

required
object
required
object
object
fconvId
string or null^[0-9a-f]{24}$

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

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Sample GCP PubSub",
  • "entrypoint": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "dummy_id",
  • "name": "Sample GCP PubSub",
  • "entrypoint": {
    },
  • "destination": {
    },
  • "metadata": {
    },
  • "fconvId": "dummy_fconv_id"
}

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_event_id

イベント機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
Example
{
  • "id": "dummy_id",
  • "name": "Sample GCP PubSub",
  • "entrypoint": {
    },
  • "destination": {
    },
  • "metadata": {
    },
  • "fconvId": "dummy_fconv_id"
}

イベント機能を更新する

イベント機能を更新する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_event_id

イベント機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

有効/無効

name
required
string [ 1 .. 50 ] characters

イベント機能名

required
object
required
object
object
fconvId
string or null^[0-9a-f]{24}$

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

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Sample GCP PubSub",
  • "entrypoint": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "dummy_id",
  • "name": "Sample GCP PubSub",
  • "entrypoint": {
    },
  • "destination": {
    },
  • "metadata": {
    },
  • "fconvId": "dummy_fconv_id"
}

イベント機能を削除する

イベント機能を削除する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_event_id

イベント機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

ファンクション機能

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

query Parameters
page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "func": [
    ]
}

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

有効/無効

name
required
string [ 1 .. 50 ] characters

ファンクション機能名

required
object
required
object
object
fconvId
string or null^[0-9a-f]{24}$

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

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Sample AWS Lambda",
  • "entrypoint": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "dummy_id",
  • "name": "Sample AWS Lambda",
  • "enabled": true,
  • "entrypoint": {
    },
  • "destination": {
    },
  • "metadata": {
    },
  • "fconvId": "dummy_fconv_id"
}

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_func_id

ファンクション機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
Example
{
  • "id": "dummy_id",
  • "name": "Sample AWS Lambda",
  • "enabled": true,
  • "entrypoint": {
    },
  • "destination": {
    },
  • "metadata": {
    },
  • "fconvId": "dummy_fconv_id"
}

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_func_id

ファンクション機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

有効/無効

name
required
string [ 1 .. 50 ] characters

ファンクション機能名

required
object
required
object
object
fconvId
string or null^[0-9a-f]{24}$

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

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Sample AWS Lambda",
  • "entrypoint": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "dummy_id",
  • "name": "Sample AWS Lambda",
  • "enabled": true,
  • "entrypoint": {
    },
  • "destination": {
    },
  • "metadata": {
    },
  • "fconvId": "dummy_fconv_id"
}

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_func_id

ファンクション機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

スタンダード機能

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

query Parameters
page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

有効/無効

name
required
string [ 1 .. 50 ] characters

スタンダード機能名

type
required
string
Value: "mqtt"

変換タイプ

required
object
object
fconvId
string or null^[0-9a-f]{24}$

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

object

Responses

Request samples

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

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_pconv_id

スタンダード機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_pconv_id

スタンダード機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

有効/無効

name
required
string [ 1 .. 50 ] characters

スタンダード機能名

type
required
string
Value: "mqtt"

変換タイプ

required
object
object
fconvId
string or null^[0-9a-f]{24}$

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

object

Responses

Request samples

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

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_pconv_id

スタンダード機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

ストレージ機能

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

query Parameters
page
integer >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

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

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

  • typeキーのデフォルト値はhttp
path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

グループID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

変換タイプ

name
required
string [ 1 .. 50 ] characters

ストレージ機能名

enabled
boolean
Default: true

有効/無効

required
object
required
object
object

Responses

Request samples

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

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_storage_id

ストレージ機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_storage_id

ストレージ機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

変換タイプ

name
required
string [ 1 .. 50 ] characters

ストレージ機能名

enabled
boolean
Default: true

有効/無効

required
object
required
object
object

Responses

Request samples

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

Response samples

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

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

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナント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}\-[89a...
Example: dummy_storage_id

ストレージ機能ID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

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

デバイスアクセス

デバイスアクセス機能に関するAPI

デバイスアクセス設定の一覧を取得する

デバイスアクセス設定の一覧を取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
imei
string
Example: imei=NA

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

deviceName
string
Example: deviceName=dummy_device_name

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

hsn
string
Example: hsn=013AAA0026

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

msisdn
string
Example: msisdn=812023284118111

検索に使う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 >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "accesses": [
    ]
}

デバイスアクセス設定を登録する

デバイスアクセス設定を登録する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

MSISDN

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

アクセス元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

Request samples

Content type
application/json
Example
{
  • "msisdn": "dummy_msisdn",
  • "sourcePrefixes": [
    ],
  • "devicePort": 1234,
  • "endTime": "2022-06-15T00:00:00.000Z",
  • "infinityMode": false,
  • "isTls": false
}

Response samples

Content type
application/json
{
  • "id": "dummy_remote_access",
  • "msisdn": "dummy_msisdn",
  • "sourcePrefixes": [
    ],
  • "endpointHost": "dummy_endpoint_host",
  • "endpointPort": 1234,
  • "devicePort": 1234,
  • "startTime": "2022-06-15T00:00:00.000Z",
  • "endTime": "2022-06-15T00:00:00.000Z",
  • "infinityMode": false,
  • "isTls": false,
  • "imei": "NA",
  • "deviceName": "dummy_device_name",
  • "hsn": "dummy_hsn",
  • "activeIp": [
    ],
  • "portStatus": true
}

デバイスアクセスの設定を取得する

デバイスアクセスの設定を取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

デバイスアクセスID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "id": "dummy_remote_access",
  • "msisdn": "dummy_msisdn",
  • "sourcePrefixes": [
    ],
  • "endpointHost": "dummy_endpoint_host",
  • "endpointPort": 1234,
  • "devicePort": 1234,
  • "startTime": "2022-06-15T00:00:00.000Z",
  • "endTime": "2022-06-15T00:00:00.000Z",
  • "infinityMode": false,
  • "isTls": false,
  • "imei": "NA",
  • "deviceName": "dummy_device_name",
  • "hsn": "dummy_hsn",
  • "activeIp": [
    ],
  • "portStatus": true
}

デバイスアクセスの設定を更新する

デバイスアクセスの設定を更新する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

デバイスアクセスID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

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

接続先デバイスポート

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

アクセス元Prefix

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

終了時刻

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "dummy_remote_access",
  • "msisdn": "dummy_msisdn",
  • "sourcePrefixes": [
    ],
  • "endpointHost": "dummy_endpoint_host",
  • "endpointPort": 1234,
  • "devicePort": 1234,
  • "startTime": "2022-06-15T00:00:00.000Z",
  • "endTime": "2022-06-15T00:00:00.000Z",
  • "infinityMode": false,
  • "isTls": false,
  • "imei": "NA",
  • "deviceName": "dummy_device_name",
  • "hsn": "dummy_hsn",
  • "activeIp": [
    ],
  • "portStatus": true
}

デバイスアクセスを停止する

デバイスアクセスを停止する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

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

デバイスアクセスID

Responses

Response samples

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

デバイスアクセス設定の履歴を取得する

デバイスアクセスの設定の履歴を取得する

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
imei
string
Example: imei=NA

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

deviceName
string
Example: deviceName=dummy_device_name

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

hsn
string
Example: hsn=013AAA0026

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

msisdn
string
Example: msisdn=812023284118111

検索に使う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 >= 1
Example: page=3

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

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

Response samples

Content type
application/json
{
  • "totalPages": 200,
  • "page": 1,
  • "pageSize": 20,
  • "histories": [
    ]
}

クラスタ構築

アプリケーション接続(MEC) クラスタ構築に関するAPI

アプリケーション接続(MEC)クラスタ情報を取得する

指定されたテナントのアプリケーション接続(MEC)クラスタ構築/削除の状況およびクラスタ詳細情報を取得します。

レスポンスの status フィールドで構築/削除の状況を確認できます。

  • processing: 処理中
    ※構築やロールバックが失敗し、処理が中断している場合もこのステータスとなります。
  • completed: 完了
    ※クラスタ削除完了後は 404 Not Found が返却されます。
path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
string

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

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    },
  • "simGroupId": "14674",
  • "status": "completed"
}

アプリケーション接続(MEC)クラスタを構築する

指定されたテナントにアプリケーション接続(MEC)クラスタを作成します。
処理は非同期で行われ、受付完了後に 202 Accepted と orderId を返却します。
構築完了まで数十分程度かかります。
進捗状況はクラスタ情報取得APIで確認してください。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
string

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

Request Body schema: application/json
simGroupId
required
string

SIMグループID

description
string <= 200 characters

クラスタの説明(用途など)

Responses

Request samples

Content type
application/json
{
  • "simGroupId": "14674",
  • "description": "テストクラスタ"
}

Response samples

Content type
application/json
{
  • "orderId": "0425bc9acf6311f09b1b06280acbcfa2"
}

アプリケーション接続(MEC)クラスタを削除する

指定されたテナントのアプリケーション接続(MEC)クラスタを削除します。
処理は非同期で行われ、受付完了後に 202 Accepted と orderId を返却します。
削除完了まで数十分程度かかります。
進捗状況はクラスタ情報取得APIで確認してください。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

Responses

Response samples

Content type
application/json
{
  • "orderId": "0489c190c04f11f083356ecaa999fbb8"
}