Call the UpgradeServiceInstance API to upgrade a service instance - Compute Nest

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

computenestsupplier:UpgradeServiceInstance

update

*ServiceInstance

acs:computenestsupplier:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
ServiceInstanceId	string	No	The service instance ID.	si-5cbae874da0e47xxxxxx
ServiceVersion	string	No	The service version.	2
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The ClientToken value can contain only ASCII characters and must be no more than 64 characters in length.	10CM943JP0EN9D51H
DryRun	string	No	Specifies whether to perform a dry run. A dry run checks for issues such as permission errors and instance status. Valid values: true: Sends a dry run request to check whether the request is valid. The service instance is not upgraded. false: Sends a regular request. The service instance is upgraded after the request passes the check.	false
Parameters	object	No	The configuration parameters of the service instance.	{ "param": "value" }

Response elements

Element	Type	Description	Example
	object
Status	string	The deployment status of the service instance. Valid values: Created: The service instance is created. Deploying: The service instance is being deployed. DeployedFailed: The service instance failed to be deployed. Deployed: The service instance is deployed. Upgrading: The service instance is being upgraded. Deleting: The service instance is being deleted. Deleted: The service instance is deleted. DeletedFailed: The service instance failed to be deleted.	Created
RequestId	string	The request ID.	F224E002-AB0E-5FD9-A87E-54AEE56F6CAE
ServiceInstanceId	string	The service instance ID.	si-5cbae874da0e47xxxxxx
UpgradeRequiredParameters	array	The parameters that are required for the upgrade.
	string	The parameters that are required for the upgrade.	['EcsInstanceType', 'InstancePassword']

Examples

Success response

JSON format

{
  "Status": "Created",
  "RequestId": "F224E002-AB0E-5FD9-A87E-54AEE56F6CAE",
  "ServiceInstanceId": "si-5cbae874da0e47xxxxxx",
  "UpgradeRequiredParameters": [
    "['EcsInstanceType', 'InstancePassword']"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.