すべてのプロダクト
Search

このプロダクト

    IoT Platform:CancelOTATaskByJob

    ドキュメントセンター

    IoT Platform:CancelOTATaskByJob

    最終更新日:Apr 17, 2025

    指定されたバッチの更新タスクをキャンセルします。

    使用方法

    この操作を呼び出すときは、CancelScheduledTask、CancelQueuedTask、CancelInProgressTask、CancelNotifiedTask、および CancelUnconfirmedTask パラメーターの少なくとも 1 つを指定してください。指定しないと、リクエストは失敗します。

    QPS 制限

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

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

    デバッグ

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

    リクエストパラメーター

    パラメーター タイプ 必須 例 説明
    Action String はい CancelOTATaskByJob

    実行する操作。値を CancelOTATaskByJob に設定します。
    JobId String はい 7glPHmaDYLAYMD1HHutT02****

    更新バッチの ID。

    ジョブ IDCreateOTAStaticUpgradeJob または CreateOTADynamicUpgradeJob 操作のレスポンスに含まれる JobId パラメーターに返される値を使用します。IoT Platform コンソールの ページでバッチ ID を取得することもできます。
    IotInstanceId String いいえ iot_instc_pu****_c*-v64********

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

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

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

    スケジュールされた更新バッチの更新タスクをキャンセルするかどうかを指定します。CreateOTAStaticUpgradeJob 操作を呼び出すときに ScheduleTime パラメーターを指定すると、スケジュールされた更新バッチが作成されます。デフォルト値：false。有効な値：OTA静的アップグレードジョブの作成

    • true：スケジュールされた更新バッチの更新タスクをキャンセルします。
    • false：スケジュールされた更新バッチの更新タスクをキャンセルしません。
    CancelQueuedTask Boolean いいえ false

    更新バッチで QUEUED 状態にある更新タスクをキャンセルするかどうかを指定します。デフォルト値：false。有効な値：

    • true：NOTIFIED 状態にある更新タスクをキャンセルします。
    • false：NOTIFIED 状態にある更新タスクをキャンセルしません。
    重要 このパラメーターを true に設定し、CancelUnconfirmedTask パラメーターを指定すると、QUEUED 状態にある更新タスクのみがキャンセルされます。CancelUnconfirmedTask パラメーターを指定しないと、QUEUED または CONFIRM 状態にある更新タスクがキャンセルされます。
    CancelInProgressTask Boolean いいえ false

    更新バッチで IN_PROGRESS 状態にある更新タスクをキャンセルするかどうかを指定します。デフォルト値：false。有効な値：

    • true：IN_PROGRESS 状態にある更新タスクをキャンセルします。
    • false：IN_PROGRESS 状態にある更新タスクをキャンセルしません。
    CancelNotifiedTask Boolean いいえ false

    更新バッチで NOTIFIED 状態にある更新タスクをキャンセルするかどうかを指定します。デフォルト値：false。有効な値：

    • true：NOTIFIED 状態にある更新タスクをキャンセルします。
    • false：NOTIFIED 状態にある更新タスクをキャンセルしません。
    CancelUnconfirmedTask Boolean いいえ false

    更新バッチで CONFIRM 状態にある更新タスクをキャンセルするかどうかを指定します。デフォルト値：false。有効な値：

    • true：CONFIRM 状態にある更新タスクをキャンセルします。
    • false：CONFIRM 状態にある更新タスクをキャンセルしません。

    このパラメーターはデフォルトで空です。

    重要 このパラメーターを指定せず、CancelQueuedTask パラメーターを true に設定すると、CONFIRM 状態にある更新タスクがキャンセルされます。CancelQueuedTask パラメーターを false に設定すると、CONFIRM 状態にある更新タスクはキャンセルされません。

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

    レスポンスパラメーター

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

    呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
    ErrorMessage String システム例外が発生しました。

    呼び出しが失敗した場合に返されるエラーメッセージ。
    RequestId String 291438BA-6E10-4C4C-B761-243B9A0D324F

    リクエストの ID。
    Success Boolean true

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

    • true
    • false

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&CancelScheduledTask=false
&CancelQueuedTask=true
&CancelNotifiedTask=false
&CancelInProgressTask=false
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

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

    JSON 形式

    {
  "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
  "Success": true
}

    エラーコード

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