本文へジャンプします。

ニフクラ APIリファレンス

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

ModifyMQTTInstance

処理概要

MQTTサーバーの設定を変更します。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
MQTTInstanceIdentifier 作成するMQTTサーバーのサーバー名を指定します。
英数字、"_"、"-"、"."が使用可能です。
文字列 32  
MQTTInstanceClass MQTTサーバーのサーバータイプを変更します。
small:smallタイプ large:largeタイプ
  文字列 32 small  
Description 作成するMQTTサーバーのメモを変更します。   文字列 512  

レスポンス

要素名 説明 備考
nifid @nifty ID 文字列  
MQTTInstanceIdentifier MQTTサーバー名 文字列  
Description メモ 文字列  
MQTTInstanceClass MQTTサーバータイプ 文字列  
Port ポート番号 数値  
TlsPort TLS接続用のポート番号 数値  
WebSocketPort WebSocket接続用のポート番号 数値  
WebSocketSecurePort WebSocketSecure接続用のポート番号 数値  
Host 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.ModifyMQTTInstances" ¥
  -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 "Description=sample mqtt broker added comment"
レスポンスサンプル
<?xml version="1.0"?>
<ModifyMQTTInstanceResponse
  xmlns="http://mqtt.api.cloud.nifty.com/doc/2015-03-19/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:type="ModifyMQTTInstanceResponse">
  <ModifyMQTTInstanceResult>
    <MQTTInstance>
      <MQTTInstanceIdentifier>samplemqtt</MQTTInstanceIdentifier>
      <Description>sample mqtt broker added comment</Description>
      <MQTTInstanceClass>small</MQTTInstanceClass>
      <MaxMQTTInstanceClass>small</MaxMQTTInstanceClass>
      <Host>m01.mqtt.cloud.nifty.com</Host>
      <Port>16000</Port>
      <TlsPort>26000</TlsPort>
      <WebSocketPort>21000</WebSocketPort>
      <WebSocketSecurePort>31000</WebSocketSecurePort>
      <MaxConnection>100</MaxConnection>
      <MaxThroughput>50000</MaxThroughput>
      <MQTTUser>
        <Username>sampleadmin</Username>
        <Description>sample mqtt broker</Description>
        <Parent>true</Parent>
      </MQTTUser>
    </MQTTInstance>
  </ModifyMQTTInstanceResult>
</ModifyMQTTInstanceResponse>

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