MENU

Soracom

Users

グループ設定

ユーザーコンソールでの設定項目はそれぞれのエントリポイントリファレンスを参照してください。

Namespace: SoracomBeam

SORACOM Beam は、IoT デバイスにかかる暗号化等の高負荷処理や接続先の設定を、クラウドにオフロードできるサービスです。 この Namespace 以下では、データ転送に関する設定を行う事ができます。

HTTP エントリポイント

特定のパスに HTTP で受けた通信を、HTTP または HTTPS で転送を行う設定です。API エンドポイントに対して転送するのに向いています。

コンフィグパラメータ

"http://beam.soracom.io:8888/": { // 固定
  "name": "string", // 任意の名称
  "destination": "https://example.com/path/to/resource", // 通信先URL
  "enabled": true | false, // エンドポイントの有効無効
  "addSubscriberHeader": true, // Subscriber の情報をヘッダとして付与するか否か
  "customHeaders": { // 独自HTTPヘッダ
    "X-HEADER-NAME": { // 独自ヘッダの名前
      "action": "replace" | "append" | "delete", // 置換、追記、削除が選択可能
      "headerKey": "X-HEADER-NAME",
      "headerValue": "VALUE" // ヘッダに設定する内容
    }
  },
  "addSignature": true | false, // 検証用シグネチャを付与するか否か
  "psk": "string" // 検証用シグネチャを計算する際の事前共有パスフレーズ
}

設定例

[
  {
    "key": "http://beam.soracom.io:8888/",
    "value": {
      "name": "test",
      "destination": "https://beamtest.soracom.io/",
      "enabled": true,
      "addSubscriberHeader": true,
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "replace",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      },
      "addSignature": true,
      "psk": "topsecret"
    }
  }
]

Web サイト エントリポイント

全てのパスに対して HTTP で受けた通信を、HTTP または HTTPS で転送を行う設定です。Web サイト全体を Beam で転送するのに向いています。

設定上のポートは 18080 となっており、 http://beam.soracom.io:18080 でも通信を行えますが、 http://beam.soracom.io (80 番ポート)に対して通信を行ってもよい状態となっております。

コンフィグパラメータ

"http://beam.soracom.io:18080": { // 固定、スラッシュを含まない
  "name": "string", // 任意の名称
  "destination": "https://example.com", // 通信先のFQDNまでを指定
  "enabled": true | false, // エンドポイントの有効無効
  "addSubscriberHeader": true, // Subscriber の情報をヘッダとして付与するか否か
  "customHeaders": { // 独自HTTPヘッダ
    "X-HEADER-NAME": { // 独自ヘッダの名前
      "action": "replace" | "append" | "delete", // 置換、追記、削除が選択可能
      "headerKey": "X-HEADER-NAME",
      "headerValue": "VALUE" // ヘッダに設定する内容
    }
  },
  "addSignature": true | false, // 検証用シグネチャを付与するか否か
  "psk": "string" // 検証用シグネチャを計算する際の事前共有パスフレーズ
}

設定例

[
  {
    "key": "http://beam.soracom.io:18080",
    "value": {
      "name": "test",
      "destination": "https://beamtest.soracom.io",
      "enabled": true,
      "addSubscriberHeader": true,
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "replace",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      },
      "addSignature": true,
      "psk": "topsecret"
    }
  }
]

MQTT エントリポイント

MQTT で受けた通信を、MQTT または MQTTS で転送を行う設定です。

コンフィグパラメータ

"mqtt://beam.soracom.io:1883": { // 固定
  "name": "string", // 任意の名称
  "destination": "mqtts://mqtt.example.com/topicname", // MQTT接続先
  "enabled": true | false, // エンドポイントの有効無効
  "addSubscriberHeader": true | false, // topic にIMSI を足すか否か
  "username": "USERNAME", // ユーザ名(任意)
  "password": "PASSWORD", // パスワード(任意)
  "useClientCert": true | false, // TLSクライアント証明書を使用するか否か
  "clientCerts": { // 上記を有効にした場合は必須
    "default": { // 現状は証明書を1つだけ登録可能
      "key": "...", // 秘密鍵(PEM形式)
      "cert": "...", // 証明書(PEM形式)
      "ca": "...", // CA証明書(PEM形式)
    }
  },
  "useCaCert": true | false, // 独自のCA証明書を使用するか否か
  "caCert": "...", // CA証明書(PEM形式)
  "usePubnub": true | false, // 転送先がPubNubの場合Trueにする(任意、指定なしの場合 false)
  "useAzureIoT": true | false, // 転送先がAzureIoTの場合Trueにする(任意、指定なしの場合 false)
  "useGoogleIoT": true | false // 転送先がGoogleIoTの場合Trueにする(任意、指定なしの場合 false)
}

設定例

[
  {
    "key": "mqtt://beam.soracom.io:1883",
    "value": {
      "name": "AWS IoT",
      "destination": "mqtts://data.iot.ap-northeast-1.amazonaws.com:8883",
      "enabled": true,
      "addSubscriberHeader": false,
      "useClientCert": true,
      "clientCerts": {
        "default": {
          "key": "-----BEGIN RSA PRIVATE KEY-----\n...",
          "cert": "-----BEGIN CERTIFICATE-----\n...",
          "ca": "-----BEGIN CERTIFICATE-----\n..."
        }
      }
    }
  }
]

TCP→TCP/TCPS エントリポイント

任意の TCP ソケット通信を、そのまま、または TLS で暗号化して転送を行う設定です。

コンフィグパラメータ

"tcp://beam.soracom.io:8023": { // 固定
  "name": "string", // 任意
  "destination": "tcps://secure.example.com:1234", // 通信先のホスト名&ポートを指定
  "enabled": true | false, // エンドポイントの有効・無効
  "addSubscriberHeader": true | false, // 通信開始時に Subscriber の情報を送るか否か
  "addSignature": true | false, // 検証用のシグネチャを付与するか否か
  "psk": "string" // 検証用シグネチャを計算する際の事前共有パスフレーズ
}

設定例

[
  {
    "key": "tcp://beam.soracom.io:8023",
    "value": {
      "name": "beamtest",
      "destination": "tcps://beamtest.soracom.io:1234",
      "enabled": true,
      "addSubscriberHeader": true,
      "addSignature": true,
      "psk": "topsecret"
    }
  }
]

TCP→HTTP/HTTPS エントリポイント

TCP ソケットで受信したデータを JSON 形式で HTTP または HTTPS に POST をする機能です。 受け取ったデータはバイナリである可能性もあるため、base64 エンコードされて下記のような形式となり、POST されます。

{
  "payload": "BASE64エンコードされたデータ"
}

コンフィグパラメータ

"tcp://beam.soracom.io:23080": { // 固定
  "name": "string", // 任意
  "destination": "tcps://secure.example.com:1234", // 通信先のホスト名&ポートを指定
  "enabled": true | false, // エンドポイントの有効・無効
  "addSubscriberHeader": true | false, // 通信開始時に Subscriber の情報を送るか否か
  "addSignature": true | false, // 検証用のシグネチャを付与するか否か
  "psk": "string", // 検証用シグネチャを計算する際の事前共有パスフレーズ
  "customHeaders": { // 独自HTTPヘッダ
    "X-HEADER-NAME": { // 独自ヘッダの名前
      "action": "append" // 追記のみ可能
      "headerKey": "X-HEADER-NAME",
      "headerValue": "VALUE" // ヘッダに設定する内容
    }
  }
}

設定例

[
  {
    "key": "tcp://beam.soracom.io:23080",
    "value": {
      "name": "telnet2https",
      "destination": "https://beamtest.soracom.io/",
      "enabled": true,
      "addSubscriberHeader": true,
      "addSignature": true,
      "psk": "topsecret",
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "append",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      }
    }
  }
]

UDP→HTTP/HTTPS エントリポイント

UDP で受信したデータを JSON 形式で HTTP または HTTPS に POST をする機能です。 受け取ったデータはバイナリである可能性もあるため、base64 エンコードされて下記のような形式となり、POST されます。

{
  "payload": "BASE64エンコードされたデータ"
}

コンフィグパラメータ

"udp://beam.soracom.io:23080": { // 固定
  "name": "string", // 任意
  "destination": "tcps://secure.example.com:1234", // 通信先のホスト名&ポートを指定
  "enabled": true | false, // エンドポイントの有効・無効
  "addSubscriberHeader": true | false, // 通信開始時に Subscriber の情報を送るか否か
  "addSignature": true | false, // 検証用のシグネチャを付与するか否か
  "psk": "string", // 検証用シグネチャを計算する際の事前共有パスフレーズ
  "customHeaders": { // 独自HTTPヘッダ
    "X-HEADER-NAME": { // 独自ヘッダの名前
      "action": "append" // 追記のみ可能
      "headerKey": "X-HEADER-NAME",
      "headerValue": "VALUE" // ヘッダに設定する内容
    }
  }
}

設定例

[
  {
    "key": "udp://beam.soracom.io:23080",
    "value": {
      "name": "udp2https",
      "destination": "https://beamtest.soracom.io/",
      "enabled": true,
      "addSubscriberHeader": true,
      "addSignature": true,
      "psk": "topsecret",
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "append",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      }
    }
  }
]