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

データ転送先の詳細を照会します。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	GetDestination	実行する操作。値を GetDestination に設定します。
DestinationId	Long	Yes	1004	データ転送先の ID。ListDestination 操作を呼び出してデータ転送先を照会し、データ転送先の ID を取得できます。
IotInstanceId	String	No	iot-2w****	インスタンスの ID。IoT Platform コンソールの概要ページで、インスタンスの ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して概要ページまたは ID が生成されていない場合は、このパラメーターを構成する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Destination	Struct		データ転送先に関する情報。
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	データ転送先の構成データ。
DestinationId	String	1003	データ転送先の ID。
IsFailover	Boolean	false	ルールアクションが、転送先のクラウドサービスへの転送に失敗したエラー操作データを転送したかどうかを示します。データ転送の失敗は、転送の再試行も失敗したことを示します。 true: エラー操作データが転送されます。 false: エラー操作データではなく、通常のデータが転送されます。デフォルト値: false。
Name	String	DataPurpose	データ転送先の名前。
Status	String	NORMAL	データ転送先のステータス。有効な値: INIT: データ転送先は初期化中です。 NORMAL: 構成は完了です。データ転送先は使用可能です。 INVALID: 構成が異常です。データ転送先は使用できません。 SHORTCUT: データ転送サービスが異常なため、データ転送操作は中止されました。
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'`。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDestination
&DestinationId=1004
&<Common request parameters>

成功レスポンスの例

XML 形式

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

JSON 形式

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

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	iot.system.IllegalRequest	The request parameter is invalid.	リクエストパラメーターが無効なために返されるエラーメッセージ。
400	iot.system.SystemException	An internal error occurred. Try again later.	システム例外が発生したために返されるエラーメッセージ。

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