StopInstances - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

1 つ以上の ECS インスタンスを停止します。停止メソッド、停止モード、およびバッチ操作モードを指定できます。

操作説明

これは非同期操作です。呼び出しが成功すると、インスタンスは Stopping 状態になります。 DescribeInstanceStatus を呼び出してインスタンスステータスをクエリします。返されたステータスが Stopped の場合、インスタンスは停止しています。

事前準備

インスタンスが停止すると、使用できなくなります。インスタンスの停止がビジネスに影響しないことを確認してください。 StartInstance または StartInstances を呼び出してインスタンスを起動します。
セキュリティ上の理由でロック済みのインスタンスは、この操作を呼び出しても停止できません。詳細については、「リソースセキュリティロックが API 呼び出しに与える影響」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:StopInstances

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DryRun	boolean	任意	ドライランリクエストを送信するかどうかを指定します。有効な値: true: インスタンスを停止せずにドライランリクエストを送信します。システムは必須パラメーター、リクエストフォーマット、およびインスタンスステータスを確認します。確認に失敗した場合、対応するエラーが返されます。確認に成功した場合、`DRYRUN.SUCCESS` が返されます。説明 BatchOptimization パラメーターが `SuccessFirst` にセットされている場合、`DryRun=true` のドライラン結果は `DRYRUN.SUCCESS` のみを返します。 false: 通常のリクエストを送信します。リクエストが確認に合格すると、インスタンスが停止されます。デフォルト値: false。	false
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ForceStop	boolean	任意	インスタンスを強制的に停止するかどうかを指定します。有効な値: true: インスタンスを強制的に停止します。警告強制停止は仕事率オフに相当します。インスタンスのオペレーティングシステムでディスクに書き込まれていないデータが失われる可能性があります。警告: 慎重に操作してください。 false: インスタンスを通常停止します。デフォルト値: false。	false
StoppedMode	string	任意	停止モード。有効な値: StopCharging: 節約モード。節約モードが有効になると: コンピューティングリソース（vCPU、メモリ、GPU）、イメージライセンス料金、および静的パブリック IP アドレスの固定帯域幅の課金が停止されます。システムディスク、データディスク、および EIP の固定帯域幅の課金は継続されます。コンピューティングリソースが解放されるため、リソース不足によりインスタンスの起動に失敗する場合があります。後で再試行するか、インスタンスタイプを変更してください。停止前にインスタンスに EIP が関連付けられている場合、インスタンスの再起動後も IP アドレスは変更されません。それ以外の場合、静的パブリック IP アドレスが変更される可能性がありますが、非公開 IP アドレスは変更されません。詳細については、「節約モード」をご参照ください。重要インスタンスが節約モードをサポートしていない場合、API はエラーを返しません。インスタンスの停止が優先されます。節約モードをサポートしていないインスタンスタイプには、ローカル SSD を搭載したインスタンスやサブスクリプションインスタンスが含まれます。 KeepCharging: 標準停止モード。インスタンスが停止した後、リソースは保持され、課金は継続されます。インスタンスタイプの在庫とパブリック IP アドレスも保持されます。オペレーティングシステムの置き換え、ディスクの再初期化、インスタンスタイプの変更、または非公開 IP アドレスの変更のためにインスタンスを停止する場合は、起動失敗を回避するためにこのモードを選択してください。デフォルト値: VPC 接続インスタンスの節約モードを有効にし、条件が満たされている場合、デフォルト値は `StopCharging` です。それ以外の場合、デフォルト値は `KeepCharging` です。	KeepCharging
BatchOptimization	string	任意	バッチ操作モード。有効な値: AllTogether: バッチ操作全体が成功と見なされるには、すべての操作が成功する必要があります。いずれかの操作が失敗した場合、バッチ操作全体が失敗し、完了したすべての操作が以前の状態にロールバックされます。 SuccessFirst: バッチ内の各操作は独立して実行されます。操作が失敗しても、他の操作は引き続き実行され、成功として確認されます。成功した操作はコミットされ、失敗した操作は失敗としてマークされ、他の操作の結果には影響しません。デフォルト値: AllTogether。	AllTogether
InstanceId	array	必須	インスタンスの ID。配列の長さ: 1〜100。	i-bp67acfmxazb4p****
	string	任意	インスタンス ID	i-bp67acfmxazb4p****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID	1C488B66-B819-4D14-8711-C4EAAA13AC01
InstanceResponses	object
InstanceResponse	array<object>	各インスタンスの操作前後のステータスと操作結果を含む InstanceResponse オブジェクトの配列。
	object
Code	string	インスタンスに対する操作のエラーコード。値が 200 の場合は成功を示します。詳細については、次のセクションに記載されているエラーコードをご参照ください。	200
Message	string	インスタンスに対する操作で返されるエラーメッセージ。値が `success` の場合は成功を示します。詳細については、次のセクションに記載されているエラーコードとメッセージをご参照ください。	success
InstanceId	string	インスタンス ID。	i-bp67acfmxazb4p****
CurrentStatus	string	インスタンスの現在のステータス。	Stopping
PreviousStatus	string	インスタンスの以前のステータス。	Running

例

成功レスポンス

JSONJSON

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01",
  "InstanceResponses": {
    "InstanceResponse": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp67acfmxazb4p****",
        "CurrentStatus": "Stopping",
        "PreviousStatus": "Running"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be added ECS tag
400	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service account have no right to access your KMS.
400	DRYRUN.SUCCESS	This request is a dryrun request with successful result.
400	InvalidParameter.Encrypted.KmsNotEnable	Failed to perform this operation because KMS is not activated.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidInstanceId.NotFound	InstanceId should not be null.
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.
403	InstanceLockedForSecurity	%s
403	InstanceExpiredOrInArrears	%s
403	IncorrectInstanceStatus	%s
403	InvalidInstanceId.NotSupport	%s
403	InsufficientBalance	Your account does not have enough balance.
403	InstanceNotReady	The specified instance is not ready for use.
403	InvalidOperation.KMSKeyIdNotFound	The specified KMSKeyId not found, %s.
403	InvalidOperation.KMSServiceNotOpen	KMS service is currently not open.
403	OperationDenied.SystemInstanceNotSupport	The system instance does not support the %s operation because %s.
404	InvalidInstanceId.NotFound	%s
404	InvalidInstanceIds.NotFound	The specified InstanceIds does not exist.
503	LimitedOperation.ServiceUnavailable	The service is currently unavailable. Please try again later.
409	InvalidOperation.Conflict	Request was denied due to conflict with a previous request, please try again later.

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

変更履歴

完全なリストについては、「変更履歴」をご参照ください。