RestartInstances API で SAE アプリケーションインスタンスをプログラムで再起動 - SAE - Alibaba Cloud - Serverless App Engine

アプリケーション内の 1 つ以上のインスタンスを再起動します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:RestartInstances

none

*All Resource

*

なし

リクエスト構文

PUT /pop/v1/sam/app/restartInstances HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。	1daa7236-3844-4f36-b39a-605b0cc0****
InstanceIds	string	必須	再起動するインスタンスの ID。複数のインスタンス ID はカンマ (,) で区切ります。	mysae-1daa7236-3844-4f36-b39a-605b0cc0caa6-*****

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	返される追加情報。次のルールに注意してください： success：呼び出しが成功した場合、success が返されます。エラーコード：呼び出しが失敗した場合、エラーコードが返されます。	success
TraceId	string	リクエストの詳細を照会するために使用されるトレース ID。	0a98a02315955564772843261e****
Data	object	アプリケーションの詳細。
ChangeOrderId	string	変更オーダーの ID。	5afa5b98-0c64-4637-983f-15eaa888****
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。次のルールに注意してください：リクエストが成功した場合、ErrorCode パラメーターは返されません。呼び出しが失敗した場合、ErrorCode パラメーターが返されます。詳細については、このトピックのエラーコードのセクションをご参照ください。
Code	string	HTTP ステータスコード。次のルールに注意してください： 2xx：呼び出しは成功しました。 3xx：呼び出しはリダイレクトされました。 4xx：呼び出しは失敗しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	インスタンスが正常に再起動されたかどうかを示します。次のルールに注意してください： true false	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ChangeOrderId": "5afa5b98-0c64-4637-983f-15eaa888****"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	NoComputeResourceQuota.Exceed	Your compute resource is insufficient. Please contact us to raise the quota.
400	user.indebt	The user has an outstanding payment.
400	NoComputeResourceQuota.App.Exceed	You can create %s instances for each application. Please submit a ticket to raise the quota.
400	NoComputeResourceQuota.User.Exceed	Your account is limited to create %s instances. Please submit a ticket to raise the quota.
400	System.Upgrading	The system is being upgraded. Please try again later.
400	Application.ChangerOrderRunning	An application change process is in progress. Please try again later.	日文说明1
400	Application.InvalidStatus	The application status is abnormal. Please try again later.	日文说明1
400	Application.NotDeployYet	The application has not been deployed. Please deploy it and try again.	日文说明1

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

変更履歴

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