DescribeDrdsInstances - 查询DRDS实例列表 - 云原生数据库 PolarDB

通过DescribeDrdsInstances接口查询DRDS实例列表。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
Type	string	否	实例类型。共享实例：0 专享实例：1	1
Description	string	否	实例的描述。	drds_test
Expired	boolean	否	是否过期。	false
PageNumber	integer	否	页码。	1
PageSize	integer	否	每页大小。	20
ResourceGroupId	string	否	资源组 ID，可以为空。	NULL
RegionId	string	是	地域 ID。	cn-hangzhou
Mix	boolean	否	是否支持混合查询。	FALSE
ProductVersion	string	否	产品版本号，可取值为 V1 或 V2。	V1
Tag	array<object>	否	标签属性列表。
	object	否
Key	string	否	标签的键。	acs:newretail:domain
Value	string	否	标签的值。	NEW_RETAIL

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	8734773E-7B21-4A22-9106-CBD245F8****
PageNumber	integer	页码。	1
PageSize	integer	每页大小。	20
Total	integer	实例总数。	1
Instances	array<object>	实例列表。
Instance	object
VpcId	string	虚拟专用网络 ID。	vpc-bp**********
Status	string	实例状态。	RUN
Type	string	实例类型。 PUBLIC：共享实例 PRIVATE：独享实例	PRIVATE
CommodityCode	string	商品代码。	drdsPost
MachineType	string	实例机器类型，仅支持 ecs。	ecs
CreateTime	long	创建时间戳。	1568620311000
VersionAction	string	实例版本可用操作。	Upgradable
InstanceSeries	string	实例规格系列。	drds.sn2.4c16g
NetworkType	string	网络类型。 CLASSIC：经典网络 VPC：专有网络	CLASSIC
Label	string	实例标签。 NORMAL：普通实例 HA：高可用实例 VPC：VPC 实例	NORMAL
ProductVersion	string	产品版本号。	V1
InstanceSpec	string	实例规格。	drds.sn2.4c16g.8C32G
RegionId	string	地域 ID。	cn-hangzhou-e
VpcCloudInstanceId	string	VPC 集群中的实例 ID。	drdssen12****
Description	string	实例描述。	drds_test
Version	long	实例版本。	0
ResourceGroupId	string	资源组 ID。	rg-aek2ljh3ye4****
ZoneId	string	可用区。	vsw-bpxxxxxxxxxxxxx96
DrdsInstanceId	string	实例 ID。	drdssen12****
ExpireDate	long	过期时间戳。	4724323200000
MasterInstanceId	string	主实例 ID。	drdssen12****
OrderInstanceId	string	购买的实例 ID。	drdssen12****
InstRole	string	实例角色。 MASTER：主实例 SLAVE：分析型只读实例 SLAVE_FLOW：并发型只读实例	MASTER
Vips	array<object>	VIP 列表。
Vip	object
VpcId	string	虚拟专用网络 ID。	vpc-bpxxxxxxxxxxxy
Type	string	VIP 类型。 intranet：内网 internet：外网	intranet
VswitchId	string	虚拟交换机 ID。	vsw-bpxxxxxxxxxxxxx96
Port	string	VIP 开放端口。	3306
IP	string	IP 地址。	10.23.*.*
dns	string	VIP 绑定的域名。	drdssen1243as.drds.aliyuncs.com
ReadOnlyDBInstanceIds	array
ReadOnlyDBInstanceId	string	只读实例 ID 列表。	drdssen12****
series	string	实例系列，取值如下： starter：入门版 enterprise：企业版 standard：标准版	enterprise

示例

正常返回示例

JSON格式

{
  "RequestId": "8734773E-7B21-4A22-9106-CBD245F8****",
  "PageNumber": 1,
  "PageSize": 20,
  "Total": 1,
  "Instances": {
    "Instance": [
      {
        "VpcId": "vpc-bp**********",
        "Status": "RUN",
        "Type": "PRIVATE",
        "CommodityCode": "drdsPost",
        "MachineType": "ecs",
        "CreateTime": 1568620311000,
        "VersionAction": "Upgradable",
        "InstanceSeries": "drds.sn2.4c16g",
        "NetworkType": "CLASSIC",
        "Label": "NORMAL",
        "ProductVersion": "V1",
        "InstanceSpec": "drds.sn2.4c16g.8C32G",
        "RegionId": "cn-hangzhou-e",
        "VpcCloudInstanceId": "drdssen12****",
        "Description": "drds_test",
        "Version": 0,
        "ResourceGroupId": "rg-aek2ljh3ye4****",
        "ZoneId": "vsw-bpxxxxxxxxxxxxx96",
        "DrdsInstanceId": "drdssen12****",
        "ExpireDate": 4724323200000,
        "MasterInstanceId": "drdssen12****",
        "OrderInstanceId": "drdssen12****",
        "InstRole": "MASTER",
        "Vips": {
          "Vip": [
            {
              "VpcId": "vpc-bpxxxxxxxxxxxy",
              "Type": "intranet",
              "VswitchId": "vsw-bpxxxxxxxxxxxxx96",
              "Port": 3306,
              "IP": "10.23.***.***",
              "dns": "drdssen1243as.drds.aliyuncs.com"
            }
          ]
        },
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            "drdssen12****"
          ]
        },
        "series": "enterprise"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ActionUnauthorized	The specified action is not available for you	指定的action未授权，请您先做RAM授权再进行操作。
400	ServiceUnable	The service is not available now, please try again later	-
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	-
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

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

变更历史

变更时间	变更内容概要	操作
2025-11-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2024-12-25	OpenAPI 错误码发生变更	查看变更详情
2024-12-24	OpenAPI 错误码发生变更	查看变更详情
2024-04-10	OpenAPI 错误码发生变更	查看变更详情
2024-04-10	OpenAPI 错误码发生变更	查看变更详情
2024-03-21	OpenAPI 错误码发生变更	查看变更详情
2021-12-11	OpenAPI 错误码发生变更	查看变更详情