QueryDeviceSubTopic - IoT Platform - Alibaba Cloud ドキュメントセンター

デバイスがサブスクライブしている Topic を照会します。

QPS 制限

この操作は、アカウントごとに 1 秒あたり最大 100 回呼び出すことができます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceSubTopic	実行する操作。値を QueryDeviceSubTopic に設定します。
ProductKey	String	はい	hf768****	デバイスが属するプロダクトの ProductKey。 IoT Platform コンソールを使用するか、QueryProductList 操作を呼び出して、現在の Alibaba Cloud アカウント内のすべてのプロダクトに関する情報を表示できます。
DeviceName	String	はい	device1	デバイスの名前。 IoT Platform コンソールを使用するか、QueryDeviceInfo 操作を呼び出して、デバイスに関する情報を表示できます。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの [概要] ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。インスタンス ID を指定しないと、呼び出しは失敗します。 IoT Platform コンソールに [概要] ページまたはインスタンス ID が表示されない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエストの ID。 ID は、このリクエストを一意に識別します。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。
TopicList	Topic の配列		デバイスがサブスクライブしている Topic に関する情報。このパラメーターは、呼び出しが成功した場合に返されます。
Timestamp	Long	1662039965873	デバイスが Topic をサブスクライブした時刻。単位：ミリ秒。
TopicName	String	/hf768****/device1/user/test	Topic の名前。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceSubTopic
&ProductKey=hf768****
&DeviceName=device1
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryDeviceSubTopicResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <TopicList>
        <Timestamp>1662039965873</Timestamp>
        <TopicName>/hf768****/device1/user/test</TopicName>
  </TopicList>
  <TopicList>
        <Timestamp>1662039965873</Timestamp>
        <TopicName>/hf768****/device1/user/down</TopicName>
  </TopicList>
  <Success>true</Success>
</QueryDeviceSubTopicResponse>

JSON 形式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "TopicList": [
    {
        "Timestamp": 1662039965873,
        "TopicName": "/hf768****/device1/user/test"
    },
    {
        "Timestamp": 1662039965873,
        "TopicName": "/hf768****/device1/user/down"
    }
    ],
    "Success": true
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。