StopInstance API による DSW インスタンスの停止 - PAI

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paidsw:StopInstance

update

*All Resource

*

なし

リクエスト構文

PUT /api/v2/instances/{InstanceId}/stop HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。インスタンス ID の取得方法については、「ListInstances」をご参照ください。	dsw-730xxxxxxxxxx

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SaveImage	boolean	任意	インスタンス停止前に環境を保存するかどうかを指定します。 true: インスタンス停止前に環境が保存されます。 false: 環境データを保存せずにインスタンスが停止されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	リクエストが成功したかどうかを示します。有効な値は次のとおりです。 true false	true
Message	string	返されたメッセージ。	"XXX"
Code	string	状態コード。有効な値は次のとおりです。 InternalError: 内部エラーが発生しました。パラメーター検証エラー以外のエラーは内部エラーとして分類されます。 ValidationError: パラメーター検証エラーが発生しました。	null
HttpStatusCode	integer	HTTP ステータスコード。	null
InstanceId	string	インスタンス ID。	dsw-730xxxxxxxxxx

例

成功レスポンス

JSONJSON

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx"
}

エラーコード

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

変更履歴

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