API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 云数据库 PostgreSQL > 备份与恢复相关接口 > 克隆实例

克隆实例

最近更新时间：2024-03-12 01:44:15

我的收藏

本页目录：

1. 接口描述

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

用于克隆实例，支持指定备份集、指定时间点进行克隆。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CloneDBInstance。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
DBInstanceId 是 String 克隆的源实例ID。
示例值：postgres-abcd1234
SpecCode 是 String 售卖规格码。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。
Storage 是 Integer 实例容量大小，单位：GB。
示例值：10
Period 是 Integer 购买时长，单位：月。
  • 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
  • 后付费：只支持1
    示例值：1
    		•
    AutoRenewFlag 是 Integer 续费标记：
  • 0：手动续费
  • 1：自动续费
    默认值：0
    示例值：1
    		•
    VpcId 是 String 私有网络ID，形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询；也可以调用接口 DescribeVpcEx ，从接口返回中的unVpcId字段获取。
    SubnetId 是 String 私有网络子网ID，形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的unSubnetId字段获取。
    Name 否 String 新购的实例名称，仅支持长度小于60的中文/英文/数字/"_"/"-"，不指定实例名称则默认显示"未命名"。
    示例值：ins-name-clone-1
    InstanceChargeType 否 String 实例计费类型，目前支持：
  • PREPAID：预付费，即包年包月
  • POSTPAID_BY_HOUR：后付费，即按量计费
    默认值：PREPAID
    示例值：PREPAID
    		•
    SecurityGroupIds.N 否 Array of String 实例所属安全组，该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。
    ProjectId 否 Integer 项目ID。
    TagList.N 否 Array of Tag 实例需要绑定的Tag信息，默认为空；可以通过调用 DescribeTags 返回值中的 Tags 字段来获取。
    DBNodeSet.N 否 Array of DBNode 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。
    可用区信息可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
    AutoVoucher 否 Integer 是否自动使用代金券：
  • 0：否
  • 1：是
    默认值：0
    		•
    VoucherIds 否 String 代金券ID列表。
    ActivityId 否 Integer 活动ID。
    BackupSetId 否 String 基础备份集ID。
    RecoveryTargetTime 否 String 恢复时间点。
    SyncMode 否 String 主从同步方式，支持：
  • Semi-sync：半同步
  • Async：异步
    主实例默认值：Semi-sync
    只读实例默认值：Async
    示例值：Async
    		•

    3. 输出参数

    参数名称 类型 描述
    DealName String 订单号。
    注意：此字段可能返回 null，表示取不到有效值。
    BillId String 订单流水号。
    注意：此字段可能返回 null，表示取不到有效值。
    DBInstanceId String 克隆出的新实例ID，当前只支持后付费返回该值。
    注意：此字段可能返回 null，表示取不到有效值。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 克隆实例

    原实例误删数据时，可用克隆实例功能恢复。

    输入示例

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

{
    "VpcId": "vpc-2ot3acw1",
    "AutoRenewFlag": "1",
    "DBInstanceId": "postgres-abcd1234",
    "RecoveryTargetTime": "2021-12-25 01:27:35",
    "Storage": "10",
    "Period": "1",
    "AutoVoucher": "0",
    "InstanceChargeType": "prepaid",
    "SpecCode": "cdb.pg.z1.2g",
    "SubnetId": "subnet-ppv9iw34",
    "DBNodeSet": [
        {
            "Role": "Standby",
            "Zone": "ap-guangzhou-3"
        },
        {
            "Role": "Primary",
            "Zone": "ap-guangzhou-3"
        }
    ]
}

    输出示例

    {
    "Response": {
        "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
        "DealName": "20211225711000768276461",
        "BillId": "20211225711000768276471",
        "DBInstanceId": "postgres-xxxx"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    AuthFailure.UnauthorizedOperation 鉴权失败。
    FailedOperation.AllocateQuotasError 申请资源标签的配额失败。
    FailedOperation.CamAuthFailed CAM鉴权失败。
    FailedOperation.CamSigAndAuthError 鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    FailedOperation.CdbCgwConnectError 获取项目信息失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    FailedOperation.DatabaseAccessError 管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    FailedOperation.FailedOperationError 操作失败，请稍后重试。
    FailedOperation.GetSubnetError 获取VPC子网失败。
    FailedOperation.GetVpcInfoError 获取VPC信息失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    FailedOperation.QuerySpecError 查询规格信息失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    FailedOperation.QueryVpcFailed 查询VPC失败。
    FailedOperation.QueryVpcFalied 获取VPC详情失败。
    InternalError.InternalHttpServerError 请求执行异常。
    InvalidParameter.ParameterCheckError 参数检查失败。
    InvalidParameterValue.IllegalProjectId 非法ProjectId。
    InvalidParameterValue.IllegalRegion 非法的Region参数。
    InvalidParameterValue.IllegalZone 非法的Zone参数。
    InvalidParameterValue.InvalidParameterValueError 参数值有误。
    InvalidParameterValue.InvalidZoneIdError 无效的可用区。
    InvalidParameterValue.SpecNotRecognizedError 规格信息{{1}}无法被识别。
    OperationDenied.CamDeniedError 当前操作被限制。
    OperationDenied.InstanceStatusLimitError 实例当前状态限制本次操作。
    中国站