CreateDdrInstance_云数据库 RDS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

说明 恢复前可以调用 CheckCreateDdrDBInstance 接口预检查某 RDS 实例是否可以用跨地域备份集进行跨地域恢复。

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

流控信息

请求速率为100/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
rds:CreateDdrInstance
Create
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

目标地域 ID,可以通过接口 DescribeRegions 查看地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
Enginestring

目标数据库类型,取值:展开详情

示例值:MySQL
EngineVersionstring

目标数据库版本。根据 Engine 参数取值的不同,本参数取值如下:展开详情

示例值:5.6参考取值来源:
    DescribeDBMiniEngineVersions
DBInstanceClassstring

目标实例规格,详见实例规格表

示例值:rds.mysql.s1.small参考取值来源:
    CreateDBInstance
    DescribeDBInstances
DBInstanceStorageinteger<int32>

目标实例存储空间,取值:5~2000展开详情

示例值:20
SystemDBCharsetstring

目标实例的字符集,取值:展开详情

示例值:uft8
DBInstanceNetTypestring

目标实例的网络连接类型,取值:展开详情

示例值:Intranet参考取值来源:
    CreateDBInstance
    DescribeDBInstances
DBInstanceDescriptionstring

目标实例名称,长度为 2~256 个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。展开详情

示例值:testdb
SecurityIPListstring

目标实例的 IP 白名单,多个 IP 地址请以半角逗号(,)隔开,不可重复,最多 1000 个。支持如下两种格式:展开详情

示例值:127.0.0.1参考取值来源:
    DescribeDBInstanceIPArrayList
    CreateDBInstance
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

示例值:ETnLKlblzczshOTUbOCz****
PayTypestring

目标实例的付费类型,取值:展开详情

示例值:Prepaid
ZoneIdstring

目标实例的可用区 ID。多可用区用英文冒号(:)分隔。展开详情

示例值:cn-hangzhou-b
InstanceNetworkTypestring

目标实例的网络类型,取值:展开详情

示例值:Classic参考取值来源:
    DescribeDBInstanceNetInfo
ConnectionModestring

目标实例的访问模式,取值:展开详情

示例值:Standard
VPCIdstring

目标实例的 VPC ID。当 InstanceNetworkType=VPC 时,本参数可用。展开详情

示例值:vpc-****
VSwitchIdstring

目标实例的虚拟交换机 ID,多个值用半角逗号(,)隔开。当 InstanceNetworkType=VPC 时,本参数可用。展开详情

示例值:vsw-****参考取值来源:
    DescribeVSwitches
PrivateIpAddressstring

设置目标实例的内网 IP,需要在指定交换机的 IP 地址范围内。系统默认通过 VPCIdVSwitchId 自动分配。

示例值:172.XX.XX.69
UsedTimestring

指定购买时长,取值:展开详情

示例值:2
Periodstring

指定预付费目标实例为包年或者包月类型,取值:展开详情

示例值:Year
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmy****参考取值来源:
    DescribeResourceDetails
RestoreTypestring

恢复方式,取值:展开详情

示例值:BackupSet枚举值:BackupSetBackupTime01
BackupSetIdstring

基于备份集恢复时,使用的备份集的 ID。可以通过接口 DescribeCrossRegionBackups 查看备份集 ID。展开详情

示例值:14****
BackupSetRegionstring

备份集所在 Region。

示例值:cn-beijing
RestoreTimestring

基于时间点恢复时,要恢复的时间节点,需要早于当前时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情

示例值:2019-05-30T03:29:10Z
SourceRegionstring

基于时间点恢复时,源地域的 ID。展开详情

示例值:cn-hangzhou
SourceDBInstanceNamestring

基于时间点恢复时,源实例的 ID。展开详情

示例值:rm-uf6wjk5****
DBInstanceStorageTypestring

目标实例存储类型,当前仅支持 SSD 本地盘,默认值:local_ssd

示例值:local_ssd参考取值来源:
    CreateDBInstance
    DescribeDBInstances
RoleARNstring

主账号授权 RDS 云服务账号访问 KMS 权限的全局资源描述符(ARN)。您可以通过 CheckCloudResourceAuthorized 接口查看 ARN 信息。展开详情

示例值:acs:ram::1406****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKeystring

用户自定义云盘加密的密钥 ID。传入此参数表示开启云盘加密(开启后无法关闭),并且需要传入 RoleARN展开详情

示例值:749c1df7-****-****-****-****参考取值来源:
    DescribeDBInstanceEncryptionKey

返回参数

字段名称字段详情
ConnectionStringstring

新实例连接地址。展开详情

示例值:rm-****.mysql.rds.aliyuncs.com
DBInstanceIdstring

新实例 ID。

示例值:rm-****
OrderIdstring

订单 ID。

示例值:2038691****
Portstring

新实例连接端口。展开详情

示例值:3306
RequestIdstring

请求 ID。

示例值:E52666CC-330E-418A-8E5B-A19E3FB42D13

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidZoneId.NotSupported
The Specified vpc Zone not supported.诊断
400
InvalidDBInstanceName.Format
Specified DB instance name is not valid.诊断
400
InvalidDBInstanceName.Duplicate
Specified DB instance name already exists in the Aliyun RDS.诊断
400
InvalidRegion.Format
Specified Region is not valid.诊断
400
InvalidServiceType.Format
Specified service type is not valid.诊断
400
InvalidEngine.Malformed
Specified engine is not valid.诊断
400
InvalidEngineVersion.Malformed
Specified engine version is not valid.诊断
400
InvalidConnectionString.Format
Specified connection string is not valid.诊断
400
InvalidConnectionString.Duplicate
Specified connection string already exists in the Aliyun RDS.诊断
400
InvalidCharacterSetName.Format
Specified character set name is not valid.诊断
400
InvalidDBInstanceType.Format
Specified instance type is not valid.诊断
400
InvalidPort.Malformed
Specified port is not valid.诊断
400
InvalidBackupRetentionPeriod.Malformed
Specified backup retention period is not valid.诊断
400
InvalidPreferredBackupTime.Format
Specified preferred backup time is not valid.诊断
400
InvalidPreferredBackupPeriod.Malformed
Specified backup period is not valid.诊断
400
InvalidOptmizationService
Specified optmization service is not valid.诊断
400
InvalidExpiredTime.Format
Specified expired time is not valid.诊断
400
InvalidSecurityIPList.Format
Specified security IP list format is not valid.诊断
400
InvalidSecurityIPList.Duplicate
Specified security IP list is not valid: Duplicate IP address in the list诊断
400
InvalidSecurityIPList.QuotaExceeded
Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.诊断
400
InvalidDBInstanceDescription.Format
Specified DB instance description is not valid.诊断
400
InvalidStorage.Format
Specified Storage is not valid.诊断
400
InvalidDBInstanceConnType.Format
Specified DB instance conn type is not valid.诊断
400
PreCheckInvalid
CreateDdrInstance PreCheck Is Invalid诊断
400
IncorrectDBInstanceType
Current DB instance engine and type does not support operations.诊断
400
InvalidRestoreType.Format
Specified restore type is not valid.诊断
400
NoBackupSetRegion
BackupSetRegion is absence.诊断
400
IncorrectBackupSetType
Backup set type should be value ddr.诊断
400
NoBaksetName
BaksetName is absence.诊断
400
NoSourceInstanceName
No SourceDBInstanceName.诊断
400
NoAvailableDisasterRestoreBakset
No available disaster restore bakset.诊断
400
InvalidBackupType.Format
Specified backup type is not valid.诊断
400
IncorrectEngineVersion
Current engine version does not support operations.诊断
400
DisasterRestoreRegionNotMatched
Disaster restore should be operated in the ddr region or source region.诊断
400
InvalidVpcIdRegion.NotSupported
The Specified vSwitchId zone not supported.诊断
400
VswitchIpExhausted
No available ip in the specified vswitch.诊断
400
Order.ComboInstanceNotAllowOperate
A package instance is not allowed to operate independently.诊断
400
Price.PricingPlanResultNotFound
Pricing plan price result not found.诊断
400
Order.NoRealNameAuthentication
You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.诊断
400
InsufficientAvailableQuota
Your account quota limit is less than 0, please recharge before trying to purchase.诊断
400
CommodityServiceCalling.Exception
Failed to call commodity service.诊断
400
RegionDissolvedEOM
Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.诊断
400
Commodity.InvalidComponent
The module you purchased is not legal, please buy it again.诊断
400
RegionEndTimeDissolvedAustralia
Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.诊断
400
Price.CommoditySys
Commodity system call exception.诊断
400
Pay.InsufficientBalance
Insufficient available balance.诊断
400
Order.PeriodInvalid
There is a problem with the period you selected, please choose again.诊断
400
pay.noCreditCard
Account not bound to credit card.诊断
400
Order.InstHasUnpaidOrder
There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.诊断
400
noAvailablePaymentMethod
No payment method is specified for your account. We recommend that you add a payment method.诊断
400
BasicInfoUncompleted
Your information is incomplete. Complete your information before the operation.诊断
400
Risk.RiskControlRejection
Your account is abnormal, please contact customer service for details.诊断
400
Api.NotSupport
Specified api is not supported.诊断
400
ContainForbiddenLabelError
There is a label that prohibits placing orders. Please contact your distributor for assistance.诊断
400
InvalidDBInstanceId.NotFound
The DBInstanceId provided does not exist in records.诊断
400
InvalidInstanceLevel.DiskType
Specified instance level not support request disk type诊断
400
InvalidParam
Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.诊断
400
KmsApiError
User secret key invalid.诊断
400
System.SaleValidateFailed
Sales expression validation system error.诊断
400
Abs.InvalidAccount.NotFound
account is not found.诊断
400
SqlExecuteFailedOrTimeout
sql command execution failed or timed out:%s.诊断
400
ColdData.EngineVersionNotSupport
The current instance engine version not support coldDataEnabled.诊断
400
ColdData.MinorVersionNotSupport
The current instance minor version not support coldDataEnabled.诊断
400
IncorrectTargetClasscode
The current instance type does not support this operation.诊断
400
RequiredParam.NotFound
Required input param is not found.诊断
400
Parameters.Invalid
Parameter error, please check the parameters.诊断
400
BackupPolicyNotSupport
Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.诊断
400
InvalideStatus.Format
The instance status does not support this operation.诊断
400
InvalidReleasedKeepPolicy.Format
Specified Released Keep Policy is not valid.诊断
400
InvalidDBInstanceEngineType.Format
the DB instance engine type does not support this operation.诊断
400
Pay.NoCreditCard
No credit cards.诊断
400
VpcNetworkTypeNotSupport
The vpc network type instance does not support this operation.诊断
400
MirrorInsExists
Specified DB instance mirror ins already existed.诊断
400
UnsupportedClassCode
The specified DB instance class stops selling.诊断
400
InvalidBackupSet
The specified database does not exist in the backup set.诊断
400
OrdTCommodityQueryError
Failed to query for product.诊断
400
ProductInstanceReleased
The instance has been released. Please check before placing the order.诊断
400
RegionEndTimeDissolvedIndia
The region is no longer supported.诊断
403
IncorrectBackupSetMethod
Current backup set method does not support operations.诊断
403
IncorrectBaksetVersion
Current bakset version does not support operations.诊断
403
CrossRegionUnsupportTDE
Cross-region disaster restore not support TDE bakset.诊断
403
OperationDenied.Resource
Specified DB instance class or storage is not available in all Availability Zones.诊断
403
OperationDenied.ZoneResource
There is no available zone for inventory.诊断
403
OrderStatus.UnPaid
The specified db instance has unpaid order.诊断
403
InvalidReduceDiskSize
The storage capacity after the scale-down must be larger than the used amount.诊断
403
CloudSSDNotSupport
Cloud ssd does not support this operation, please upgrade to essd.诊断
403
InvalidUserOperatorPermission
The user permission does not support this operation.诊断
403
InvalidVswitchId
Specified conn vswitch id is not valid.诊断
403
IncorrectMinorVersion
Current engine minor version does not support operations.诊断
403
NotInFlowController
Sorry,no permission.诊断
403
InvalidKmsKey
Kms key is disabled.诊断
403
InvalidInstanceLevel.Malformed
Current DB instance level does not support this operation.诊断
404
InvalidRegion.NotFound
Specified Region does not exist in the RDS诊断
404
InvalidClusterName.NotFound
The specified cluster name is not available.诊断
404
InvalidDBInstanceClass.NotFound
Specified DB instance class is not found.诊断
404
InvalidDBInstanceNetType.NotFound
Specified DB instance net type is not found.诊断
404
RestoreType.NotFound
RestoreType is not found.诊断
404
InvalidBackupSetID.NotFound
Specified backup set ID does not exist.诊断
404
InvalidClusterKms
The current instance does not authorized to access the Key Management Service.诊断
404
Request.NotFound
The requested resource is not available.诊断
404
HostInfo.NotFound
The specified host info is not found.诊断
500
ExternalFailure
The request processing has failed due to external service failure.诊断
500
RequestMetaDataFailed
The service request failed. Please try again later or contact service personnel.诊断
500
InvokeProxyFailure
The request processing has failed due to service failure of rds api.诊断

变更历史

变更时间变更内容概要操作
2025-02-28
新增请求参数BackupSetRegion
2025-02-27
变更请求参数DBInstanceClass
变更请求参数DBInstanceStorage
2024-08-27
新增请求参数RoleARN
新增请求参数EncryptionKey
删除返回参数
2024-05-29
变更错误码403
2024-05-27
变更错误码403
2023-07-14
变更错误码400
2023-01-11
新增返回参数
  • 1
  • 2
  • 10 条/页