UpgradeServiceInstance - Compute Nest - Alibaba Cloud Documentation Center

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:UpgradeServiceInstance

update

*ServiceInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
ServiceInstanceId	string	Yes	The service instance ID.	si-d6ab3a63ccbb4bxxxxxx
ServiceVersion	string	No	The service version to upgrade to.	2
Parameters	object	No	The parameters required for the upgrade. This is used when new parameters are added to the new service version.	{ \"RegionId\": \"cn-hangzhou\", \"InstanceType\": \"ecs.g5.large\"}
ClientToken	string	No	A client-generated token that ensures the idempotence of the request. The token must be unique for each request. It can contain only ASCII characters and must be no more than 64 characters long.	123e4567-e89b-12d3-a456-426655440000
DryRun	string	No	Specifies whether to perform a dry run. A dry run checks for issues such as permissions and the instance status. Valid values: true: Sends the request without upgrading the service instance. false: Sends the request and upgrades the service instance after the check is passed.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4DB0F536-B3BE-4F0D-BD29-E83FB56D550C
UpgradeRequiredParameters	array	The new parameters required for the service upgrade. This parameter is returned only when DryRun is set to true. Include these parameters in the request when you perform the upgrade.
	string	The name of a parameter required for the upgrade.	InstancePassword

Examples

Success response

JSON format

{
  "RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
  "UpgradeRequiredParameters": [
    "InstancePassword"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.