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

パーサーに関連付けられているデータ宛先をクエリします。

QPS 制限

各 Alibaba Cloud アカウントは、最大 10 クエリ/秒（QPS）を実行できます。

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	ListParserDestination	実行する操作。値を ListParserDestination に設定します。
ParserId	Long	はい	1002	ListParser 操作を呼び出してパーサーをクエリし、パーサーの ID を取得できます。
IsFailover	Boolean	いいえ	false	エラー操作データを転送するようにデータ宛先を構成するかどうかを指定します。エラー操作データは、他の Alibaba Cloud サービスへの転送と再転送に失敗したデータを示します。 true: エラー操作データを転送します。 false (デフォルト): エラー操作データではなく通常のデータを転送します。
IotInstanceId	String	いいえ	iot-2w****	インスタンスの ID。IoT Platform コンソールの概要ページでインスタンスの ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して概要ページまたは ID が生成されない場合は、このパラメーターを構成する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	宛先の配列		データ宛先。
destinations
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	データ宛先の構成データ。
DestinationId	Long	1003	データ宛先の ID。
IsFailover	Boolean	false	データ宛先がエラー操作データを転送するように構成されているかどうかを示します。エラー操作データは、他の Alibaba Cloud サービスへの転送と再転送に失敗したデータを示します。 true: エラー操作データが転送されます。 false (デフォルト): エラー操作データではなく通常のデータが転送されます。
Name	String	DataPurpose	データ宛先の名前。
Type	String	REPUBLISH	データ宛先のデータに対して実行される操作。 REPUBLISH: パーサースクリプトによって処理されたトピックデータを IoT Platform 通信トピックに転送します。 AMQP: パーサースクリプトによって処理されたトピックデータを Advanced Message Queuing Protocol (AMQP) コンシューマーグループに転送します。 DATAHUB: パーサースクリプトによって処理されたトピックデータをストリームコンピューティングのために Alibaba Cloud DataHub に転送します。 ONS: パーサースクリプトによって処理されたトピックデータをメッセージ配信のために Message Queue for Apache RocketMQ に転送します。 MNS: パーサースクリプトによって処理されたトピックデータをメッセージ送信のために Message Service (MNS) に転送します。 FC: パーサースクリプトによって処理されたトピックデータをイベントコンピューティングのために Function Compute に転送します。 OTS: パーサースクリプトによって処理されたトピックデータを NoSQL データストレージのために Tablestore (OTS) に転送します。
UtcCreated	String	2022-03-27T12:45:43.000Z	データ宛先が作成された時刻。時刻は UTC で表示されます。フォーマット: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`。
UtcModified	String	2022-05-27T12:45:43.000Z	データ宛先が更新された時刻。時刻は UTC で表示されます。フォーマット: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`。
ErrorMessage	String	システム例外が発生しました。	リクエストが失敗した場合に返されるエラーメッセージ。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListParserDestination
&ParserId=1002
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListParserDestinationResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <destinations>
              <Type>REPUBLISH</Type>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device1/user/get","topicType":1}</Configuration>
              <UtcModified>2022-05-27T12:45:43.000Z</UtcModified>
              <IsFailover>false</IsFailover>
              <DestinationId>1003</DestinationId>
              <Name>DataPurpose</Name>
        </destinations>
  </Data>
  <Success>true</Success>
</ListParserDestinationResponse>

JSON 形式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "destinations": [
            {
                "Type": "REPUBLISH",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device1/user/get\",\"topicType\":1}",
                "UtcModified": "2022-05-27T12:45:43.000Z",
                "IsFailover": false,
                "DestinationId": 1003,
                "Name": "DataPurpose"
            }
        ]
    },
    "Success": true
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	iot.system.SystemException	内部エラーが発生しました。後でもう一度お試しください。	システム例外が発生したために返されたエラーメッセージ。
400	iot.common.InvalidFormattedParameter	パラメーターの形式が無効です。	パラメーターの形式が無効なために返されたエラーメッセージ。
400	iot.rule.ListDestinationFailed	宛先のクエリ中にエラーが発生しました	システムがデータ宛先を取得できなかったために返されたエラーメッセージ。

エラーコードの一覧については、API エラーセンターをご参照ください。