云数据库 MySQL
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>云数据库 MySQL>API 文档>回档相关接口>创建克隆实例

创建克隆实例

最近更新时间：2024-08-02 01:11:52

我的收藏

本页目录：

1. 接口描述

接口请求域名： cdb.tencentcloudapi.com 。

本接口(CreateCloneInstance) 用于从目标源实例创建一个克隆实例，可以指定克隆实例回档到源实例的指定物理备份文件或者指定的回档时间点。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateCloneInstance。
Version 是 String 公共参数，本接口取值：2017-03-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 克隆源实例Id。
示例值：cdb-***
SpecifiedRollbackTime 否 String 如果需要克隆实例回档到指定时间，则指定该值。时间格式为：yyyy-mm-dd hh:mm:ss。
说明：此参数和 SpecifiedBackupId 参数需要2选1进行设置。
示例值：2020-01-28 20:47:26
SpecifiedBackupId 否 Integer 如果需要克隆实例回档到指定备份集，则指定该值为备份文件的 Id。请使用 查询数据备份文件列表。
说明：如果是克隆双节点、三节点实例，备份文件为物理备份，如果是克隆单节点、集群版实例，备份文件为快照备份。
示例值：118127
UniqVpcId 否 String 私有网络 ID，如果不传则默认选择基础网络，请使用 查询私有网络列表 。
示例值：vpc-***
UniqSubnetId 否 String 私有网络下的子网 ID，如果设置了 UniqVpcId，则 UniqSubnetId 必填，请使用 查询子网列表。
示例值：subnet-***
Memory 否 Integer 实例内存大小，单位：MB，需要不低于克隆源实例，默认和源实例相同。
示例值：1000
Volume 否 Integer 实例硬盘大小，单位：GB，需要不低于克隆源实例，默认和源实例相同。
示例值：50
InstanceName 否 String 新产生的克隆实例名称。
示例值：***
SecurityGroup.N 否 Array of String 安全组参数，可使用 查询项目安全组信息 接口查询某个项目的安全组详情。
示例值：[]
ResourceTags.N 否 Array of TagInfo 实例标签信息。
示例值：[]
Cpu 否 Integer 实例Cpu核数，需要不低于克隆源实例，默认和源实例相同。
示例值：1
ProtectMode 否 Integer 数据复制方式，默认为 0，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。
示例值：0
DeployMode 否 Integer 多可用区域，默认为 0，支持值包括：0 - 表示单可用区，1 - 表示多可用区。
示例值：0
SlaveZone 否 String 新产生的克隆实例备库 1 的可用区信息，默认同源实例 Zone 的值。
示例值：‘’
BackupZone 否 String 备库 2 的可用区信息，默认为空，克隆强同步主实例时可指定该参数。
示例值：‘’
DeviceType 否 String 克隆实例类型。支持值包括："UNIVERSAL" - 通用型实例，"EXCLUSIVE" - 独享型实例，"CLOUD_NATIVE_CLUSTER" - 集群版标准型，"CLOUD_NATIVE_CLUSTER_EXCLUSIVE" - 集群版加强型。不指定则默认为通用型。
示例值：UNIVERSAL
InstanceNodes 否 Integer 新克隆实例节点数。如果需要克隆出三节点实例， 请将该值设置为3 或指定 BackupZone 参数。如果需要克隆出两节点实例，请将该值设置为2。默认克隆出两节点实例。
示例值：2
DeployGroupId 否 String 置放群组 ID。
示例值：ps-7t11vrwf
DryRun 否 Boolean 是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制等。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId.默认为false：发送正常请求，通过检查后直接创建实例。
示例值：true
CageId 否 String 金融围拢 ID 。
示例值：cage-test
ProjectId 否 Integer 项目ID，默认项目ID0
示例值：0
PayType 否 String 付费类型，PRE_PAID：包年包月，USED_PAID：按量计费。默认为按量计费
Period 否 Integer 实例时长，PayType为PRE_PAID时必传，单位：月，可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
ClusterTopology 否 ClusterTopology 集群版节点拓扑配置。

3. 输出参数

参数名称 类型 描述
AsyncRequestId String 异步任务的请求ID，可使用此 ID 查询异步任务的执行结果。
示例值：256117ed-efa08b54-61784d44-91781bbd
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 克隆实例并回档到指定时间

克隆实例并回档到指定时间

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloneInstance
<公共请求参数>

{
    "UniqVpcId": "vpc-594gwq4l",
    "InstanceId": "cdb-9303wd4x",
    "Volume": "50",
    "UniqSubnetId": "subnet-dz5pj862",
    "SpecifiedRollbackTime": "2020-08-0116:27:43",
    "Memory": "1000"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
CdbError 后端错误或者流程错误。
CdbError.DatabaseError 后端数据库错误。
FailedOperation.StatusConflict 任务状态冲突。
InternalError.CdbError 系统错误。
InternalError.DfwError 安全组操作错误。
InternalError.TradeError 交易系统错误。
InternalError.UndefinedError 未知错误。
InternalError.VpcError 私有网络或子网错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied 操作被拒绝。
OperationDenied.OtherOderInProcess 当前有其他订单正在处于下单过程中，请稍后重试。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。
中国站
文档反馈
文档活动
message-icon联系我们
目录