Call the DescribeSlots API to query the replication slots of the instance.

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-96138f57****	ID of the instance to which the replication slot belongs.
SlotName	String	No	ExampleOfSlotName	Name of the replication slot to query. tip Default value: none. Returns all query results under other parameter-restricted query conditions if this field is not passed.
SlotType	String	No	logical	Types of replication slots. Values: physical: physical replication slot. logical: logical replication slot. tip No default value. Returns all query results under other parameter-restricted query conditions if this field is not passed.
Plugin	String	No	pgoutput	Name of the extension used by the logical replication slot to parse WAL logs. tip When slottype is physical, no value needs to be passed for this field. Default value. If this field is not provided, all results under the query conditions limited by other parameters will be returned.
Database	String	No	postgres	Database where the replication slot is located. tip When SlotType is physical, no value is needed for this field. Default value. If this field is not provided, all results under the query conditions limited by other parameters will be returned.
Temporary	Boolean	No	true	Whether it is a temporary copy slot. Values: true: yes. false: no. tip Default value. when this field is not passed, return all query results under the query conditions limited by other parameters.
SlotStatus	String	No	ACTIVE	Status of replication slot. Values: ACTIVE: active. INACTIVE: inactive. tip Default value. Returns all query results under other parameter-restricted query conditions if this field is not passed.
IPAddress	String	No	10.xxx.xxx.1	IP address.

Response parameter

Parameter	Type	Example	Description
Total	Integer	3	Quantity of replication slots for the instance.
ReplicationSlots	Array of ReplicationSlotObject	Refer to the sample response.	Slots for copying specified by query conditions in the instance.

ReplicationSlotObject

Parameter	Type	Example	Description
SlotName	String	Slot000003	Slot name.
SlotType	String	logical	Types of replication slots. Values: physical: physical replication slot. logical: logical replication slot.
Plugin	String	pgoutput	Extension name used with the logical replication slot to parse WAL logs. tip When slotType is physical, this field returnsnull。
Database	String	postgres	Database where the copy slot resides. tip When SlotType is set to physical, this field returnsnull。
Temporary	Boolean	false	Whether it is a temporary copy slot. Values: true: yes. false: no.
SlotStatus	String	INACTIVE	Status of replication slot. Values: ACTIVE: active. INACTIVE: inactive.
WalDelay	Long	50327736	The accumulated WAL logs corresponding to the replication slots. Unit: Byte.
IPAddress	String	10.xxx.xxx.1	IP address. tip Only active replication slots have IP addresses.

Example

Sample request

Sample response

RDS for PostgreSQL