Domain name for API request: tdmq.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.
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 | No | String | Common Params. This parameter is not required for this API. |
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. |
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, which is returned for each request. RequestId is required for locating a problem. |
https://tdmq.tencentcloudapi.com/?Action=AcknowledgeMessage
&AckTopic=tenant/namespace/topic
&MessageId="71:12:0"
&SubName="test-sub"
&<Common request parameters>
{
"Response": {
"RequestId": "36713f94-d07d-4b96-babf-42d139276f23",
"ErrorMsg": "xxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?