UpdateServiceInstanceSpec - Compute Nest - Alibaba Cloud Documentation Center

You can call the UpdateServiceInstanceSpec operation to upgrade or downgrade a service instance if its parameters or package settings do not meet your requirements.

Operation description

Prerequisites

Ensure that the service provider has enabled the upgrade/downgrade feature and configured the related parameters when the service was created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

computenest:UpdateServiceInstanceSpec

update

*ServiceInstance

acs:computenest:*:{#accountId}:serviceinstance/{#serviceinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceInstanceId	string	Yes	The ID of the service instance. Call the ListServiceInstances operation to obtain the service instance ID.	si-d6ab3a63ccbb4b17****
PredefinedParametersName	string	No	The name of the service instance package. Set this parameter if the service provider set Change Type to Package Change for the upgrade/downgrade operation. To obtain the package name, check the PredefinedParameters property of the DeployMetadata parameter that is returned by the GetService operation.	package One
Parameters	object	No	The parameters for changing the service instance. Set this parameter if the service provider set Change Type to Parameter Change for the upgrade/downgrade operation. Note To obtain the change parameters, check the ModifyParametersConfig property of the OperationMetadata parameter that is returned by the GetService operation. View the change parameters on the Service Instance Change page in the Compute Nest console. For example, if the service is configured to upgrade the ECS instance type, enter an instance specification that is higher than the current one.	{ "InstanceType": "ecs.g8ise.2xlarge" }
DryRun	boolean	No	Specifies whether to perform a dry run for the request. A dry run checks for issues such as permissions and instance status. Valid values: true: Sends the request to perform a dry run. The service instance is not modified. false: Sends the request to perform the operation. The service instance is modified after the request passes the checks.	true
EnableUserPrometheus	boolean	No	Specifies whether to enable Prometheus monitoring. Valid values: true: Enables Prometheus monitoring. false: Disables Prometheus monitoring.	true
OperationName	string	No	The name of the upgrade/downgrade operation. To obtain the name and content of the upgrade/downgrade operation, check the ModifyParametersConfig property of the OperationMetadata parameter that is returned by the GetService operation.	package modify
ClientToken	string	No	A client token to ensure the idempotence of the request. This token is generated by your client and must be unique for each request. The token can contain only ASCII characters and cannot exceed 64 characters in length.	123e4567-e89b-12d3-a456-42665544****
Commodity	object	No	The information about the Alibaba Cloud Marketplace purchase order. This parameter is not required if the service is not listed on Alibaba Cloud Marketplace or if the service uses the pay-as-you-go billing method.
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true (default): Automatic payment is enabled. Make sure that your account has a sufficient balance. false: An order is generated but the payment is not completed. If your account balance is insufficient, set AutoPay to false to generate an unpaid order. You can then log on to the ApsaraDB RDS console to pay for the order.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	06BF8F22-02DC-4750-83DF-3FFC11C065EA
OrderId	string	The order ID.	23396265896****

Examples

Success response

JSON format

{
  "RequestId": "06BF8F22-02DC-4750-83DF-3FFC11C065EA",
  "OrderId": "23396265896****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.