Request type

Synchronous request.

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.

Go to debug

Request parameters

Parameter	Type	Required?	Example	Description
InstanceId	String	Yes	postgres-21a3333b****	Instance ID.

Response parameters

Parameter	Type	Example	Description
BasicInfo	Object of BasicInfoObject	Refer to the sample response.	Basic information of the instance.
Endpoints	Array of EndpointObject	Refer to the sample response.	Instance connection information.
ChargeDetail	Object of ChargeDetailObject	Refer to the sample response.	Instance billing information.
Nodes	Array of NodeObject	Refer to the sample response.	Instance node information.

BasicInfoObject

Parameter	Type	Example	Description
CreateTime	String	2022-01-01T10:10:10.000Z	Instance creation time. Format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
DBEngineVersion	String	PostgreSQL_12	Compatible version. Values: PostgreSQL_11: PostgreSQL 11. PostgreSQL_12: PostgreSQL 12. PostgreSQL_13: PostgreSQL 13. PostgreSQL_14: PostgreSQL 14. PostgreSQL_15: PostgreSQL 15. PostgreSQL_16: PostgreSQL 16. PostgreSQL_17: PostgreSQL 17. PostgreSQL_18：PostgreSQL 18。
DataSyncMode	String	Async	Synchronization mode. Value is Async, meaning asynchronous synchronization.
InstanceId	String	postgres-21a3333b****	Instance ID.
InstanceName	String	Test123	Storage type.
InstanceStatus	String	Running	Instance state, values: Running: running. Creating: creating. Deleting: deleting. Restarting: Restarting. Restoring: recovering. Updating: modifying. Upgrading: upgrading. Error: error. Released: released. CreateError: create error. MasterChanging: primary node switching. Deleted: Deleted. Recycled: recycled.
InstanceTag	Array of TagObject	[{ "Key": "test", "Value": "123" }]	Array of tag objects. tip If the instance is not bound with tags, this field is not returned.
InstanceType	String	HA	Instance type. Value: HA (High-availability Edition).
MaintenanceWindow	Object of MaintenanceWindowObject	Refer to the sample response.	The maintenance window for the instance.
Memory	Integer	50	Memory size. Unit: GB.
NodeNumber	String	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.
StorageDataUse	Long	25666194	The used data file space of the instance primary node. Unit: Byte.
StorageLogUse	Long	1095433115	The log file space used by the primary node of the instance. Unit: Byte.
StorageSpace	Integer	200	The storage space for the instance. Unit: GB.
StorageTempUse	Long	4096	Temporary file space used by the instance primary node. Unit: Byte.
StorageUse	Long	142635726	Instance storage space used. Unit: Byte.
StorageType	String	LocalSSD	Instance storage type. Fixed value LocalSSD (local SSD disk).
StorageWALUse	Long	1241523717	The WAL file space used by the primary node of the instance. Unit: Byte.
SubnetId	String	subnet-30uhx4w39n75s7r2qr0lq****	Subnet ID.
UpdateTime	String	2022-01-01T10:10:10.000Z	Instance update time. Format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
VCPU	Integer	2	CPU size. For example: 1 indicates 1U.
VpcID	String	vpc-2gdgzrrl5icjk50ztyz6b****	Virtual private cloud (VPC) ID.
ZoneId	String	cn-beijing-a	Availability zone ID.
KMSTrn	String	trn:kms:cn-beijing:210xxxx:keyrings/testxxxx/keys/testxxxx	KMS key ring TRN. Format: trn:kms:<region>:<account_id>:keyrings/<ring_name>/keys/<key_name>.
TDEEnable	Boolean	true	Whether the instance has TDE encryption enabled. Values: true: TDE encryption is enabled. false: TDE encryption is disabled. tip TDE encryption cannot be disabled once enabled.

TagObject

Parameter	Type	Example	Description
Key	String	abc	Tag key. Naming rules are as follows: It cannot start with any case-insensitive variation of the prefix volc:. volc: is a system-reserved tag key and is forbidden to use. It can only contain language characters, numbers, spaces, and English symbols (_, ., :, /, =, +, -, and @). The length must be between 1 and 128 characters. tip The number of tags created at one time cannot exceed 20. Tag keys cannot be duplicated under a single instance.
Value	String	3	Tag value. The naming rules are as follows: It can only contain language characters, numbers, spaces, and English symbols (_, ., :, /, =, +, -, and @). Nullable. Length must be between 0 and 256 characters.

MaintenanceWindowObject

Parameter	Type	Example	Description
DayKind	String	Week	The granularity of the maintenance cycle, with values of Week.
DayOfWeekMaintenanceTime	Array of DayOfWeekObject	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. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday. 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.

EndpointObject

Parameter	Type	Example	Description
Address	Array of AddressObject	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: Enable: automatically join. Disable: do not automatically join (default).
Description	String	Primary address	Address description.
EnableReadOnly	String	Enable	Whether global read-only is enabled. Enable: Enabled. Disable: disabled.
EnableReadWriteSplitting	String	Enable	Whether read/write separation is enabled, value: Enable: enabled. Disable: disabled.
EndpointId	String	postgres-ca7b7019****	Instance ID.
EndpointName	String	Primary connection endpoint	Instance endpoint name.
EndpointType	String	Cluster	Endpoint type: Cluster: default endpoint (created by default). Custom: customized_endpoint.
ReadOnlyNodeDistributionType	String	Default	Read-only weight allocation mode. Values: Default: standard weight allocation (default value). custom: customized weight allocation.
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	Array of NodeWeightObject	[ { "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: ReadWrite: Read/write. ReadOnly: read-only.
ReadWriteProxyConnection	Integer	200	Set the number of proxy connections for the endpoint after enabling read-write separation. The minimum value of proxy connections is 20. The maximum number of proxy connections depends on the specification of the instance primary node. Different specifications support different maximum numbers of proxy connections. For details, refer to Product specification.
WriteNodeHaltWriting	Boolean	false	Whether the terminal sends write requests to the write node (currently, only the primary node is the write node). Values: yes: yes. Default value. false: no.

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: false: Default value, Volcano Engine private network resolution. true: Volcano Engine private and public network resolution.
Domain	String	postgresca7b7019****.rds-pg.ivolces.com	Connection domain name.
DomainVisibilitySetting	String	CrossRegionDomain	Private network address type. Values: LocalDomain: local domain name. CrossRegionDomain: domain name accessible across regions.
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: Private: private network connection address. Public: public network connection address. Inner: public service area address.
Port	String	5432	Port.
SubnetId	String	subnet-30uhx4w39n75s7r2qr0lq****	Subnet ID.

NodeWeightObject

Parameter	Type	Example	Description
NodeId	String	postgres-c23003b1****-ojmo	Read-only node requires passing in NodeId. tip No NodeId is needed for the primary node.
NodeType	String	Primary	Node type. Values: Primary: primary node. ReadOnly: Read-only node.
Weight	Integer	100	The read weight of the node, increasing by 100, with a maximum value of 40,000. tip Weights cannot all be set to 0.

ChargeDetailObject

Parameter	Type	Example	Description
ChargeType	String	PostPaid	Payment type. Values: PostPaid: pay-as-you-go. PrePaid: subscription (default).
AutoRenew	Boolean	true	Is automatic renewal enabled for the prepaid scenario? yes: automatic renewal. false: no automatic renewal (default).
Number	Integer	1	Number of instances.
PeriodUnit	String	Month	purchase period for prepaid scenarios. Month: monthly (default). Year: subscription.
Period	Integer	1	Subscription duration in a prepaid scenario. default value: 1.
ChargeStatus	String	Normal	Payment status. Values: Normal: normal. Overdue: overdue. Overdue: waiting for payment.
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 instance overdue shut down.
TempModifyStartTime	String	2023-12-01T10:10:10.000Z	Start time of temporary upgrade. tip Return when the instance is under temporary upgrade. If multiple consecutive temporary upgrades are performed on the instance, this returns the start time of the first temporary upgrade.
TempModifyEndTime	String	2023-12-07T10:10:09.000Z	Restoration time of temporary upgrade. tip Return when the instance is under temporary upgrade.

NodeObject

Parameter	Type	Example	Description
InstanceId	String	postgres-ca7b7019****	Instance ID.
NodeId	String	postgres-ca7b7019****-zgqy	Node ID.
RegionId	String	cn-beijing	Region ID. You can call the DescribeRegions API to query the list of available regions. Use this parameter to specify the region where you want to create the instance.
ZoneId	String	cn-beijing-a	Availability zone ID.
NodeType	String	Primary	Node type, with values: Primary: Primary node. Secondary: indicates the secondary node. ReadOnly: Read-only node.
NodeStatus	String	Running	Node status.
NodeSpec	String	rds.postgres.1c2g	Node specification.
VCPU	Integer	4	CPU size. For example: 1 means 1U.
Memory	Integer	16	Memory size. Unit is GB.
CreateTime	String	2022-01-01T10:10:10Z	Node creation time. Format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
UpdateTime	String	2022-01-01T10:10:10Z	Node update time. Format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).

Example

Sample request

Sample response

RDS for PostgreSQL