DescribeMetaList_云数据库 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.

接口说明

适用引擎

RDS MySQL

说明 仅支持 MySQL 8.0、5.7、5.6 高可用版(本地 SSD 盘)。

功能说明

在使用 RestoreTable 接口进行 MySQL 单库单表恢复之前,您可以通过本接口查询可恢复的库表信息。

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
rds:DescribeMetaList
Get
DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
rds:ResourceTag
rds:ResourceTag

请求参数

字段名称字段详情
ClientTokenstring

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

示例值:ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

示例值:rm-uf6wjk5****参考取值来源:
    CloneDBInstance
    CreateDBInstance
    ReceiveDBInstance
    ModifyDBInstanceSpec
    RecoveryDBInstance
    DescribeDBInstances
    CalculateDBInstanceWeight
    MigrateDBNodes
    UpgradeDBInstanceMajorVersion
    TransformDBInstancePayType
    EvaluateLocalExtendDisk
    RestoreDdrTable
    RebuildReplicationLink
RestoreTypestring

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

示例值:BackupSetID枚举值:BackupSetIDRestoreTime
BackupSetIDinteger<int64>

基于备份集查询时,使用的备份集的 ID。可调用 DescribeBackups 获取。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:14***
RestoreTimestring

基于时间点查询时,使用的时间节点,需要早于当前时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。可调用 DescribeBackups 获取。展开详情

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

要查询的数据库名。精确匹配,会返回具体的数据库名以及库内所有的表。展开详情

示例值:testdb1
Patternstring

要查询的数据库名。模糊匹配,只返回匹配的数据库名,不返回表名。展开详情

示例值:test
PageSizeinteger<int32>

每页记录数。默认值:1展开详情

示例值:1
PageIndexinteger<int32>

页码,取值:大于 0 且不超过 Integer 的最大值。默认值:1展开详情

示例值:1
ResourceGroupIdstring

资源组 ID。

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

返回参数

字段名称字段详情
DBInstanceNamestring

实例名称。

示例值:rm-uf6wjk5****
Itemsobject
PageNumberinteger<int32>

页码。

示例值:1
PageRecordCountinteger<int32>

本页记录数。

示例值:1
RequestIdstring

请求 ID。

示例值:60F9A12A-16B8-4728-B099-4CA38D32C31C
TotalPageCountinteger<int32>

总页数。

示例值:1
TotalRecordCountinteger<int32>

总记录数。

示例值:1

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
NoAvailableDisasterRestoreBakset
No available disaster restore bakset诊断
400
InvalidPageSize
The page size is invalid诊断
400
InvalidPageIndex
The page index is invalid诊断
400
InvalidRestoreTime.Format
Specified restore time is not valid.诊断
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
InvalidConnectionString.Duplicate
Specified connection string already exists in the RDS.诊断
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
InvalidMeta.Empty
Meta information is empty.诊断
403
InvalidMeta.TooLarge
Meta information is too large.诊断
403
IncorrectDBInstanceType
Current DB instance type does not support this operation.诊断
403
IncorrectEngineVersion
Current engine version does not support operations.诊断
403
InvalidBackupLogStatus
Current backup log enable status does not support this operation.诊断
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
OperationDenied.ZoneResource
There is no available zone for inventory.诊断
403
NotInFlowController
Sorry,no permission.诊断
403
InvalidKmsKey
Kms key is disabled.诊断
403
InvalidInstanceLevel.Malformed
Current DB instance level does not support this operation.诊断
404
InvalidBackupSetID.NotFound
Specified backup set ID does not exist.诊断
404
InvalidParameters.Format
Specified parameter({}) is not valid.诊断
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.诊断

变更历史

变更时间变更内容概要操作
2024-04-28
变更请求参数BackupSetID
2022-08-04
新增请求参数ResourceGroupId