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

Elasticsearch:InterruptElasticsearchTask

最終更新日:Mar 17, 2025

InterruptElasticsearchTask を呼び出して、変更中の Alibaba Cloud Elasticsearch インスタンスを中断します。このパラメーターは、初期化状態のインスタンスに対してのみ有効です。インスタンスが中断されると、一時停止状態になります。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

POST /openapi/instances/[InstanceId]/actions/interrupt HTTPS|HTTP

リクエストパラメーター

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

インスタンス ID。

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

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

レスポンスパラメーター

パラメータータイプ説明
CodeStringInstanceStatusNotSupportCurrentAction

エラーコード。例外が返された場合にのみ表示されます。

MessageStringThe cluster is running tasks or in an error status. Try again later.

エラーメッセージ。例外が返された場合にのみ表示されます。

RequestIdString5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****

リクエスト ID。

ResultBooleantrue

戻り値:

  • true: 変更の中断に成功しました
  • false: 変更の中断に失敗しました

リクエストの例

POST /openapi/instances/es-cn-n6w1o1x0w001c****/actions/interrupt HTTP/1.1
共通リクエストヘッダー

成功レスポンスの例

XML 形式

<Result>true</Result>
<RequestId>E9908D15-13F4-4428-B08F-A3EE8E39****</RequestId>

JSON 形式

{
    "Result": true,
    "RequestId": "E9908D15-13F4-4428-B08F-A3EE8E39****"
}

エラーコード

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

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