Verifying Consumption
Function
This API is used to verify consumption.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{engine}/{project_id}/instances/{instance_id}/messages/resend
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
engine |
Yes |
String |
Definition Message engine. Constraints N/A Range N/A Default Value reliability |
|
project_id |
Yes |
String |
Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value reliability |
|
instance_id |
Yes |
String |
Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
group |
Yes |
String |
Definition Group ID. Constraints N/A Range N/A Default Value N/A |
|
topic |
No |
String |
Definition Topic to which a message belongs. Constraints N/A Range N/A Default Value N/A |
|
client_id |
Yes |
String |
Definition Client ID. Constraints N/A Range N/A Default Value N/A |
|
msg_id_list |
No |
Array of strings |
Definition Message list. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
resend_results |
Array of resend_results objects |
Definition Consumption verification result. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
msg_id |
String |
Definition Message ID. Constraints N/A Range N/A Default Value N/A |
|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
|
error_message |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Example Requests
Verifying consumption
POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/messages/resend
{
"group" : "GID_test",
"client_id" : "192.168.0.1",
"msg_id_list" : [ "id1" ]
}
Example Responses
Status code: 200
Consumption verified.
{
"resend_results" : [ {
"msg_id" : "C0A8149E0000277600000000000B6835",
"error_code" : "DMS.00000000",
"error_message" : "Success."
} ]
}
SDK Sample Code
The SDK sample code is as follows.
Verifying consumption
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; import java.util.List; import java.util.ArrayList; public class ValidateConsumedMessageSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("<YOUR REGION>")) .build(); ValidateConsumedMessageRequest request = new ValidateConsumedMessageRequest(); request.withEngine(ValidateConsumedMessageRequest.EngineEnum.fromValue("{engine}")); request.withInstanceId("{instance_id}"); ResendReq body = new ResendReq(); List<String> listbodyMsgIdList = new ArrayList<>(); listbodyMsgIdList.add("id1"); body.withMsgIdList(listbodyMsgIdList); body.withClientId("192.168.0.1"); body.withGroup("GID_test"); request.withBody(body); try { ValidateConsumedMessageResponse response = client.validateConsumedMessage(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Verifying consumption
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \ .build() try: request = ValidateConsumedMessageRequest() request.engine = "{engine}" request.instance_id = "{instance_id}" listMsgIdListbody = [ "id1" ] request.body = ResendReq( msg_id_list=listMsgIdListbody, client_id="192.168.0.1", group="GID_test" ) response = client.validate_consumed_message(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Verifying consumption
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := rocketmq.NewRocketMQClient( rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ValidateConsumedMessageRequest{} request.Engine = model.GetValidateConsumedMessageRequestEngineEnum().ENGINE request.InstanceId = "{instance_id}" var listMsgIdListbody = []string{ "id1", } request.Body = &model.ResendReq{ MsgIdList: &listMsgIdListbody, ClientId: "192.168.0.1", Group: "GID_test", } response, err := client.ValidateConsumedMessage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Consumption verified. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot