RDS for PostgreSQL
RDS for PostgreSQL
Document
- Documentation
RDS for PostgreSQL API referenceV2(2022-01-01)Managing instancesDescribeDBInstances
Copy page
Download PDFManaging instances
DescribeDBInstances
Copy pageDownload PDFDescribeDBInstances
Call the DescribeDBInstances API to query a list of instances.
Request type
Asynchronous request.
Precautions
None of the request parameters for this API has a default value. When a parameter is not specified, the query does not filter by that parameter and proceeds based on other specified query conditions.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
TagFilterObject
Response parameters
InstanceObject
Parameter | Type | Example | Description |
AddressObject | Refer to the sample response. | Connection information of the default endpoint. | |
ChargeDetail | Refer to the sample response. | Instance billing information. | |
CreateTime | String | 2022-01-01T10:10:10.000Z | local time when creating the instance. |
DBEngineVersion | String | PostgreSQL_12 | Compatible version. Values:
|
Endpoints | Refer to the sample response. | Instance endpoint information. | |
InstanceId | String | postgres-21a3333b**** | Instance ID. |
InstanceName | String | test | Storage type. |
InstanceStatus | String | Running | Instance state, values:
|
InstanceType | String | HA | Instance type. Value: HA (High-availability Edition). |
MaintenanceWindow | Refer to the sample response. | Maintenance window information of the instance. | |
NodeNumber | Integer | 2 | Number of nodes. |
NodeSpec | String | rds.postgres.1c2g | Primary node specifications. |
ProjectName | String | Test | Affiliated project of the instance. |
RegionId | String | cn-beijing | Region ID. You can call the DescribeRegions API to query and use this parameter to specify the region where you want to create the instance. |
StorageSpace | Integer | 200 | The storage space for the instance. Unit: GB. |
StorageType | String | LocalSSD | Instance storage type. Fixed value LocalSSD (local SSD disk). |
SubnetId | String | subnet-30uhx4w39n75s7r2qr0lq**** | Subnet ID. |
Tags | [{ "Key": "test", "Value": "123" }] | Array of tag objects. | |
VpcId | String | vpc-2gdgzrrl5icjk50ztyz6b**** | A proprietary network (VPC) ID. |
ZoneId | String | cn-beijing-a | The availability zone ID of the primary node where the instance initially resides. |
ZoneIds | Array of String | ["cn-beijing-a","cn-beijing-b"] | Availability zone ID of each node in the instance. |
AddressObject
Parameter | Type | Example | Description |
CrossRegionDomain | String | postgresca7b7019****.rds-pg.cn-beijing.ivolces.com | Private network address accessible across regions. tip This field is not returned if the address is unavailable. |
DNSVisibility | Boolean | false | Enable or disable public network resolution. Values are:
|
Domain | String | postgresca7b7019****.rds-pg.ivolces.com | Connection domain name. |
DomainVisibilitySetting | String | CrossRegionDomain | Private network address type. Values:
|
EipId | String | eip-3jhjud2zgy1og3pncmeh7**** | ID of EIP, valid only for Public Address. |
IPAddress | String | 192.. .253 | IP address. |
NetworkType | String | Private | Network address type, values are:
|
Port | String | 5432 | Port. |
SubnetId | String | subnet-30uhx4w39n75s7r2qr0lq**** | Subnet ID. |
ChargeDetailObject
Parameter | Type | Example | Description |
ChargeType | String | PostPaid | Payment type. Values:
|
AutoRenew | Boolean | true | Is automatic renewal enabled for the prepaid scenario?
|
Number | Integer | 1 | Number of instances. |
PeriodUnit | String | Month | Purchase period for prepaid scenarios.
|
Period | Integer | 1 | Subscription duration in a prepaid scenario. default value: 1. |
ChargeStatus | String | Normal | Payment status. Values:
|
ChargeStartTime | String | 2023-01-10T11:13:30.000Z | Instance billing start time. |
ChargeEndTime | String | 2023-01-10T11:13:34.000Z | Subscription instance expiration time. |
OverdueTime | String | 2023-01-10T11:13:30.000Z | Overdue shutdown time of the instance. |
OverdueReclaimTime | String | 2023-01-15T16:00:00.000Z | Estimated release time after the instance is suspended due to overdue payments. |
TempModifyStartTime | String | 2023-12-01T10:10:10.000Z | Start time of temporary upgrade. tip
|
TempModifyEndTime | String | 2023-12-07T10:10:09.000Z | Restoration time of temporary upgrade. tip Return when the instance is under temporary upgrade. |
EndpointObject
Parameter | Type | Example | Description |
Address | Refer to the Sample response. | Address list. | |
AutoAddNewNodes | String | Enable | When the endpoint type is read/write or read-only, setting whether the new node joins automatically is supported. Values:
|
Description | String | Primary address | Address description. |
EnableReadOnly | String | Enable | Whether global read-only is enabled.
|
EnableReadWriteSplitting | String | Enable | Whether read/write separation is enabled, value:
|
EndpointId | String | postgres-ca7b7019**** | Instance ID. |
EndpointName | String | Primary connection endpoint | Instance endpoint name. |
EndpointType | String | Cluster | endpoint type:
|
ReadOnlyNodeDistributionType | String | Default | Read-only weight allocation mode. Values:
|
ReadOnlyNodeMaxDelayTime | Integer | 30 | Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be routed to that node. Unit is in seconds. Value range: 0-3,600. Default value: 30. tip It supports setting this parameter for the default endpoint enabled with read/write separation. |
ReadOnlyNodeWeight | [ { "NodeType" : "Primary", "Weight" : 100 }, { "NodeId" : "postgres-ca7b7019****-2", "Weight" : 100 }, { "NodeId" : "postgres-ca7b7019****-3", "Weight" : 200 } ] | Node list configured for the connection endpoint and corresponding read-only weights. | |
ReadWriteMode | String | ReadOnly | Read/Write mode:
|
ReadWriteProxyConnection | Integer | 200 | Set the number of proxy connections for the endpoint after enabling read-write separation.
|
WriteNodeHaltWriting | Boolean | false | Whether the terminal sends write requests to the write node (currently, only the primary node is the write node). Values:
|
NodeWeightObject
MaintenanceWindowObject
Parameter | Type | Example | Description |
DayKind | String | Week | The granularity of the maintenance cycle, with values of Week. |
DayOfWeekMaintenanceTime | Refer to the sample. | Details of the instance maintenance window. |
DayOfWeekObject
Parameter | Type | Example | Description |
DayOfWeek | String | Monday,Tuesday | Specify the maintainable day for the instance each week. Multiple selections allowed.
tip If this value is not specified or empty, it defaults to all seven days of the week. |
MaintenanceWindowStartTime | String | 22:00Z | The instance's start time within the maintenance window on the maintainable day. Format: HH:mmZ (UTC time). tip Currently, only start times between 16:00Z and 20:00Z are supported for the maintenance window. |
Period | Integer | 6 | Duration of the instance's maintenance window on a maintainable day. tip The duration is at least 2 hours and at most 6 hours. |
TagObject
Example
Sample request
POST /?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.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"
}
]
}
Sample response
{
"ResponseMetadata": {
"RequestId": "20251014123704ABBB743EDFA13A979A78-62ee28",
"Action": "DescribeDBInstances",
"Version": "2022-01-01",
"Service": "rds_postgresql",
"Region": "cn-beijing"
},
"Result": {
"Instances": [
{
"AddressObject": [
{
"DNSVisibility": false,
"Domain": "postgres-d9ace5c3****-public.rds-pg.cn-beijing.volces.com",
"EipId": "eip-1a1k0eh4m8mio8nvepkxv****",
"IPAddress": "101.126.28.254",
"IPv6Address": "",
"InternetProtocol": "IPv4",
"NetworkType": "Public",
"Port": "5432",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****"
},
{
"CrossRegionDomain": "postgres-d9ace5c3****-private.rds-pg.cn-beijing.ivolces.com",
"DNSVisibility": false,
"Domain": "postgresd9ace5c3****.rds-pg.ivolces.com",
"DomainVisibilitySetting": "LocalDomain",
"EipId": "",
"IPAddress": "192.168.24.0",
"IPv6Address": "",
"InternetProtocol": "IPv4",
"NetworkType": "Private",
"Port": "5432",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****"
}
],
"AllowListVersion": "v1",
"ChargeDetail": {
"AutoRenew": true,
"ChargeEndTime": "2025-11-17T15:59:59.000Z",
"ChargeStartTime": "2023-04-06T01:26:57.000Z",
"ChargeStatus": "Normal",
"ChargeType": "PrePaid",
"Number": 1,
"OverdueReclaimTime": "2025-11-24T15:59:59.000Z",
"OverdueTime": "2025-11-18T04:00:00.000Z",
"Period": 1,
"PeriodUnit": "Month"
},
"CreateTime": "2023-04-06T01:26:57.000Z",
"DBEngineVersion": "PostgreSQL_11",
"Endpoints": [
{
"Address": [
{
"DNSVisibility": false,
"Domain": "postgres-d9ace5c3****-public.rds-pg.cn-beijing.volces.com",
"EipId": "eip-1a1k0eh4m8mio8nvepkxv****",
"IPAddress": "101.126.28.254",
"IPv6Address": "",
"InternetProtocol": "IPv4",
"NetworkType": "Public",
"Port": "5432",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****"
},
{
"CrossRegionDomain": "postgres-d9ace5c3****-private.rds-pg.cn-beijing.ivolces.com",
"DNSVisibility": false,
"Domain": "postgresd9ace5c3****.rds-pg.ivolces.com",
"DomainVisibilitySetting": "LocalDomain",
"EipId": "",
"IPAddress": "192.168.24.0",
"IPv6Address": "",
"InternetProtocol": "IPv4",
"NetworkType": "Private",
"Port": "5432",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****"
}
],
"AutoAddNewNodes": "Enable",
"Description": "",
"EnableReadOnly": "Disable",
"EnableReadWriteSplitting": "Disable",
"EndpointId": "postgres-d9ace5c3****",
"EndpointName": "",
"EndpointType": "Cluster",
"ReadOnlyNodeDistributionType": "Default",
"ReadOnlyNodeMaxDelayTime": 30,
"ReadOnlyNodeWeight": [
{
"NodeType": "Primary",
"Weight": 300
},
{
"NodeId": "postgres-ro-41d8643f4e17",
"NodeType": "ReadOnly",
"Weight": 0
}
],
"ReadWriteMode": "ReadWrite",
"ReadWriteProxyConnection": 200,
"WriteNodeHaltWriting": false
},
{
"Address": [
{
"DNSVisibility": false,
"Domain": "postgres-ro-41d8643f4e17-public.rds-pg.cn-beijing.volces.com",
"EipId": "eip-3pt0ad8yolqm86csxyv4oroxb",
"IPAddress": "180.184.36.160",
"IPv6Address": "",
"InternetProtocol": "IPv4",
"NetworkType": "Public",
"Port": "5432",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****"
},
{
"DNSVisibility": false,
"Domain": "postgresro41d8643f4e17.rds-pg.ivolces.com",
"DomainVisibilitySetting": "LocalDomain",
"EipId": "",
"IPAddress": "192.168.23.255",
"IPv6Address": "",
"InternetProtocol": "IPv4",
"NetworkType": "Private",
"Port": "5432",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****"
}
],
"AutoAddNewNodes": "Enable",
"Description": "",
"EnableReadOnly": "Disable",
"EnableReadWriteSplitting": "Disable",
"EndpointId": "postgres-ro-41d8643f4e17",
"EndpointName": "",
"EndpointType": "Custom",
"ReadOnlyNodeDistributionType": "Default",
"ReadOnlyNodeWeight": [
{
"NodeId": "postgres-ro-41d8643f4e17",
"NodeType": "ReadOnly",
"Weight": 300
}
],
"ReadWriteMode": "ReadOnly",
"ReadWriteProxyConnection": 200,
"WriteNodeHaltWriting": false
},
{
"Address": [
{
"DNSVisibility": false,
"Domain": "postgres-d9ace5c3****-custom-911a-private.rds-pg.ivolces.com",
"DomainVisibilitySetting": "LocalDomain",
"EipId": "",
"IPAddress": "192.168.16.4",
"IPv6Address": "",
"InternetProtocol": "IPv4",
"NetworkType": "Private",
"Port": "5432",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****"
}
],
"AutoAddNewNodes": "Disable",
"Description": "",
"EnableReadOnly": "Disable",
"EnableReadWriteSplitting": "Disable",
"EndpointId": "postgres-d9ace5c3****-custom-911a",
"EndpointName": "自定义终端",
"EndpointType": "Custom",
"ReadOnlyNodeDistributionType": "Default",
"ReadOnlyNodeMaxDelayTime": 30,
"ReadOnlyNodeWeight": [
{
"NodeType": "Primary",
"Weight": 300
}
],
"ReadWriteMode": "ReadWrite",
"ReadWriteProxyConnection": 200,
"WriteNodeHaltWriting": false
}
],
"InstanceId": "postgres-d9ace5c3****",
"InstanceName": "测试实例",
"InstanceStatus": "Running",
"InstanceType": "HA",
"MaintenanceWindow": {
"DayKind": "Week",
"DayOfWeekMaintenanceTime": [
{
"DayOfWeek": "Sunday",
"MaintenanceWindowStartTime": "16:00Z",
"Period": 6
},
{
"DayOfWeek": "Monday",
"MaintenanceWindowStartTime": "16:00Z",
"Period": 6
}
]
},
"NodeNumber": 3,
"NodeSpec": "rds.postgres.1c2g",
"ProjectName": "default",
"RegionId": "cn-beijing",
"StorageSpace": 100,
"StorageType": "LocalSSD",
"SubnetId": "subnet-rrnkvy55npc0v0x57x8****",
"Tags": [
{
"Key": "city",
"Value": "chengdu"
},
{
"Key": "owner",
"Value": "hechunxiong"
},
{
"Key": "分账TAG",
"Value": "测试分账功能"
}
],
"VpcId": "vpc-miswzgsgy77k5smt1ar9****",
"ZoneId": "cn-beijing-a",
"ZoneIds": [
"cn-beijing-a"
]
}
],
"Total": 1
}
}
Last updated: 2026.03.31 10:45:18
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
