克隆实例

最近更新时间: 2026-09-17 00:04:16

1. 接口描述

接口请求域名： cvm.api3.fincloud.tencent.cn。

本接口 (CloneInstance) 用于克隆指定配置的实例。

  • 实例创建成功后将自动开机启动，实例状态变为“运行中”。
  • 预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。
  • 本接口为异步接口，当创建请求下发成功后会返回一个实例ID列表，此时实例的创建并立即未完成。在此期间实例的状态将会处于“准备中”，可以通过调用 DescribeInstancesStatus 接口查询对应实例的状态，来判断生产有没有最终成功。如果实例的状态由“准备中”变为“运行中”，则为创建成功。

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

接口更新时间：2025-08-05 00:55:05。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：CloneInstance
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceChargeType 否 否 String 实例计费类型。PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：按小时后付费CDHPAID：独享母机付费（基于专用宿主机创建，宿主机部分的资源不收费），该付费模式下必须填写placement.hostid参数默认值：POSTPAID_BY_HOUR。
示例值： PREPAID
InstanceChargePrepaid 否 否 InstanceChargePrepaid 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
示例值：查看
Placement 是 否 Placement 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，专用宿主机（对于独享母机付费模式的子机创建）等属性。
示例值：查看
InstanceType 否 否 String 实例机型。不同实例机型指定了不同的资源规格。

  • 对于付费模式为PREPAID或POSTPAID_BY_HOUR的子机创建，具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例类型描述。若不指定该参数，则默认机型为S1.SMALL1。
  • 对于付费模式为CDHPAID的子机创建，该参数以"CDH_"为前缀，根据cpu和内存配置生成，具体形式为：CDH_XCXG，例如对于创建cpu为1核，内存为1G大小的专用宿主机的子机，该参数应该为CDH_1C1G。
    示例值： S2.SMALL1
    		•
    ImageId 是 否 String 指定有效的镜像ID，格式形如img-xxx。镜像类型分为四种：：1.公共镜像2.自定义镜像3.共享镜像4.服务市场镜像；公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询；服务镜像市场的镜像ID可通过云市场查询。通过调用接口 DescribeImages ，传入InstanceType获取当前机型支持的镜像列表，取返回信息中的ImageId字段。
    示例值： img-c1otssej
    PurchaseSource 否 否 String 购买源
    示例值： MC
    SystemDisk 否 否 SystemDisk 实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    示例值：查看
    DataDisks 否 否 Array of DataDisk 实例数据盘配置信息。若不指定该参数，则默认不购买数据盘，支持购买时指定多个数据盘。
    示例值：查看
    VirtualPrivateCloud 否 否 VirtualPrivateCloud 私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若不指定该参数，默认使用vpc网络。若在此参数中指定了私有网络ip，那么InstanceCount参数可以填1或2。
    示例值：查看
    InternetAccessible 否 否 InternetAccessible 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    示例值：查看
    InstanceCount 否 否 Int64 购买实例数量。取值范围：[1，100]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量。
    示例值： 12
    InstanceName 否 否 String 实例显示名称。如果不指定则默认显示. 最多只支持60个字符，点后面的名字都会过滤掉。
    示例值： alice-1
    LoginSettings 否 否 LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。
    示例值：查看
    SecurityGroupIds 否 否 Array of String 实例所属安全组。若不指定该参数，则绑定默认安全组。
    示例值： ["sec-61dyt49h"]
    EnhancedService 否 否 EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，默认关闭云监控和云安全服务。
    示例值：查看
    ClientToken 否 否 String 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。
    示例值： 12dasfa423fdasq5twerra
    SpotPrice 否 否 String 用于指定价格生产，当前主要用于竞价实例
    示例值： 2050
    HostName 否 否 String 云服务器的主机名点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。
    示例值： alice-host
    UserData 否 否 String 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。
    示例值： IyEvYmluL2Jhc2gKZWNobyAiSGVsbG8gVGVuY2VudCBDbG91ZC4iCg==
    DisasterRecoverGroupIds 否 否 Array of String 置放群组id，仅支持指定一个。
    示例值： ["ps-l86ok62z"]
    TagSpecification 否 否 Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例，当前仅支持绑定标签到云服务器实例。
    示例值：查看
    ProjectSpecification 否 否 ProjectSpecification 指定的项目id，仅能指定一个
    示例值：查看
    InstanceId 是 否 String 需要克隆实例的ID
    示例值： ins-61dyt49h
    DataDiskIds 是 否 Array of String 实例需要克隆的数据盘Id
    示例值： ["disk-61dyt49h"]
    DisableApiTermination 否 否 Bool 禁用Api终止
    示例值： false

    3. 输出参数

    参数名称 类型 描述
    InstanceIdSet Array of String 当通过本接口来创建实例时会返回该参数，表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功，可根据 DescribeInstancesStatus 接口查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成；如果实例状态由“准备中”变为“正在运行”，则为创建成功。
    示例值： ["ins-61dyt49h"]
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InvalidPermission 账户不支持该操作。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidPeriod 无效时长。目前只支持时长：[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]，单位：月。
    VpcIpIsUsed 私有网络ip已经被使用。
    VpcAddrNotInSubNet 私有网络ip不在子网内。
    InvalidClientToken.TooLong 指定的ClientToken字符串长度超出限制，必须小于等于64字节。
    InvalidHostId.NotFound 指定的HostId不存在，或不属于该请求账号所有。
    MissingParameter 参数缺失。请求没有带必选参数。
    InstancesQuotaLimitExceeded 表示当前创建的实例个数超过了该账户允许购买的剩余配额数。
    InvalidParameterCombination 表示参数组合不正确。
    InvalidParameter.InvalidIpFormat 指定的私有网络ip格式不正确。
    InvalidZone.MismatchRegion 指定的zone不存在。
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    InvalidPassword 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
    InvalidInstanceName.TooLong 指定的InstanceName字符串长度超出限制，必须小于等于60字节。
    InvalidCloudDisk.SoldOut 云磁盘售罄。
    TradeUnknownError 请求计费错误
    UnauthorizedOperation.ProjectNotFound 此操作未被允许，请确保该账户在所选项目中。

    5. 示例

    示例1 克隆实例

    本接口 (CloneInstance) 用于克隆指定配置的实例。

    • 实例创建成功后将自动开机启动，实例状态变为“运行中”。
    • 预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。
    • 本接口为异步接口，当创建请求下发成功后会返回一个实例ID列表，此时实例的创建并立即未完成。在此期间实例的状态将会处于“准备中”，可以通过调用 DescribeInstancesStatus 接口查询对应实例的状态，来判断生产有没有最终成功。如果实例的状态由“准备中”变为“运行中”，则为创建成功。

    输入示例

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

{
  "Placement": {
         "Zone": "ap-region1-2"
   },
   "ImageId": "img-6mre94jv",
   "InstanceId": "ins-61dyt49h",
   "DataDiskIds": [
          "disk-61dyt49h"
    ]
}

    输出示例

    {
    "Response": {
        "InstanceIdSet": [
            "ins-1vogaxgk"
        ],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}