All Products
Search

This Product

    Tair (Redis® OSS-Compatible):TransformToEcs

    Document Center

    Tair (Redis® OSS-Compatible):TransformToEcs

    Last Updated:Jan 28, 2026

    Converts an instance use local disks to a cloud-native instance.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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
    kvstore:TransformToEcsupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceClassstringYes

    The instance specification of the cloud-native instance. For more information, see Overview .

    		tair.rdb.1g
    ChargeTypestringNo

    The new billing method. Valid values:

    • PostPaid: pay-as-you-go
    • PrePaid: subscription. If you set this parameter to PrePaid, you must also specify the Period parameter.
    		PostPaid
    PeriodlongNo

    The subscription duration of the instance. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.

    Note This parameter is available and required only if the ChargeType parameter is set to PrePaid.
    		1
    ShardCountlongNo

    The number of data shards in the cloud-native cluster instance.

    		2
    InstanceIdstringYes

    The ID of the instance that you want to convert.

    		r-bp1zxszhcgatnx****
    EngineVersionstringYes

    The database engine version of the instance. Valid values: 5.0, 6.0, and 7.0.

    		5.0
    EffectiveTimestringNo

    The time when a database switchover is performed after data is migrated. Valid values:

    • Immediately: A database switchover is performed immediately after data is migrated.
    • MaintainTime: A database switchover is performed during the maintenance window.
    Note Default value: Immediately.
    		Immediately
    AutoRenewstringNo

    Specifies whether to enable the auto-renewal feature. Valid values:

    • true: enables auto-renewal.
    • false: does not enable auto-renewal.
    		false
    AutoRenewPeriodlongNo

    The subscription duration that is supported by auto-renewal. Unit: month. Valid values: 1, 2, 3, 6, and 12.

    Note This parameter is required if the AutoRenew parameter is set to true.
    		1
    DryRunbooleanNo

    Specifies whether to perform a precheck before the system creates the instance. Valid values:

    • true: The system performs a dry run and does not create the cloud-native instance. The system prechecks the request parameters, request format, service limits, and available resources. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
    • false: performs a dry run and sends the request. If the request passes the dry run, the instance is created.
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    Id of the request

    		DAABAD9B-890F-56C0-806C-6144946594AB
    OrderIdstring

    The order ID.

    		20905403119****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history