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

動的更新ポリシーをキャンセルします。

制限

動的更新バッチにアタッチされている動的更新ポリシーのみをキャンセルできます。この操作は、静的更新バッチには適用されません。
操作が成功すると、[JobStatus] パラメーターは CANCELED に設定されます。
各 Alibaba Cloud アカウントは、最大 10 クエリ/秒（QPS）を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	CancelOTAStrategyByJob	実行する操作。値を CancelOTAStrategyByJob に設定します。
JobId	String	はい	HvKuBpuk3rdk6E92CP****0200	更新バッチの ID。 CreateOTADynamicUpgradeJob 操作を呼び出して更新バッチを作成すると、[JobId] パラメーターが返されます。IoT Platform コンソールの [ファームウェアの詳細] ページでバッチ ID を表示することもできます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID です。[ID] は、IoT Platform コンソールの [概要] ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに [概要] ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	リクエストの ID。
Success	ブール値	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTAStrategyByJob
&JobId=HvKuBpuk3rdk6E92CP****0200
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

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

JSON 形式

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

エラーコード

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