Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Publications and Subscriptions (RDS for SQL Server)/ Deleting Subscriptions
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Deleting Subscriptions

Function

This API is used to delete subscriptions from a DB instance.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:update

write

-

-

rds:instance:modify

-

URI

  • URI format

    DELETE /v3/{project_id}/instances/{instance_id}/replication/subscriptions

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Description

subscription_ids

Yes

Array of strings

Definition

IDs of subscriptions to delete.

Constraints

The subscriptions to delete must belong to the same instance.

Range

N/A

Default Value

N/A

clean_subscription

No

Boolean

Definition

Whether to clear subscription configurations.

Constraints

N/A

Range

  • true: Clean up subscription configurations.
  • false: Do not clean up subscription configurations.

Default Value

false

Example Request

Delete subscriptions from a DB instance.

DELETE https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/subscriptions

{
    "subscription_ids": [
        "5dafb44b-85ac-46b0-ae8b-a7b95c79bb1c"
    ],
    "clean_subscription": false
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

    Task ID.

    Range

    N/A
  • Example normal response 
    {
    "job_id": "ad1a17bc-7ee2-4756-89c5-c2ef605f3265"
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.