すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:CancelTask

最終更新日:Mar 17, 2025

CancelTask を呼び出して、データ移行タスクをキャンセルします。

デバッグ

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

リクエストヘッダー

この操作では、共通のリクエストパラメーターのみを使用します。 詳細については、「共通パラメーター」をご参照ください。

リクエスト構文

POST /openapi/instances/[InstanceId]/actions/cancel-task HTTPS|HTTP

リクエストパラメーター

パラメータータイプ必須説明
InstanceIdStringはいes-cn-nif1q9o8r0008****

インスタンス ID。

taskTypeStringはいMigrateData

データ移行タスクのタイプ。 値を MigrateData に設定します。

clientTokenStringいいえ5A2CFF0E-5718-45B5-9D4D-70B3FF****

リクエストの冪等性を保証するためにクライアントによって生成された一意のトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

レスポンスパラメーター

パラメータータイプ説明
RequestIdStringF99407AB-2FA9-489E-A259-40CF6DCC****

リクエスト ID。

Resultブール値true

戻り値:

  • true: タスクは正常にキャンセルされました
  • false: タスクのキャンセルに失敗しました

リクエストの例

POST /openapi/instances/es-cn-nif1q9o8r0008****/actions/cancel-task? taskType=MigrateData HTTP/1.1

正常なレスポンスの例

JSON 形式

{
    "Result": true,
    "RequestId": "C82758DD-282F-4D48-934F-92170A33****"
}

エラーコード

HttpCodeエラーコードエラーメッセージ説明
400InstanceNotFoundThe instanceId provided does not exist.指定されたインスタンスが見つからないため返されたエラーメッセージ。 インスタンスの状態を確認してください。

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