DescribeDrdsDbInstance - 查询 RDS 存储实例详情

更新时间:
复制 MD 格式

查询 DRDS 的 RDS 存储实例详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
drds:DescribeDrdsDbInstanceget
*instance
acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

请求参数

名称类型必填描述示例值
DrdsInstanceIdstring

实例名称。

drdshbga1138****
DbNamestring

数据库名称。

drds_test
DbInstanceIdstring

私有定制 RDS 实例 ID。

rm-bp1t1mk5a5bdj****

返回参数

名称类型描述示例值
object
Successboolean

请求是否成功。

true
RequestIdstring

请求 ID。

4FE09970-CA69-4144-88CA-67FB4BTY56G3
DbInstanceobject

私有定制 RDS 实例详情。

ExpireTimestring

实例过期时间,格式为 Unix 时间戳,单位为秒。

说明 仅预付费实例支持该参数。
12341434315
PayTypestring

实例付费类型,取值范围如下:

  • Prepaid:包年包月(即预付费)
  • Postaid:按量付费(即后付费或按小时付费)
Postpaid
DBInstanceStatusstring

实例状态。

1
NetworkTypestring

实例网络类型,目前仅支持专有网络 VPC

VPC
Portinteger

实例访问端口。

3306
EngineVersionstring

实例引擎版本,目前仅支持5.7版本。

5.7
DmInstanceIdstring

资源 ID。

dm-*************
ConnectUrlstring

私有定制 RDS 连接地址。

rm-***************.mysql.rds.aliyuncs.com
ReadWeightinteger

实例读比例。

70
RdsInstTypestring

实例类型。

RDS
RemainDaysstring

实例过期剩余天数。

0
DBInstanceIdstring

私有定制 RDS 实例 ID。

rm-***************
DbInstTypestring

实例类型,取值范围如下:

  • Primary:主实例
  • ReadOnly:只读实例
Primary
Enginestring

实例引擎,目前仅支持 MySQL

MySQL
ReadOnlyInstancesarray<object>

只读实例列表。

ReadOnlyInstanceobject
ExpireTimestring

实例过期时间戳。

1823487328173
PayTypestring

实例购买类型。

Postpaid
VersionActioninteger

无效字段

0
DBInstanceStatusstring

实例状态。

1
NetworkTypestring

实例网络类型。

VPC
Portinteger

实例访问端口。

3306
EngineVersionstring

实例引擎版本。

5.7
DmInstanceIdstring

资源 ID。

dm-*************
ConnectUrlstring

只读实例连接地址。

rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com
ReadWeightinteger

实例读比例。

30
RdsInstTypestring

实例类型。

RDS
RemainDaysstring

实例过期剩余天数。

0
DBInstanceIdstring

只读实例 ID。

rm-bp1ub71ct9skc****
DbInstTypestring

实例类型。

RDS
Enginestring

实例引擎。

MySQL

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "4FE09970-CA69-4144-88CA-67FB4BTY56G3",
  "DbInstance": {
    "ExpireTime": 12341434315,
    "PayType": "Postpaid",
    "DBInstanceStatus": 1,
    "NetworkType": "VPC",
    "Port": 3306,
    "EngineVersion": 5.7,
    "DmInstanceId": "dm-*************",
    "ConnectUrl": "rm-***************.mysql.rds.aliyuncs.com",
    "ReadWeight": 70,
    "RdsInstType": "RDS",
    "RemainDays": 0,
    "DBInstanceId": "rm-***************",
    "DbInstType": "Primary",
    "Engine": "MySQL",
    "ReadOnlyInstances": {
      "ReadOnlyInstance": [
        {
          "ExpireTime": 1823487328173,
          "PayType": "Postpaid",
          "VersionAction": 0,
          "DBInstanceStatus": 1,
          "NetworkType": "VPC",
          "Port": 3306,
          "EngineVersion": 5.7,
          "DmInstanceId": "dm-*************",
          "ConnectUrl": "rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com",
          "ReadWeight": 30,
          "RdsInstType": "RDS",
          "RemainDays": 0,
          "DBInstanceId": "rm-bp1ub71ct9skc****",
          "DbInstType": "RDS",
          "Engine": "MySQL"
        }
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.MasterDbInstanceReleaseThe master db instance has been released-
500InternalErrorThe request processing has failed due to some unknown error.请求失败,内部错误

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

变更历史

变更时间变更内容概要操作
暂无变更历史