すべてのプロダクト
Search

このプロダクト

    IoT Platform:ListDestination

    ドキュメントセンター

    IoT Platform:ListDestination

    最終更新日:Apr 17, 2025

    データ転送先をクエリします。

    QPS 制限

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

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

    デバッグ

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

    リクエストパラメータ

    パラメータタイプ必須例説明
    ActionStringYesListDestination

    実行する操作。値を ListDestination に設定します。

    PageIntegerYes1

    返すページ番号。有効な値：1～100。

    PageSizeIntegerYes10

    各ページに返すエントリの数。最大値：100。

    IotInstanceIdStringNoiot-2w****

    インスタンスの ID。IoT Platform コンソールの [概要] ページで、インスタンスの ID を表示できます。

    重要
    • インスタンスに ID がある場合は、このパラメータに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
    • IoT Platform コンソールに [概要] ページまたはインスタンス ID が表示されない場合は、このパラメータを設定する必要はありません。

    インスタンスの詳細については、「概要」をご参照ください。

    SearchNameStringNoDataPurpose

    データ転送先をクエリするために使用される文字列。データ転送先名に一致するキーワードを指定できます。

    Types.NRepeatListNo["REPUBLISH", "OTS"]

    データをデータ転送先に転送する操作。データは、転送される前にパーサースクリプトを使用して処理されます。有効な値：

    • REPUBLISH: Topic データを IoT Platform 通信 Topic に転送します。
    • AMQP: Topic データを Advanced Message Queuing Protocol（AMQP）コンシューマーグループに転送します。
    • DATAHUB: ストリームデータ処理のために Topic データを Alibaba Cloud DataHub に転送します。
    • ONS: メッセージ配信のために Topic データを Message Queue for Apache RocketMQ に転送します。
    • MNS: メッセージ送信のために Topic データを Message Service（MNS）に転送します。
    • FC: イベントコンピューティングのために Topic データを Function Compute に転送します。
    • OTS: NoSQL データストレージのために Topic データを Tablestore（OTS）に転送します。

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

    レスポンスパラメータ

    パラメータタイプ例説明
    CodeStringiot.system.SystemException

    呼び出しが失敗した場合に返されるエラーコード。エラーコードの詳細については、「エラーコード」をご参照ください。

    DestinationsArray of destinations

    データ転送先。

    destinations
    ConfigurationString{"topic":"/a1POX0c****/device1/user/get","topicType":1}

    データ転送先の構成。

    DescriptionStringデータはデータベースに転送されます。

    データ転送先の説明。

    DestinationIdLong1003

    データ転送先の ID。

    IsFailoverBooleanfalse

    データ転送先がエラー操作データを受信するように構成されているかどうかを示します。エラー操作データとは、2 回連続して転送に失敗したデータです。

    • true: データ転送先は、エラー操作データを受信するように構成されています。
    • false: データ転送先は、エラー操作データではなく通常のデータを受信するように構成されています。

    デフォルト値：false

    NameStringDataPurpose

    データ転送先の名前。

    StatusStringNORMAL

    データ転送先のステータス。有効な値：

    • INIT: 構成が進行中です。
    • NORMAL: 構成が完了し、データ転送先が使用可能です。
    • INVALID: 構成が無効であり、データ転送先が使用できません。
    • SHORTCUT: 例外が発生し、データ転送が停止しました。
    TypeStringREPUBLISH

    データをデータ転送先に転送する操作。

    UtcCreatedString2022-03-27T12:45:43.000Z

    データ転送先が作成された時刻。時刻は UTC で表示されます。フォーマット：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。

    ErrorMessageStringシステム例外が発生しました。

    呼び出しが失敗した場合に返されるエラーメッセージ。

    PageInteger1

    返されたページのページ番号。

    PageSizeInteger10

    1 ページあたりに返されるエントリの数。

    RequestIdStringE4C0FF92-2A86-41DB-92D3-73B60310D25E

    リクエストの ID。この ID は、このリクエストを一意に識別します。

    SuccessBooleantrue

    呼び出しが成功したかどうかを示します。

    • true: 呼び出しは成功しました。
    • false: 呼び出しは失敗しました。
    TotalInteger100

    返されたエントリの総数。

    例

    リクエストの例

    http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDestination
&Page=1
&PageSize=10
&<Common request parameters>

    成功レスポンスの例

    XML 形式

    <ListDestinationResponse>
  <PageSize>10</PageSize>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Total>100</Total>
  <Destinations>
        <destinations>
              <Type>REPUBLISH</Type>
              <Description>The data is forwarded to another topic. </Description>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device1/user/get","topicType":1}</Configuration>
              <IsFailover>false</IsFailover>
              <Status>NORMAL</Status>
              <DestinationId>1004</DestinationId>
              <Name>DataPurpose1</Name>
        </destinations>
        <destinations>
              <Type>REPUBLISH</Type>
              <Description>The data is forwarded to another topic. </Description>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device2/user/get","topicType":1}</Configuration>
              <IsFailover>false</IsFailover>
              <Status>NORMAL</Status>
              <DestinationId>1005</DestinationId>
              <Name>DataPurpose2</Name>
        </destinations>
  </Destinations>
  <Page>1</Page>
  <Success>true</Success>
</ListDestinationResponse>

    JSON 形式

    {
    "PageSize": 10,
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": 100,
    "Destinations": {
        "destinations": [
            {
                "Type": "REPUBLISH",
                "Description": "The data is forwarded to another topic.",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device1/user/get\",\"topicType\":1}",
                "IsFailover": false,
                "Status": "NORMAL",
                "DestinationId": 1004,
                "Name": "DataPurpose1"
            },{
                "Type": "REPUBLISH",
                "Description": "The data is forwarded to another topic.",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device2/user/get\",\"topicType\":1}",
                "IsFailover": false,
                "Status": "NORMAL",
                "DestinationId": 1005,
                "Name": "DataPurpose2"
            }
        ]
    },
    "Page": 1,
    "Success": true
}

    エラーコード

    HttpCodeエラーコードエラーメッセージ説明
    400iot.system.SystemException内部エラーが発生しました。後でもう一度お試しください。システム例外が発生したために返されたエラーメッセージ。
    400iot.system.IllegalRequestリクエストパラメータが無効です。リクエストパラメータが無効なために返されたエラーメッセージ。

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