RestoreDBInstance - 恢复实例-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

克隆PolarDB-X实例

接口说明

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:RestoreDBInstance

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域。	cn-hangzhou
PayType	string	是	实例付费类型。 PREPAY：包年包月 POSTPAY：按量付费	PREPAY
DBNodeCount	integer	否	实例节点数量，最小为 2。	2
DBNodeClass	string	否	节点规格： polarx.x4.medium.2e：2 核 8 GB polarx.x4.large.2e：4 核 16 GB polarx.x8.large.2e：4 核 32 GB polarx.x4.xlarge.2e：8 核 32 GB polarx.x8.xlarge.2e：8 核 64 GB polarx.x4.2xlarge.2e：16 核 64 GB polarx.x8.2xlarge.2e：16 核 128 GB polarx.x4.4xlarge.2e：32 核 128 GB polarx.x8.4xlarge.2e：32 核 256 GB polarx.st.8xlarge.2e：60 核 470 GB polarx.st.12xlarge.2e：90 核 720 GB	polarx.x4.2xlarge.2d
ClientToken	string	否	幂等请求串，保持每次创建不同即可。	xxxxxx-xxx
NetworkType	string	否	网络类型，仅支持 VPC 网络。	vpc
VPCId	string	否	VPC ID。	vpc-*****
VSwitchId	string	否	虚拟交换机 ID。	vsw-*********
UsedTime	integer	否	预付费时，可以选择买几个月或者几年。说明 Period 设置为 Year 时，该参数支持的取值为 1、2、3。	1
Period	string	否	收费周期，包年包月只能选 Year、Month，按量付费默认选择 Hour。	Month
ResourceGroupId	string	否	可以为空，资源组 ID，暂时不支持。	null
AutoRenew	boolean	否	是否自动续费，默认为 true。 true：是 false：否	true
EngineVersion	string	是	mysql 引擎版本，5.7 或者 8.0。	5.7
TopologyType	string	是	拓扑类型： 3azones：三可用区； 1azone：单可用区。	3azones
PrimaryZone	string	否	主可用区。	cn-shenzhen-e
SecondaryZone	string	否	次可用区。	cn-shenzhen-a
TertiaryZone	string	否	第三可用区。	cn-shenzhen-e
ZoneId	string	否	实例可用区。	cn-hangzhou-a
CnClass	string	否	计算节点规格： polarx.x4.medium.2e：2 核 8 GB polarx.x4.large.2e：4 核 16 GB polarx.x8.large.2e：4 核 32 GB polarx.x4.xlarge.2e：8 核 32 GB polarx.x8.xlarge.2e：8 核 64 GB polarx.x4.2xlarge.2e：16 核 64 GB polarx.x8.2xlarge.2e：16 核 128 GB polarx.x4.4xlarge.2e：32 核 128 GB polarx.x8.4xlarge.2e：32 核 256 GB polarx.st.8xlarge.2e：60 核 470 GB polarx.st.12xlarge.2e：90 核 720 GB	polarx.x4.medium.2e
DnClass	string	否	存储节点规格： mysql.n4.medium.25：2 核 8 GB mysql.n4.large.25：4 核 16 GB mysql.x8.large.25：4 核 32 GB mysql.n4.xlarge.25：8 核 32 GB mysql.x8.xlarge.25：8 核 64 GB mysql.n4.2xlarge.25：16 核 64 GB mysql.x8.2xlarge.25：16 核 128 GB mysql.x4.4xlarge.25：32 核 128 GB mysql.x8.4xlarge.25：32 核 256 GB mysql.st.8xlarge.25：60 核 470 GB mysql.st.12xlarge.25：90 核 720 GB	mysql.n4.medium.25
CNNodeCount	string	否	计算节点个数。	2
DNNodeCount	string	否	存储节点个数。	2
CloneInstanceName	string	是	源实例名	pxc-***
RestoreTime	string	否	实例所需恢复的时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-10-14T00:00:00Z
RecoveryTypeCode	string	是	恢复类型	Clone
BackupSetId	string	否	备份集 ID。	111
BackupSetRegion	string	是	备份集所在地域。	cn-chengdu
SourceInstanceRegion	string	是	源实例所在地域	cn-chengdu
Series	string	否	企业版：enterprise 标准版：standard	enterprise
StorageType	string	否	存储类型	cloud_auto
GdnRole	string	否	gdn 角色	standby

返回参数

名称	类型	描述	示例值
	object	返回数据
RequestId	string	请求 ID。	9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C
DBInstanceName	string	实例名称。	pxc-*********
OrderId	string	订单号。	12345

示例

正常返回示例

JSON格式

{
  "RequestId": "9B2F3840-XXXX-XXXX-XXXX-2D5C3A31797C",
  "DBInstanceName": "pxc-*********",
  "OrderId": "12345"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。