调用 DescribeDBInstances 接口查询实例列表。
异步请求。
本接口的请求参数均无默认值。在不传入某个参数时，表示不对该参数进行过滤，按照其他参数限定的查询条件下进行查询。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
InstanceId | String | 否 | postgres-21a3333b**** | 实例 ID。 |
InstanceName | String | 否 | 测试实例 | 实例名称。 |
InstanceStatus | String | 否 | Running | 实例状态，取值：
|
DBEngineVersion | String | 否 | PostgreSQL_12 | 兼容版本。取值：
|
CreateTimeStart | String | 否 | 2022-01-01T10:10:10.000Z | 查询创建实例创建时间范围。 |
CreateTimeEnd | String | 否 | 2022-01-01T10:10:10.000Z | 查询创建实例创建时间范围。 |
ZoneId | String | 否 | cn-beijing-a | 实例所属可用区。 |
ChargeType | String | 否 | PostPaid | 付费类型。取值：
|
ProjectName | String | 否 | testProject | 项目名称。 |
TagFilters | Object[] | 否 | 请参见请求示例。 | 标签查询数组对象。单次最多支持同时传入 10 组标签键值对进行查询筛选。 |
PageNumber | Integer | 否 | 1 | 当前页查询偏移量，默认值为 1。 |
PageSize | Integer | 否 | 10 | 每页记录数，取值应大于 0 且不超过 1000，默认值为 10。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Total | Integer | 1 | 实例总数。 |
Instances | Object[] | 请参见返回示例。 | 实例列表。 |
POST /?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1 Content-Type: application/json Host: open.volcengineapi.com X-Date: 20231002T101010Z Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458**** { "PageSize": 10, "PageNumber": 1, "ChargeType": "PostPaid", "InstanceStatus": "Running", "CreateTimeStart": "2024-07-24T09:05:36.000Z", "TagFilters": [ { "Key": "project", "Value": "default" } ] }
{ "ResponseMetadata": { "RequestId": "202503272007124B81E01BB2A7A8237263-36999a", "Action": "DescribeDBInstances", "Version": "2022-01-01", "Service": "rds_postgresql", "Region": "cn-beijing" }, "Result": { "Instances": [ { "AddressObject": [ { "DNSVisibility": false, "Domain": "postgresf511b775****.rds-pg.ivolces.com", "EipId": "", "IPAddress": "192.***.***.18", "NetworkType": "Private", "Port": "5432", "SubnetId": "subnet-2gdf1ekvopudc50ztz07f****" } ], "AllowListVersion": "v2", "ChargeDetail": { "AutoRenew": false, "ChargeEndTime": "", "ChargeStartTime": "2025-03-12T07:06:57.000Z", "ChargeStatus": "Normal", "ChargeType": "PostPaid", "Number": 1, "OverdueReclaimTime": "", "OverdueTime": "", "Period": 0, "PeriodUnit": "Month" }, "CreateTime": "2025-03-12T07:06:57.000Z", "DBEngineVersion": "PostgreSQL_17", "DayOfWeekMaintenanceTime": [ { "DayOfWeek": "Sunday", "MaintenanceWindowStartTime": "18:00Z", "Period": 4 }, { "DayOfWeek": "Monday", "MaintenanceWindowStartTime": "18:00Z", "Period": 4 }, { "DayOfWeek": "Tuesday", "MaintenanceWindowStartTime": "18:00Z", "Period": 4 }, { "DayOfWeek": "Wednesday", "MaintenanceWindowStartTime": "18:00Z", "Period": 4 }, { "DayOfWeek": "Thursday", "MaintenanceWindowStartTime": "18:00Z", "Period": 4 }, { "DayOfWeek": "Friday", "MaintenanceWindowStartTime": "18:00Z", "Period": 4 }, { "DayOfWeek": "Saturday", "MaintenanceWindowStartTime": "18:00Z", "Period": 4 } ], "Endpoints": [ { "Address": [ { "DNSVisibility": false, "Domain": "postgresf511b775****.rds-pg.ivolces.com", "EipId": "", "IPAddress": "192.***.***.18", "NetworkType": "Private", "Port": "5432", "SubnetId": "subnet-2gdf1ekvopudc50ztz07f****" } ], "AutoAddNewNodes": "Enable", "Description": "", "EnableReadOnly": "Disable", "EnableReadWriteSplitting": "Enable", "EndpointId": "postgres-f511b775****-cluster", "EndpointName": "默认终端", "EndpointType": "Cluster", "ReadOnlyNodeDistributionType": "Default", "ReadOnlyNodeMaxDelayTime": 30, "ReadOnlyNodeWeight": [ { "NodeId": "postgres-f511b775****-ro82d0", "NodeType": "ReadOnly", "Weight": 300 }, { "NodeType": "Primary", "Weight": 0 }, { "NodeId": "postgres-f511b775****-ro79fe", "NodeType": "ReadOnly", "Weight": 300 } ], "ReadWriteMode": "ReadWrite", "ReadWriteProxyConnection": 100, "WriteNodeHaltWriting": false }, { "Address": [ { "DNSVisibility": false, "Domain": "postgres-f511b775****-custom-b0ec-private.rds-pg.ivolces.com", "EipId": "", "IPAddress": "192.***.***.14", "NetworkType": "Private", "Port": "5432", "SubnetId": "subnet-2gdf1ekvopudc50ztz07f****" } ], "AutoAddNewNodes": "Disable", "Description": "", "EnableReadOnly": "Disable", "EnableReadWriteSplitting": "Disable", "EndpointId": "postgres-f511b775****-custom-b0ec", "EndpointName": "自定义终端", "EndpointType": "Custom", "ReadOnlyNodeDistributionType": "Default", "ReadOnlyNodeMaxDelayTime": 30, "ReadOnlyNodeWeight": [ { "NodeType": "Primary", "Weight": 300 } ], "ReadWriteMode": "ReadWrite", "ReadWriteProxyConnection": 200, "WriteNodeHaltWriting": false } ], "InstanceId": "postgres-f511b775****", "InstanceName": "新利测试", "InstanceStatus": "Running", "InstanceType": "HA", "NodeNumber": 4, "NodeSpec": "rds.postgres.1c2g", "ProjectName": "default", "RegionId": "cn-beijing", "StorageSpace": 20, "StorageType": "LocalSSD", "SubnetId": "subnet-2gdf1ekvopudc50ztz07f****", "Tags": [ { "Key": "project", "Value": "default" } ], "VpcId": "vpc-3jgwn2ob0qrk03pncmedk****", "ZoneId": "cn-beijing-a", "ZoneIds": [ "cn-beijing-a" ] } ], "Total": 1 } }