tencent cloud

All product documents
APIs
DocumentationAPIsTDMQ for Apache PulsarMessage APIsAcknowledgeMessage
AcknowledgeMessage
Last updated: 2024-11-27 16:57:11
AcknowledgeMessage
Last updated: 2024-11-27 16:57:11

1. API Description

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

This API is used to acknowledge the message in the specified topic by the provided MessageID.

A maximum of 1000 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: AcknowledgeMessage.
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-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
MessageId Yes String Unique ID used to identify the message, which can be obtained from the returned value of receiveMessage.
AckTopic Yes String Topic name, which can be obtained from the returned value of receiveMessage and is better to be the full path of the topic, such as tenant/namespace/topic. If it is not specified, public/default will be used by default.
SubName Yes String Subscriber name, which can be obtained from the returned value of receiveMessage. Make sure that it is the same as the subscriber name identified in receiveMessage; otherwise, the received message cannot be correctly acknowledged.

3. Output Parameters

Parameter Name Type Description
ErrorMsg String If it is an empty string, no error occurred.
Note: this field may return null, indicating that no valid values can be obtained.
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 Acknowledging message

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=AcknowledgeMessage
&AckTopic=tenant/namespace/topic
&MessageId="71:12:0"
&SubName="test-sub"
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "36713f94-d07d-4b96-babf-42d139276f23",
        "ErrorMsg": "xxx"
    }
}

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

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
FailedOperation.CreateProducerError An error occurred while creating the producer.
FailedOperation.CreatePulsarClientError An error occurred while creating the TDMQ client.
FailedOperation.MaxMessageSizeError The message size exceeds the upper limit of 1 MB.
FailedOperation.MessageIDError The uploaded msgID is incorrect.
FailedOperation.ReceiveError An error occurred while receiving the message.
FailedOperation.ReceiveTimeout Message receiving timed out. Please try again.
FailedOperation.TopicTypeError Please use a partition topic.
InvalidParameter.TenantNotFound The uploaded tenant name is incorrect.
InvalidParameter.TokenNotFound The correct token was not obtained.
InvalidParameterValue.TopicNotFound The uploaded topic name is incorrect.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon