RestartApplication - - Alibaba Cloud Documentation Center

Restarts an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:RestartApplication	none	All Resources *	none	none

Request syntax

PUT /pop/v1/sam/app/restartApplication

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	0099b7be-5f5b-4512-a7fc-56049ef1****
MinReadyInstances	integer	No	The minimum number of available instances. Special values: If you set the value to 0, business interruptions occur when the application is updated. If you set the value to -1, the minimum number of available instances is automatically set to a system-recommended value. The value is the nearest integer to which the calculated result of the following formula is rounded up: Current number of instances × 25%. For example, if five instances are available, the minimum number of available instances is calculated by using the following formula: 5 × 25% = 1.25. In this case, the minimum number of available instances is 2. Note Make sure that at least one instance is available during application deployment and rollback to prevent business interruptions.	1
MinReadyInstanceRatio	integer	No	The percentage of the minimum number of available instances. Take note of the following rules: If you set the value to -1, the minimum number of available instances is not determined based on this parameter. Default value: -1. If you set the value to a number from 0 to 100, the minimum number of available instances is calculated by using the following formula: Current number of instances × (Value of MinReadyInstanceRatio × 100%). The value is the nearest integer rounded up from the calculated result. For example, if the percentage is set to 50% and five instances are available, the minimum number of available instances is 3. Note When MinReadyInstance and MinReadyInstanceRatio are specified and MinReadyInstanceRatio is set to a number from 0 to 100, the value of MinReadyInstanceRatio takes precedence.** For example, if MinReadyInstances is set to 5, and MinReadyInstanceRatio is set to 50, the minimum number of available instances is set to the nearest integer rounded up from the calculated result of the following formula: Current number of instances × 50%**.	-1

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The additional information that is returned. Take note of the following rules: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.	success
TraceId	string	The trace ID that is used to query the details of the request.	0a98a02315955564772843261e****
Data	object	The response.
ChangeOrderId	string	The ID of the change process.	4a815998-b468-4bea-b7d8-59f52a44****
ErrorCode	string	The error code returned if the request failed. Take note of the following rules: The ErrorCode parameter is not returned if the request succeeds. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.	Null
Code	string	The HTTP status code. Take note of the following rules: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the instance is successfully restarted. Take note of the following rules: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ChangeOrderId": "4a815998-b468-4bea-b7d8-59f52a44****"
  },
  "ErrorCode": "Null\n",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
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.	You can create %s instances for each application. please join the DingTalk group 32874633 for technical support.
400	NoComputeResourceQuota.User.Exceed	Your account is limited to create %s instances. Please submit a ticket to raise the quota.	Your account is limited to create %s instances. please join the DingTalk group 32874633 for technical support.
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.	An application change process is in progress. Please try again later.
400	Application.InvalidStatus	The application status is abnormal. Please try again later.	The application status is abnormal. Please try again later.
400	Application.NotDeployYet	The application has not been deployed. Please deploy it and try again.	The application has not been deployed. Please deploy it and try again.
404	Associate.Eip.Not.Enough	No sufficient EIPs are available.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-03-30	The Error code has changed. The request parameters of the API has changed	View Change Details