TransformToEcs-阿里云帮助中心

Converts an instance that uses local disk to a cloud-native instance.

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

kvstore:TransformToEcs

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceClass	string	Yes	The instance type of the target cloud-native instance. For more information, see Instance types. Note If you want to convert a cluster instance, you must specify the corresponding cloud-native cluster instance type that includes .with.proxy in its name and specify the ShardCount parameter. For a cluster instance, you must provide the corresponding cloud-native cluster specification that includes `.proxy`. You must also specify the number of shards by using the `ShardCount` parameter.	tair.rdb.1g tair.rdb.with.proxy.1g
ChargeType	string	No	The billing method of the target instance. Valid values: PostPaid: pay-as-you-go PrePaid: subscription. If you set this parameter to PrePaid, you must also specify the Period parameter.	PostPaid
Period	integer	No	The subscription duration. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. Note This parameter is available and required only if you set the ChargeType parameter to PrePaid.	1
ShardCount	integer	No	The number of data shards in the cloud-native cluster instance.	2
InstanceId	string	Yes	The ID of the classic instance that you want to convert.	r-bp1zxszhcgatnx****
EngineVersion	string	Yes	The Redis-compatible version of the instance. Valid values: 5.0, 6.0, and 7.0.	5.0
EffectiveTime	string	No	The time when to switch the database after data migration. Valid values: Immediately: The database is immediately switched after the migration is complete. MaintainTime: The database is switched within the maintenance window. Note Default value: Immediately.	Immediately
AutoRenew	string	No	Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal.	false
AutoRenewPeriod	integer	No	The auto-renewal cycle. Unit: month. Valid values: 1, 2, 3, 6, and 12. Note This parameter is required if you set AutoRenew to true.	1
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run to check the request. The check items include the required parameters, request format, service limits, and available resources. If the check fails, the corresponding error is returned. If the check passes, the `DryRunOperation` error code is returned. false (default): sends a normal request and creates an instance after the request passes the check.	true
IzNo	string	No	The ID of the availability zone.
VSwitchId	string	No	The ID of the vSwitch.
SecondaryIzNo	string	No	The ID of the secondary availability zone.
IsAcrossZone	boolean	No	Specifies whether to deploy the instance across availability zones. This feature is supported only for cluster instances.

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.	DAABAD9B-890F-56C0-806C-6144946594AB
OrderId	string	The ID of the order.	20905403119****

Examples

Success response

JSON format

{
  "RequestId": "DAABAD9B-890F-56C0-806C-6144946594AB",
  "OrderId": "20905403119****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.