DescribeDrdsRdsInstances - 私有定制RDS实例详情-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查看目标PolarDB-X实例下所有的私有定制RDS实例详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
drds:DescribeDrdsRdsInstances	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DrdsInstanceId	string	是	PolarDB-X 实例 ID。说明您可以调用 DescribeDrdsInstances 查看目标账号下所有实例详情，包括实例 ID。	drds*************

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	123DB16B-02F2-45F7-A571-843991******
Success	boolean	请求是否成功。	true
DbInstances	array<object>	存储层私有定制 RDS 实例信息详情。
DbInstance	object
DBInstanceCPU	string	存储层私有定制 RDS 实例的 CPU 核数。	8
DBInstanceMemory	long	存储层私有定制 RDS 实例的内存，单位：M。	8192
PayType	string	存储层私有定制 RDS 实例的付费方式，取值范围如下： Postpaid：按量付费（即后付费） Prepaid：包年包月（即预付费）	PostPaid
DBInstanceStatus	string	存储层私有定制 RDS 实例的状态，取值范围如下： 0：创建中 1：运行中 3：删除中 5：重启中 6：升降级中 7：备份中 8：内外网切换中 9：迁移中 11：迁移数据中 12：生成灾备实例中 13：数据导入中 14：从其他 RDS 实例导入数据中 15：容灾切换中 16：创建临时实例中 17：网络创建中 18：实例克隆中 19：链路切换中 20：只读实例迁移中	1
NetworkType	string	存储层私有定制 RDS 实例的网络类型，固定为 VPC（专有网络）。	VPC
Port	integer	内网连接端口。	3306
EngineVersion	string	存储层私有定制 RDS 实例的引擎版本号，固定为 8.0。	8.0
DmInstanceId	string	资源 ID。	dm-*************
DBInstanceStorage	long	存储层私有定制 RDS 实例的存储空间，单位：GB。	20
ConnectUrl	string	存储层私有定制 RDS 实例的内网连接地址。	rm-***************.mysql.rds.aliyuncs.com
ReadWeight	integer	目标存储层私有定制 RDS 实例的读写权重。	0
RdsInstType	string	存储层私有定制 RDS 实例的类型，取值范围如下： Primary：主实例 Readonly：只读实例	Primary
DBInstanceClassType	string	实例规格族，取值范围如下： x：通用型 d：独享套餐 h：独占物理机	x
DBInstanceId	string	存储层私有定制 RDS 实例 ID。	rm-*****************
Engine	string	存储层私有定制 RDS 实例的引擎类型，固定为 MySQL。	MySQL
DbInstType	string	存储层实例类型，固定为 RDS。	RDS
LockMode	integer	RDS 的锁定状态，取值范围：0\|1\|2\|3\|4\|5 0，正常 1，手动触发锁 2，实例过期自动锁定 3，实例回滚前的自动锁定 4，实例空间满自动锁定 5，只读实例空间满自动锁定	1
LockReason	string	RDS 锁定的原因	手动触发锁

示例

正常返回示例

JSON格式

{
  "RequestId": "123DB16B-02F2-45F7-A571-843991******",
  "Success": true,
  "DbInstances": {
    "DbInstance": [
      {
        "DBInstanceCPU": 8,
        "DBInstanceMemory": 8192,
        "PayType": "PostPaid",
        "DBInstanceStatus": 1,
        "NetworkType": "VPC",
        "Port": 3306,
        "EngineVersion": 8,
        "DmInstanceId": "dm-*************",
        "DBInstanceStorage": 20,
        "ConnectUrl": "rm-***************.mysql.rds.aliyuncs.com",
        "ReadWeight": 0,
        "RdsInstType": "Primary",
        "DBInstanceClassType": "x",
        "DBInstanceId": "rm-*****************",
        "Engine": "MySQL",
        "DbInstType": "RDS",
        "LockMode": 1,
        "LockReason": "手动触发锁"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

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

变更历史

变更时间	变更内容概要	操作
2024-07-16	OpenAPI 错误码发生变更	查看变更详情