Message Service (MNS) または AMQP サーバー側サブスクリプションをクエリします。
制限
各 Alibaba Cloud アカウントは、最大 5 クエリ/秒 (QPS) を実行できます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | はい | QuerySubscribeRelation | 実行する操作。値を QuerySubscribeRelation に設定します。 |
| ProductKey | String | はい | a1fyXVF**** | サブスクリプションに指定されたプロダクトの ProductKey。 |
| Type | String | はい | AMQP | サブスクリプションのタイプ。有効な値：
|
| IotInstanceId | String | いいえ | iot-cn-0pp1n8t**** | インスタンスの ID。インスタンス ID は、IoT Platform コンソールの 概要 ページで確認できます。 重要
詳細については、「概要」をご参照ください。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| DeviceDataFlag | Boolean | true | アップストリームデバイスメッセージがプッシュされたかどうかを示します。
|
| DeviceStatusChangeFlag | Boolean | true | デバイスのステータス変更に関するメッセージがプッシュされたかどうかを示します。
|
| FoundDeviceListFlag | Boolean | true | ゲートウェイが新しいサブデバイスを検出した場合にメッセージがプッシュされたかどうかを示します。
|
| DeviceTopoLifeCycleFlag | Boolean | true | デバイスのトポロジ関係の変更に関するメッセージがプッシュされたかどうかを示します。
|
| DeviceLifeCycleFlag | Boolean | true | デバイスのライフサイクル変更に関するメッセージがプッシュされたかどうかを示します。
|
| ThingHistoryFlag | Boolean | true | アップストリームの履歴 Thing Specification Language (TSL) データがプッシュされたかどうかを示します。
|
| OtaEventFlag | Boolean | true | ファームウェアアップデートバッチのステータスに関する通知がプッシュされたかどうかを示します。
|
| DeviceTagFlag | Boolean | true | デバイスタグの変更に関するメッセージがプッシュされたかどうかを示します。有効な値：
デフォルト値: false。 |
| OtaVersionFlag | Boolean | true | ファームウェアアップデートモジュールのバージョン番号に関するメッセージがプッシュされたかどうかを示します。有効な値：
デフォルト値: false。 |
| OtaJobFlag | Boolean | true | ファームウェアアップデートバッチ更新に関する通知がプッシュされたかどうかを示します。有効な値：
デフォルト値: false。 |
| ProductKey | String | a1fyXVF**** | サブスクリプションに指定されたプロダクトの ProductKey。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。
|
| ConsumerGroupIds | List | [DEFAULT_GROUP,br45A6A1amoRFGN7x1zP00****] | AMQP サブスクリプションで作成されたコンシューマーグループの ID。Type パラメーターが AMQP に設定されている場合、このパラメーターが返されます。 |
| Type | String | AMQP | サブスクリプションのタイプ。有効な値：
|
| RequestId | String | 21D327AF-A7DE-4E59-B5D1-ACAC8C024555 | リクエストの ID。 |
| MnsConfiguration | String | { "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } } | MNS キューの構成。Type パラメーターが MNS に設定されている場合、このパラメーターが返されます。 詳細については、「MnsConfiguration パラメーターの定義」セクションをご参照ください。 |
コマンド | 説明 |
queueName | データを受信するために使用される MNS Topic の名前。 |
regionName | MNS がデプロイされているリージョンのコード。例: cn-shanghai。 |
role | RAM ロールの情報。IoT Platform に MNS へのアクセス権を付与するには、IoT Platform に RAM ロールを割り当てることができます。次のスクリプトは、RAM ロールの構文を示しています。
|
サンプルレスポンス
{
"queueName": "mns-test-topic1",
"regionName": "cn-shanghai",
"role": {
"roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole",
"roleName": "AliyunIOTAccessingMNSRole"
}
}
例
サンプルリクエスト
https://iot.cn-shanghai.aliyuncs.com/?Action=QuerySubscribeRelation
&ProductKey=a1Zkii7****
&Type=AMQP
&<共通リクエストパラメーター>サンプルの成功レスポンス
XML 形式
<QuerySubscribeRelationResponse>
<ConsumerGroupIds>
<e>Xs95KifeaSKbi8tKkcoD00****</e>
</ConsumerGroupIds>
<DeviceDataFlag>false</DeviceDataFlag>
<DeviceLifeCycleFlag>false</DeviceLifeCycleFlag>
<DeviceStatusChangeFlag>false</DeviceStatusChangeFlag>
<DeviceTopoLifeCycleFlag>false</DeviceTopoLifeCycleFlag>
<FoundDeviceListFlag>false</FoundDeviceListFlag>
<OtaEventFlag>true</OtaEventFlag>
<ProductKey>a1Zkii7****</ProductKey>
<RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
<Success>true</Success>
<ThingHistoryFlag>false</ThingHistoryFlag>
<Type>AMQP</Type>
</QuerySubscribeRelationResponse>JSON 形式
{
"DeviceLifeCycleFlag": false,
"RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
"DeviceDataFlag": false,
"DeviceTopoLifeCycleFlag": false,
"DeviceStatusChangeFlag": false,
"ConsumerGroupIds": [
"Xs95KifeaSKbi8tKkcoD00****"
],
"Success": true,
"ThingHistoryFlag": false,
"Type": "AMQP",
"FoundDeviceListFlag": false,
"OtaEventFlag": true,
"ProductKey": "a1Zkii7****"
}エラーコード
エラーコードの一覧については、API エラーセンターをご参照ください。