DeleteSubscriptions

Last updated: 2025-11-25 10:53:43

DeleteSubscriptions

Last updated: 2025-11-25 10:53:43

1. API Description

Domain name for API request: tdmq.intl.tencentcloudapi.com.

This API is used to delete a subscription.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DeleteSubscriptions.
Version	Yes	String	Common Params. The value used for this API: 2020-02-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
SubscriptionTopicSets.N	Yes	Array of SubscriptionTopic	Subscription set. Up to 20 subscriptions can be deleted at a time.
ClusterId	No	String	Pulsar cluster ID.
EnvironmentId	No	String	Environment (namespace) name.
Force	No	Boolean	Whether to forcibly delete a subscription. Default value: `false`.

3. Output Parameters

Parameter Name	Type	Description
SubscriptionTopicSets	Array of SubscriptionTopic	Array of successfully deleted subscriptions.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Deleting a subscription

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=DeleteSubscriptions
&SubscriptionTopicSets.0.EnvironmentId=default
&SubscriptionTopicSets.0.TopicName=sun_topic
&SubscriptionTopicSets.0.SubscriptionName=test_2_1
&<Common request parameters>

Output Example

{
    "Response": {
        "SubscriptionTopicSets": [
            {
                "EnvironmentId": "default",
                "SubscriptionName": "test_2_1",
                "TopicName": "sun_topic"
            }
        ],
        "RequestId": "cd14f283-ccb5-4b13-b858-a0a38fa6348b"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
AuthFailure.UnauthorizedOperation	CAM authentication failed.
FailedOperation	Operation failed.
FailedOperation.DeleteSubscriptions	Failed to delete the subscription.
FailedOperation.GetTopicPartitionsFailed	Failed to get the number of topic partitions.
InternalError.SystemError	System error.
InvalidParameterValue.InvalidParams	The parameter value is out of the value range.
MissingParameter.NeedMoreParams	A required parameter is missing.
OperationDenied.ConsumerRunning	Messages in the subscribed topic are being consumed.
ResourceInUse.Subscription	A subscription with the same name already exists.
ResourceNotFound.BrokerCluster	The service cluster does not exist.
ResourceNotFound.Cluster	The cluster does not exist.
ResourceNotFound.Subscription	The subscription does not exist.
ResourceNotFound.Topic	The topic does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud