All Products
Search
Document Center

:RescaleApplication

Last Updated:Nov 01, 2024

Scales an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
sae:RescaleApplicationupdate
  • All Resources
    *
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

0099b7be-5f5b-4512-a7fc-56049ef1****
ReplicasintegerYes

The expected number of instances.

5
MinReadyInstancesintegerNo

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
MinReadyInstanceRatiointegerNo

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
AutoEnableApplicationScalingRulebooleanNo

Specifies whether to automatically enable an auto scaling policy for the application. Take note of the following rules:

  • true: turns on Logon-free Sharing
  • false: turns off Logon-free Sharing
true

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

Messagestring

The message returned for the operation.

success
RequestIdstring

The ID of the request.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Dataobject

The response.

ChangeOrderIdstring

The ID of the change order.

0e09829f-4914-4612-bc88-6f52fd81****
ErrorCodestring

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
Codestring

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
Successboolean

Indicates whether the application is successfully scaled. Take note of the following rules:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Data": {
    "ChangeOrderId": "0e09829f-4914-4612-bc88-6f52fd81****"
  },
  "ErrorCode": "Null\n",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidApplication.NotFoundThe current application does not exist.-
400InvalidParameter.NotEmptyYou must specify the parameter %s.-
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.-
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s-
400user.indebtThe user has an outstanding payment.-
400NoComputeResourceQuota.App.ExceedYou 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.
400NoComputeResourceQuota.ExceedYour compute resource is insufficient. Please contact us to raise the quota.-
400NoComputeResourceQuota.User.ExceedYour 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.
400System.UpgradingThe system is being upgraded. Please try again later.-
400Application.ChangerOrderRunningAn application change process is in progress. Please try again later.An application change process is in progress. Please try again later.
400Application.InvalidStatusThe application status is abnormal. Please try again later.The application status is abnormal. Please try again later.
400Application.NotDeployYetThe application has not been deployed. Please deploy it and try again.The application has not been deployed. Please deploy it and try again.
400MinReadyInstances.Not.Smaller.ReplicasThe minimum number of available instances must be less than the number of application instances.The minimum number of available instances must be less than the number of application instances.
400MinReadyInstanceRatio.InvalidThe ratio of minimum available instances must be between 0 and 100.-
404Associate.Eip.Not.EnoughNo sufficient EIPs are available.-

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

Change history

Change timeSummary of changesOperation
2021-11-17The Error code has changedView Change Details