All Products
Search
Document Center

ApsaraDB RDS:DeleteSlot

Last Updated:Apr 28, 2024

Deletes a replication slot of an instance.

Operation description

Supported database engine

  • PostgreSQL

Precautions

You can delete a replication slot only when the status of the slot is INACTIVE. You can call the DescribeSlots operation to query the status of a replication slot.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DeleteSlotWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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****
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

pgm-bp102g323jd4****
SlotNamestringYes

The name of the replication slot. You can call the DescribeSlots operation to query the name of the replication slot.

slot_test01
SlotStatusstringYes

The status of the replication slot. You can call the DescribeSlots operation to query the status of the replication slot. Valid values:

  • ACTIVE
  • INACTIVE
INACTIVE
ResourceGroupIdstringNo

The ID of the resource group. You can leave this parameter empty.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

2875D608-A228-53D7-B8C9-35F13EDCF36D
SlotNamestring

The name of the replication slot.

slot_test01

Examples

Sample success responses

JSONformat

{
  "RequestId": "2875D608-A228-53D7-B8C9-35F13EDCF36D",
  "SlotName": "slot_test01"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
400InvalideStatus.FormatSpecified Status is not valid.-
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.

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

Change history

Change timeSummary of changesOperation
2023-04-10The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DBInstanceId
    Added Input Parameters: ResourceGroupId
    delete Input Parameters: DBInstanceName