edit-icon download-icon

StopInvocation

最終更新日: Feb 26, 2019

説明

クラウドアシスタントが ECS インスタンスで「実行中」の状態にあるプロセスを停止します。 このインターフェイスを呼び出すときは、次の点を考慮してください。

  • 一度の呼び出しでコマンド・プロセスを停止すると、インスタンスで開始された呼び出し操作が進行し、開始されていない呼び出し操作は停止します。

  • 定期的な呼び出しでコマンド・プロセスを停止すると、インスタンスで開始された呼び出し操作は続行されますが、呼び出しは次の期間には進まません。

リクエストパラメータ

名前 必須かどうか 説明
Action String Yes インタフェースの名前。 値:StopInvocation。
RegionId String Yes リージョン ID。 詳細は、DescribeRegions をご参照してください。
InvokeId String Yes コマンド・プロセスの呼び出し ID。 DescribeInvocations を呼び出して最新の InvokeIdリストを取得することができます。
InstanceIds Array No コマンド呼び出しを停止するインスタンスのリスト。 パラメータ値は、[“InstanceId1”、 “InstanceId2”、…] の形式でフォーマットされたJSON配列である。 カンマ( )で区切って最大 100 のインスタンス ID を指定できます。

レスポンスパラメータ

すべてのパラメータは共通のレスポンスパラメータです。 詳細は、共通パラメータをご参照してください。

リクエストの例

  1. https://ecs.aliyuncs.com/?Action=StopInvocation
  2. &RegionId=cn-hangzhou
  3. &InvokeId=t-1fad2a8876de47068cc734d57703aa76
  4. &<Common Request Parameters>

成功のレスポンス例

XML format

  1. <StopInvocationResponse>
  2. <RequestId>540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx</RequestId>
  3. </StopInvocationResponse>

JSON format

  1. {
  2. "RequestId":"540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx",
  3. }

失敗のレスポンス例

XML format

  1. <Error>
  2. <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId>
  3. <HostId>ecs.aliyuncs.com</HostId>
  4. <Code>InvalidInstance.NoClient</Code>
  5. <Message>The specified instances have no cloud assistant client installed.</Message>
  6. </Error>

JSON format

  1. {
  2. "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
  3. "HostId": "ecs.aliyuncs.com"
  4. "Code": "InvalidInstance.NoClient"
  5. "Message": "The specified instances have no cloud assistant client installed."
  6. }

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。詳細については、API のエラー・センターを参照してください。

エラーコード エラーメッセージ HTTP status code Meaning
InvalidInvokeId.NotFound The specified InvokeId does not exist. 400 指定された InvokeIdは存在しません。
MissingParameter.InstanceId The input parameter “InstanceIds” that is mandatory for processing this request is not supplied. 400 InstanceIdsの必須パラメータを指定する必要があります。
MissingParameter.RegionId The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 RegionIdの必須パラメータを指定する必要があります。 または、指定されたリージョンのリソースを使用することはできません。
MissingParameter.InvokeId The input parameter “InvokeId” that is mandatory for processing this request is not supplied. 400 必要なパラメータ InvokeIdを指定する必要があります。
InvalidRegionId.NotFound The RegionId provided does not exist in our items. 404 指定された RegionIdは存在しません。
InternalError.Dispatch An internal error occurred when dispath the request 500 内部エラー。 後でもう一度お試しください。