DescribeSlots - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries all replication slots of an instance.

Operation description

Supported database engines

PostgreSQL

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeSlots	Read	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.	ETnLKlblzczshOTUbOC****
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.	pgm-bp102g323jd4****
ResourceGroupId	string	No	The resource group ID. You can leave this parameter empty.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	76AF0609-4195-5DFC-BC78-3AD76FF872BB
Slots	object []	The information about the replication slot.
SlotName	string	The replication slot name.	slot_test01
Plugin	string	The extension used by the replication slot.	test_decoding
SlotType	string	The replication slot type. Valid values: physical logical	logical
Database	string	The name of the database in which the replication slot resides.	db_test01
Temporary	string	Indicates whether the replication slot is a temporary replication slot. Valid values: true false	false
SlotStatus	string	The replication slot status. Valid values: ACTIVE INACTIVE	INACTIVE
WalDelay	string	The number of logs accumulated in the replication slot.	16 MB
SubReplayLag	string	The latency of the logical subscription on the subscriber node that corresponds to the current replication slot. Unit: seconds.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "76AF0609-4195-5DFC-BC78-3AD76FF872BB",
  "Slots": [
    {
      "SlotName": "slot_test01",
      "Plugin": "test_decoding",
      "SlotType": "logical",
      "Database": "db_test01",
      "Temporary": "false",
      "SlotStatus": "INACTIVE",
      "WalDelay": "16 MB",
      "SubReplayLag": "0"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	The instance name does not exist.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-08-14

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Output Parameters	The response structure of the API has changed.

2023-04-10

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: DBInstanceId
	Added Input Parameters: ResourceGroupId
	delete Input Parameters: DBInstanceName