本文へジャンプします。

ニフクラ APIリファレンス

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

DescribeMQTTUsers

処理概要

作成済みのユーザー一覧を取得します。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
MQTTInstanceIdentifier ユーザー一覧を取得するMQTTサーバーのサーバー名を指定します。
英数字、"_"、"-"、"."が使用可能です。
文字列 32  
Username 情報を取得するユーザーのアカウント名を指定します。指定がない場合はすべてのユーザーを取得します。
英数字、"_"、"-"、"."が使用可能です。
  文字列 32  

レスポンス

要素名 説明 備考
MQTTInstanceIdentifier MQTTサーバー名 文字列  
Username アカウント名 文字列  
Description アカウントのメモ 文字列  
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.DeleteMQTTUser" ¥
  -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"
レスポンスサンプル
<?xml version="1.0"?>
<DescribeMQTTUsersResponse
  xmlns="http://mqtt.api.cloud.nifty.com/doc/2015-03-19/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-User"
  xsi:type="DescribeMQTTUsersResponse">
  <DescribeMQTTUsersResult>
    <MQTTUsers>
      <MQTTUser>
        <MQTTInstanceIdentifier>samplemqtt</MQTTInstanceIdentifier>
        <Username>sampleuser</Username>
        <Description>sample mqtt user</Description>
        <Parent>true</Parent>
      </MQTTUser>
    </MQTTUsers>
  </DescribeMQTTUsersResult>
</DescribeMQTTUsersResponse>

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