tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for MySQL
    Documentation
    Download PDF

    CreateCloneInstance

    Last updated: 2024-01-30 10:25:42
    Download PDF

      1. API Description

      Domain name for API request: cdb.tencentcloudapi.com.

      This API is used to create a clone of a specific instance, and roll back the clone by using a physical backup file of the instance or roll back the clone to a point in time.

      A maximum of 20 requests can be initiated per second for this API.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common Params. The value used for this API: CreateCloneInstance.
      Version Yes String Common Params. The value used for this API: 2017-03-20.
      Region No String Common Params. This parameter is not required for this API.
      InstanceId Yes String ID of the instance to be cloned from
      SpecifiedRollbackTime No String To roll back the cloned instance to a specific point in time, set this parameter to a value in the format of "yyyy-mm-dd hh:mm:ss".
      SpecifiedBackupId No Integer To roll back the cloned instance to a specific physical backup file, set this parameter to the ID of the physical backup file. The ID can be obtained by the DescribeBackups API.
      UniqVpcId No String VPC ID, which can be obtained by the DescribeVpcs API. If this parameter is left empty, the classic network will be used by default.
      UniqSubnetId No String VPC subnet ID, which can be obtained by the DescribeSubnets API. If UniqVpcId is set, UniqSubnetId will be required.
      Memory No Integer Memory of the cloned instance in MB, which should be equal to (by default) or larger than that of the original instance
      Volume No Integer Disk capacity of the cloned instance in GB, which should be equal to (by default) or larger than that of the original instance
      InstanceName No String Name of the cloned instance
      SecurityGroup.N No Array of String Security group parameter, which can be obtained by the DescribeProjectSecurityGroups API
      ResourceTags.N No Array of TagInfo Information of the cloned instance tag
      Cpu No Integer The number of CPU cores of the cloned instance. It should be equal to (by default) or larger than that of the original instance.
      ProtectMode No Integer Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync). Default value: 0.
      DeployMode No Integer Multi-AZ or single-AZ. Valid values: 0 (single-AZ), 1 (multi-AZ). Default value: 0.
      SlaveZone No String Availability zone information of replica 1 of the cloned instance, which is the same as the value of Zone of the original instance by default
      BackupZone No String Availability zone information of replica 2 of the cloned instance,
      which is left empty by default. Specify this parameter when cloning a strong sync source instance.
      DeviceType No String Resource isolation type of the clone. Valid values: UNIVERSAL (general instance), EXCLUSIVE (dedicated instance). Default value: UNIVERSAL.
      InstanceNodes No Integer The number of nodes of the clone. If this parameter is set to 3 or the BackupZone parameter is specified, the clone will have three nodes. If this parameter is set to 2 or left empty, the clone will have two nodes.
      DeployGroupId No String Placement group ID.
      DryRun No Boolean Whether to check the request without creating any instance. Valid values: true, false (default). After being submitted, the request will be checked to see if it is in correct format and has all required parameters with valid values. An error code is returned if the check failed, and RequestId is returned if the check succeeded. After a successful check, no instance will be created if this parameter is set to true, whereas an instance will be created and if it is set to false.
      CageId No String Financial cage ID.
      ProjectId No Integer Project ID. Default value: 0.

      3. Output Parameters

      Parameter Name Type Description
      AsyncRequestId String LimitAsync task request ID, which can be used to query the execution result of an async task
      RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

      4. Example

      Example1 Cloning an instance and rolling back the clone to a specific point in time

      Input Example

      https://cdb.tencentcloudapi.com/?Action=CreateCloneInstance
&InstanceId=cdb-9303wd4x
&SpecifiedRollbackTime=2020-08-0116:27:43
&UniqVpcId=vpc-594gwq4l
&UniqSubnetId=subnet-dz5pj862
&Memory=1000
&Volume=50
&<Common request parameters>

      Output Example

      {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "AsyncRequestId": "256117ed-efa08b54-61784d44-91781bbd"
    }
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

      Error Code Description
      CdbError Backend or process error.
      CdbError.DatabaseError Backend database error.
      FailedOperation.StatusConflict Task status conflict.
      InternalError.CdbError System error.
      InternalError.DfwError Security group operation error.
      InternalError.TradeError Transaction system error.
      InternalError.UndefinedError Unknown error
      InternalError.VpcError VPC or subnet error.
      InvalidParameter Parameter error.
      InvalidParameter.InstanceNotFound The instance does not exist.
      OperationDenied Operation denied.
      OperationDenied.OtherOderInProcess There are other orders being submitted. Please try again later.
      OperationDenied.UserHasNoStrategy This account is not authorized to access the requested resource.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy