Restarts an application.
Debugging
Request headers
This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request and response headers.
Request syntax
PUT /pop/v1/sam/app/restartApplication HTTP/1.1
Request parameters
Parameter |
Type |
Position |
Required |
Example |
Description |
AppId | String | Query | Yes | 0099b7be-5f5b-4512-a7fc-56049ef1**** | The application ID. |
MinReadyInstances | Integer | Query | No | 1 | The minimum number of available instances. Valid values:
Note To ensure business continuity, make sure that at least one instance is available during application deployment and rollback. |
MinReadyInstanceRatio | Integer | Query | No | -1 | The ratio of the minimum number of available instances to the current number of instances. Valid values:
Note If the MinReadyInstance and MinReadyInstanceRatio parameters are configured and the MinReadyInstanceRatio parameter is set to a number from 0 to 100, the value of the MinReadyInstanceRatio parameter takes precedence. For example, if the MinReadyInstances parameter is set to 5, and the MinReadyInstanceRatio parameter 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%. |
AutoEnableApplicationScalingRule | Boolean | Query | No | false | Specifies whether to automatically enable an auto scaling policy for the application. Valid values:
|
Response parameters
Parameter |
Type |
Example |
Description |
RequestId | String | 91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** | The request ID. |
Message | String | success | The returned message. Valid values:
|
TraceId | String | 0a98a02315955564772843261e**** | The trace ID that is used to query the details of the request. |
Data | Object | The returned result. |
|
ChangeOrderId | String | 4a815998-b468-4bea-b7d8-59f52a44**** | The ID of the change order. |
ErrorCode | String | Null | The error code. Valid values:
|
Code | String | 200 | The HTTP status code. Valid values:
|
Success | Boolean | true | Indicates whether the application instances were restarted. Valid values:
|
Examples
Sample requests
PUT /pop/v1/sam/app/restartApplication?AppId=0099b7be-5f5b-4512-a7fc-56049ef1****&MinReadyInstances=1&MinReadyInstanceRatio=-1&AutoEnableApplicationScalingRule=false HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<RestartApplicationResponse>
<RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
<Message>success</Message>
<TraceId>0a98a02315955564772843261e****</TraceId>
<Data>
<ChangeOrderId>4a815998-b468-4bea-b7d8-59f52a44****</ChangeOrderId>
</Data>
<Code>200</Code>
<Success>true</Success>
</RestartApplicationResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
"Message" : "success",
"TraceId" : "0a98a02315955564772843261e****",
"Data" : {
"ChangeOrderId" : "4a815998-b468-4bea-b7d8-59f52a44****"
},
"Code" : "200",
"Success" : true
}
Error codes
HttpCode |
Error code |
Error message |
Description |
400 | InvalidApplication.NotFound | The current application does not exist. | The specified application is not found. |
400 | InvalidParameter.NotEmpty | You must specify the parameter %s. | The value of the %s parameter is invalid. This parameter cannot be left empty. |
400 | InvalidParameter.Obviously | The specified parameter is invalid {%s}. | The value of the {%s} parameter is invalid. |
400 | InvalidParameter.WithMessage | The parameter is invalid {%s}: %s | The value %s of the {%s} parameter is invalid. |
400 | user.indebt | The user has an outstanding payment. | The current user has overdue payments. |
400 | NoComputeResourceQuota.App.Exceed | You can create %s instances for each application. Please submit a ticket to raise the quota. | A maximum of %s instances can be created for each application. 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. | A maximum of %s instances can be created within your account. Join the DingTalk group 32874633 for technical support. |
400 | System.Upgrading | The system is being upgraded. Please try again later. | The system is being upgraded. Try again later. |
400 | Application.ChangerOrderRunning | An application change process is in progress. Please try again later. | An application change is in progress. Try again later. |
400 | Application.InvalidStatus | The application status is abnormal. Please try again later. | The application is in an abnormal state. Try again later. |
400 | Application.NotDeployYet | The application has not been deployed. Please deploy it and try again. | The application is not deployed. Deploy the application and try again. |
404 | Associate.Eip.Not.Enough | No sufficient EIPs are available. | No EIP is available to be associated with the application. Purchase EIPs. |
For a list of error codes, see Service error codes.