RestoreToNewInstance--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

RestoreToNewInstance

最近更新时间：2024.10.11 16:59:29首次发布时间：2023.11.15 22:39:52

调用 RestoreToNewInstance 接口恢复到新实例。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
SrcInstanceId	String	是	postgres-21a3333b****	备份文件所属原实例的 ID。
BackupId	String	否	20230801-170****	原实例的备份文件 ID，使用该备份文件中保存的数据创建新实例。可通过调用 DescribeBackups 查询指定实例的备份文件列表信息。说明应至少传入 BackupId 与 RestoreTime 中的一个。如果同时传入 BackupId 和 RestoreTime，会以 BackupId 为准。
RestoreTime	String	否	2022-01-01T10:10:10Z	原实例日志备份保留时间内的任意时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。可通过调用 DescribeRecoverableTime 查询指定实例可恢复的时间范围。说明该参数与 BackupId 参数二者必须选择其一。
NodeInfo	Object[]	是	请参见请求示例。	实例规格配置。Primary 节点有且只有 1 个，Secondary 节点有且只有 1 个，Read-Only 节点可选 0~10 个。
StorageType	String	是	LocalSSD	实例存储类型。取固定值 `LocalSSD`（本地 SSD 盘）。
StorageSpace	Integer	否	100	实例存储空间。取值范围：[20, 3000]，单位：GB，步长 10GB。默认值为原实例空间大小。
VpcId	String	是	vpc-2gdgzrrl5icjk50ztyz6b****	使用此参数指定实例使用的私有网络。说明如您使用 ECS 来连接 PostgreSQL 实例，则需使用和 ECS 实例相同的私有网络，否则 ECS 实例将无法通过私网连接到 PostgreSQL 实例。可调用 DescribeVpcs 接口查询可用的私有网络。可调用 CreateVpc 接口创建新的私有网络。
SubnetId	String	是	subnet-30uhx4w39n75s7r2qr0lq****	子网 ID。说明仅支持选择实例所在可用区的子网。可以调用 DescribeSubnets 接口查询指定私有网络和可用区内的所有子网信息。可以调用 CreateSubnet 接口创建新的子网。
InstanceName	String	否	Name123	实例名称。规则：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128之间。
ProjectName	String	否	Test	所属项目。当该参数留空时，新建的实例默认加入 default 项目。
Tags	Object[]	否	请参见请求示例。	标签数组对象。说明支持一次传入多组标签键值对象。单次最多同时传入 20 组标签键值对，单个实例最多绑定 50 个标签。
ChargeInfo	Object	是	{ "ChargeType": "PostPaid" }	付费方式。

返回参数

参数	类型	示例值	描述
InstanceId	String	postgres-21a3333b****	实例 ID。
OrderId	String	Order71220115095297****	订单 ID。

示例

请求示例

POST /?Action=RestoreToNewInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "SrcInstanceId": "postgres-ca7b7019****",
    "NodeInfo": [
        {
            "ZoneId": "cn-beijing-a",
            "NodeSpec": "rds.postgres.1c2g",
            "NodeType": "Primary",
            "NodeOperateType": "Create"
        },
        {
            "ZoneId": "cn-beijing-a",
            "NodeSpec": "rds.postgres.1c2g",
            "NodeType": "Secondary",
            "NodeOperateType": "Create"
        }
    ],
    "BackupId": "20230801-170****",
    "StorageType": "LocalSSD",
    "StorageSpace": 20,
    "VpcId": "vpc-2gdgzrrl5icjk50ztyz6b****",
    "SubnetId": "subnet-30uhx4w39n75s7r2qr0lq****",
    "InstanceName": "测试实例",
    "ChargeInfo": {
        "ChargeType": "PostPaid",
        "Number": 1
    },
    "ProjectName": "default",
    "Tags": [
        {
            "Key": "Key",
            "Value": "Value"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230801173634010212035227001977AC",
        "Action": "RestoreToNewInstance",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "postgres-21a3333b****",
        "OrderId": "Order71220115095297****"
    }
}