すべてのプロダクト
Search

このプロダクト

    IoT Platform:CancelOTATaskByDevice

    ドキュメントセンター

    IoT Platform:CancelOTATaskByDevice

    最終更新日:Apr 17, 2025

    保留中の確認、プッシュ対象、プッシュ済み、またはアップグレード中の状態にある無線 (OTA) アップデートパッケージのデバイスアップデートタスクをキャンセルします。

    使用方法

    [CancelOTATaskByDevice] 操作を呼び出して、保留中の確認、プッシュ対象、プッシュ済み、またはアップグレード中の状態にあるデバイスアップデートタスクのみをキャンセルできます。

    QPS 制限

    この API 操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。

    説明

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

    デバッグ

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

    リクエストパラメーター

    パラメーター

    タイプ

    必須

    例

    説明

    Action

    String

    はい

    CancelOTATaskByDevice

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

    ProductKey

    String

    はい

    a1V4kde****

    デバイスが属するプロダクトの ProductKey。

    FirmwareId

    String

    はい

    T0F5b5tpFnHQrgfk****030100

    OTA アップデートパッケージの一意の ID。

    CreateOTAFirmware 操作を呼び出してアップデートパッケージを作成すると、アップデートパッケージ ID が返されます。

    ListOTAFirmware 操作を呼び出して、レスポンスでアップデートパッケージ ID を表示できます。

    DeviceName.N

    RepeatList

    はい

    device1

    クエリするデバイス名のリスト。

    リスト内の各デバイス名は一意である必要があります。

    最大 200 の DeviceName を指定できます。

    JobId

    String

    いいえ

    wahVIzGkCMuAUE2gDERM02****

    アップデートバッチの ID。このパラメーターを設定すると、指定されたアップデートバッチ内のデバイスアップデートタスクのみがキャンセルされます。

    CreateOTAVerifyJob、CreateOTAStaticUpgradeJob、または CreateOTADynamicUpgradeJob 操作を呼び出してデバイス更新タスクを作成した後、JobId パラメーターの値を取得できます。

    IoT Platform コンソールの [アップデートパッケージの詳細] ページでバッチ ID を表示することもできます。

    IotInstanceId

    String

    いいえ

    iot_instc_pu****_c*-v64********

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

    重要

    • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。

    • インスタンスに [概要] ページまたは [ID] が生成されない場合は、このパラメーターを構成する必要はありません。

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

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

    レスポンスパラメーター

    パラメーター

    タイプ

    例

    説明

    Code

    String

    iot.system.SystemException

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

    ErrorMessage

    String

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

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

    RequestId

    String

    A01829CE-75A1-4920-B775-921146A1AB79

    リクエストの ID。

    Success

    Boolean

    true

    呼び出しが成功したかどうかを示します。有効な値：

    • true: 呼び出しは成功しました。

    • false: 呼び出しは失敗しました。

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTATaskByDevice
&FirmwareId=T0F5b5tpFnHQrgfk****030100
&ProductKey=a1V4kde****
&DeviceName.1=deviceName1
&DeviceName.2=deviceName2
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML フォーマット

    <CancelOTATaskByDeviceResponse>
    <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
    <Success>true</Success>
</CancelOTATaskByDeviceResponse>

    JSON 形式

    {
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "Success": true
}

    エラーコード

    エラーコードのリストについては、「サービスエラーコード」をご参照ください。