本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>API>MQTT>DescribeMQTTInstances

DescribeMQTTInstances

処理概要

作成済みのMQTTサーバーを一覧を取得します。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
MQTTInstanceIdentifier 削作成するMQTTサーバーのサーバー名を指定します。
英数字、"_"、"-"、"."が使用可能です。
  文字列 32  

レスポンス

要素名 説明 備考
nifid @nifty ID 文字列  
MQTTInstanceIdentifier MQTTサーバー名 文字列  
Description メモ 文字列  
MQTTInstanceClass MQTTサーバータイプ 文字列  
Port ポート番号 数値  
TlsPort TLS接続用のポート番号 数値  
WebSocketPort WebSocket接続用のポート番号 数値  
WebSocketSecurePort WebSocketSecure接続用のポート番号 数値  
Host MQTTサーバーのドメイン名 文字列  
Plan MQTTサーバーのサーバータイプ 文字列  
MaxConnection MQTTサーバーの最大同時接続数 数値  
MaxThroughput MQTTサーバーの最大スループット(bps) 数値  
MQTTUser.Username MQTTにアクセスするアカウント名 文字列  
MQTTUser.Description アカウントのメモ 文字列  
MQTTUser.Parent 管理者ユーザーフラグ
true:管理者ユーザー false:一般ユーザー
文字列  

サンプル

リクエストサンプル
curl https://mqtt.api.cloud.nifty.com/mqtt ¥
  -H "x-amz-date:20151103T150000Z" ¥
  -H "authorization: AWS4-HMAC-SHA256 Credential=<YOU APP KEY>/20151103/jp-east-1/mqtt/aws4_request, SignedHeaders=host;x-amz-date, Signature=XXX..." ¥
  -H "x_amz_target:2016-01-25N2016-01-25.CreateMQTTInstance" ¥
  -H "accept-encoding':gzip, deflate" ¥
  -H "user-agent:<YOUR USER AGENT>" ¥
  -H "content-type:application/x-www-form-urlencoded" ¥
  -H "accept:application/xhtml+xml" ¥
  -H "host: mqtt.api.cloud.nifty.com:443" ¥
  -d "MQTTInstanceIdentifier=samplemqtt" ¥
  -d "Username=sampleadmin" ¥
  -d "Password=sampleadminpass" ¥
  -d "Description=sample mqtt broker"
レスポンスサンプル
<?xml version="1.0"?>
<CreateMQTTInstanceResponse
  xmlns="http://mqtt.api.cloud.nifty.com/doc/2015-03-19/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:type="CreateMQTTInstanceResponse">
  <CreateMQTTInstanceResult>
    <MQTTInstance>
      <MQTTInstanceIdentifier>samplemqtt</MQTTInstanceIdentifier>
      <Description/>
      <Port>16000</Port>
      <TlsPort>26000</TlsPort>
      <WebSocketPort>21000</WebSocketPort>
      <WebSocketSecurePort>31000</WebSocketSecurePort>
      <Host>m01.mqtt.cloud.nifty.com</Host>
      <MQTTInstanceClass>small</MQTTInstanceClass>
      <MaxConnection>100</MaxConnection>
      <MaxThroughput>50000</MaxThroughput>
      <MQTTUser>
        <Username>sampleadmin</Username>
        <Description>sample mqtt broker</Description>
        <Parent>true</Parent>
      </MQTTUser>
    </MQTTInstance>
  </CreateMQTTInstanceResult>
</CreateMQTTInstanceResponse>

推奨画面サイズ 1024×768 以上