备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 停止维护的接口 DescribeDBInstancesForClone - 获取克隆数据库实例

DescribeDBInstancesForClone - 获取克隆数据库实例

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

调用DescribeDBInstancesForClone查看实例列表。

接口说明

本接口已下线，请勿使用。

调试

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

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstancesForCloneRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    无
无

请求参数

名称类型必填描述示例值
ClientTokenstring否

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

ETnLKlblzczshOTUbOCzxxxxxxxxxx
proxyIdstring否

代理模式 ID。

API
Enginestring否

数据库类型。取值：

  • MySQL
  • SQLServer
  • PostgreSQL
  • PPAS
  • MariaDB

默认返回所有数据库类型的实例。

MySQL
ZoneIdstring否

可用区 ID。

cn-hangzhou-h
DBInstanceStatusstring否

实例状态。取值请参见实例状态表。

Running
Expiredstring否

实例是否已过期。取值：

  • True：已过期
  • False：未过期
True
SearchKeystring否

搜索关键词，可基于实例 ID 或者实例备注模糊搜索。

rm-uf6w
DBInstanceIdstring否

实例 ID.

rm-uf6wjk5xxxxxxxxxx
DBInstanceTypestring否

实例类型，取值：

  • Primary：主实例
  • Readonly：只读实例
  • Guard：灾备实例
  • Temp：临时实例

默认返回所有类型的实例。

Primary
RegionIdstring是

地域 ID。

cn-hangzhou
PageSizeinteger否

每页记录数，取值：1~100。

默认值：30。

30
PageNumberinteger否

页码。

1
InstanceNetworkTypestring否

实例的网络类型，取值：

  • Classic：经典网络
  • VPC：专有网络
Classic
VpcIdstring否

专有网络 ID。

vpc-j6cjvqms29yxxxxxxxxxx
VSwitchIdstring否

交换机 ID。

vsw-j6csw46bgrgkxxxxxxxxxx
DBInstanceClassstring否

实例规格。详情请参见实例规格表。

mysql.n1.micro.1
EngineVersionstring否

数据库版本号。

5.7
NodeTypestring否

数据库节点类型。取值：

  • Master：主节点
  • Slave：备节点
Master
PayTypestring否

实例的付费类型。取值：

  • Postpaid：后付费（按量付费）
  • Prepaid：预付费（包年包月）

默认返回所有付费类型的实例。

Postpaid
ConnectionModestring否

实例的访问模式，取值：

  • Standard：标准访问模式
  • Safe：数据库代理模式

默认返回所有访问模式下的实例。

Standard
CurrentInstanceIdstring否

当前实例 ID。

rm-uf6wjk5xxxxxxxxxx
ResourceGroupIdstring否

资源组 ID。

rg-acfmy*****

返回参数

名称类型描述示例值
object

返回参数如下。

RequestIdstring

请求 ID。

1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
PageNumberinteger

页码。

12
PageRecordCountinteger

当前页实例个数。

10
TotalRecordCountinteger

总记录数。

120
Itemsobject []

由实例信息组成的数组。

VpcIdstring

专有网络 ID。

vpc-bp1opxu1zkhxxxxxxxxxx
ReplicateIdstring

无。

无
TempDBInstanceIdstring

临时实例 ID。

sub138xxxxx_rm-xxxxx
DBInstanceStorageTypestring

实例储存类型，返回值：

  • local_ssd/ephemeral_ssd：本地 SSD 盘
  • cloud_ssd：SSD 云盘
  • cloud_essd：ESSD 云盘
local_ssd
CreateTimestring

实例创建时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2018-11-05T11:26:02Z
PayTypestring

实例的付费类型。返回值：

  • Postpaid：后付费（按量付费）
  • Prepaid：预付费（包年包月）
Postpaid
MutriORsignleboolean

是否是多可用区，返回值：

  • true：是
  • false：否
false
ConnectionModestring

实例的访问模式，返回值：

  • Standard：标准访问模式
  • Safe：数据库代理模式
Standard
LockModestring

实例锁定状态，返回值：

  • Unlock：正常，没有锁定。
  • ManualLock：手动触发锁定。
  • LockByExpiration：实例过期自动锁定。
  • LockByRestoration：实例回滚前的自动锁定。
  • LockByDiskQuota：实例空间满自动锁定，不可访问实例。
Unlock
EngineVersionstring

数据库版本。

5.7
VpcCloudInstanceIdstring

VPC 中的实例 ID。

rm-uf6wjk5xxxxxxxxxx
InsIdinteger

实例角色 ID。

1
InstanceNetworkTypestring

实例的网络类型，返回值：

  • Classic：经典网络
  • VPC：专有网络
Classic
MasterInstanceIdstring

主实例的 ID，如果没有返回此参数（即为 null）则表示该实例是主实例。

rm-uf6wjk5xxxxxxxxxx
DBInstanceDescriptionstring

实例名称，长度为 2~256 个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。

说明 不能以 http:// 和 https:// 开头。
Test
ExpireTimestring

实例过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2018-11-28T11:26:02Z
DBInstanceNetTypestring

实例的网络连接类型。返回值：

  • Internet：公网连接
  • Intranet：内网连接
Intranet
DBInstanceTypestring

实例类型，返回值：

  • Primary：主实例
  • Readonly：只读实例
  • Guard：灾备实例
  • Temp：临时实例
Primary
DestroyTimestring

实例销毁时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2018-12-05T11:26:02Z
LockReasonstring

实例被锁定的原因。

instance_expired
DBInstanceStatusstring

实例状态。详情请参见实例状态表。

Running
GuardDBInstanceIdstring

主实例如果有灾备实例，该参数即为灾备实例的 ID。

rm-uf64zsuxxxxxxxxxx
RegionIdstring

地域 ID。

cn-hangzhou
VSwitchIdstring

交换机 ID。

vsw-uf6adz52c2pxxxxxxxxxx
ResourceGroupIdstring

资源组 ID。

rg-acfmyxxxxx
ZoneIdstring

可用区 ID。

cn-hangzhou-h
DBInstanceIdstring

实例 ID。

rm-uf6wjk5xxxxxxxxxx
Categorystring

实例系列：

  • Basic：基础版
  • HighAvailability：高可用版
  • Finance：三节点企业版
HighAvailability
Enginestring

数据库类型。返回值：

  • MySQL
  • SQLServer
  • PostgreSQL
  • PPAS
  • MariaDB
MySQL
DBInstanceClassstring

实例规格。详情请参见实例规格表。

mysql.n1.micro.1
ReadOnlyDBInstanceIdsobject []

主实例下挂载的只读实例 ID 列表。

DBInstanceIdstring

只读实例 ID。

rm-bpxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  "PageNumber": 12,
  "PageRecordCount": 10,
  "TotalRecordCount": 120,
  "Items": {
    "DBInstance": [
      {
        "VpcId": "vpc-bp1opxu1zkhxxxxxxxxxx",
        "ReplicateId": "无",
        "TempDBInstanceId": "sub138xxxxx_rm-xxxxx",
        "DBInstanceStorageType": "local_ssd",
        "CreateTime": "2018-11-05T11:26:02Z",
        "PayType": "Postpaid",
        "MutriORsignle": false,
        "ConnectionMode": "Standard",
        "LockMode": "Unlock",
        "EngineVersion": "5.7",
        "VpcCloudInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "InsId": 1,
        "InstanceNetworkType": "Classic",
        "MasterInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "DBInstanceDescription": "Test",
        "ExpireTime": "2018-11-28T11:26:02Z",
        "DBInstanceNetType": "Intranet",
        "DBInstanceType": "Primary",
        "DestroyTime": "2018-12-05T11:26:02Z",
        "LockReason": "instance_expired",
        "DBInstanceStatus": "Running",
        "GuardDBInstanceId": "rm-uf64zsuxxxxxxxxxx",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-uf6adz52c2pxxxxxxxxxx\t",
        "ResourceGroupId": "rg-acfmyxxxxx",
        "ZoneId": "cn-hangzhou-h",
        "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "Category": "HighAvailability",
        "Engine": "MySQL",
        "DBInstanceClass": "mysql.n1.micro.1",
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rm-bpxxxxxxxxx"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBInstanceType.ValueNotSupportThe specified parameter"DBInstanceType" is not valid.操作失败，指定实例类型无效。请选择正确的实例类型。
400ApiErrorAPI error.-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou 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.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear 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.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。

访问错误中心查看更多错误码。
  • 本页导读 （1）
文档反馈