すべてのプロダクト
Search

このプロダクト

    IoT Platform:UpdateDestination

    ドキュメントセンター

    IoT Platform:UpdateDestination

    最終更新日:Apr 17, 2025

    データ転送先の名前、操作タイプ、および説明を更新します。

    使用方法

    CreateDestination 操作を呼び出してデータ転送先を作成した後、CreateDestination 操作から返された DestinationId パラメーターの値に基づいて、その情報を更新できます。

    QPS 制限

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

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

    デバッグ

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

    リクエストパラメーター

    パラメーター タイプ 必須 例 説明
    Action String Yes UpdateDestination

    実行する操作。値を UpdateDestination に設定します。
    Configuration String Yes {"topic":"/a1POX0c****/device1/user/get","topicType":1}

    データ転送先の構成。値を JSON 文字列に設定します。構成は、指定したルールのアクションタイプによって異なります。詳細については、CreateDestination トピックの Configuration パラメーターの説明をご参照ください。送信先を作成する
    DestinationId Long Yes 1002

    データ転送先の ID。

    ListDestination 操作を呼び出して、データ転送先をクエリし、データ転送先 の ID を取得できます。
    Name String Yes DataPurpose

    データ転送先の名前。
    Type String Yes 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）に転送します。
    IotInstanceId String No iot-2w****

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

    重要
    • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
    • インスタンスに対して 概要 ページまたは ID が生成されていない場合は、このパラメーターを構成する必要はありません。

    詳細については、「概要」をご参照ください。
    Description String No The data that is forwarded to another topic.

    データ転送先の説明。

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

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    Code String iot.system.SystemException

    呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
    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=UpdateDestination
&Configuration={"topic":"/a1POX0c****/device1/user/get","topicType":1}
&DestinationId=1002
&Name=DataPurpose
&Type=REPUBLISH
&<Common request parameters>

    成功レスポンスの例

    XML 形式

    <UpdateDestinationResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</UpdateDestinationResponse>

    JSON 形式

    {
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

    エラーコード

    HttpCode エラーコード エラーメッセージ 説明
    400 iot.system.SystemException An internal error occurred. Try again later. システム例外が発生したために返されたエラーメッセージ。
    400 iot.ruleng.NullRuleActionConfig The rule action configuration is empty. ルールにアクションが指定されていないために返されたエラーメッセージ。
    400 iot.common.InvalidFormattedParameter The parameter format is invalid. パラメーター形式が無効なために返されたエラーメッセージ。

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