Exporting Dead Letter Messages
Function
This API is used to export dead letter messages.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/instances/{instance_id}/messages/export
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
topic |
No |
String |
Topic name. |
msg_id_list |
No |
Array of strings |
Message ID list. |
uniq_key_list |
No |
Array of strings |
Unique key list. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of Message objects |
Message. |
Parameter |
Type |
Description |
---|---|---|
msg_id |
String |
Message ID. |
instance_id |
String |
Instance ID. |
topic |
String |
Topic name. |
store_timestamp |
Number |
Time when the message is stored. |
born_timestamp |
Number |
Time when the message is generated. |
reconsume_times |
Integer |
Number of retry times. |
body |
String |
Message body. |
body_crc |
Number |
Message body checksum. |
store_size |
Number |
Storage size. |
property_list |
Array of property_list objects |
Message attribute list. |
born_host |
String |
IP address of the host that generates the message. |
store_host |
String |
IP address of the host that stores the message. |
queue_id |
Integer |
Queue ID. |
queue_offset |
Integer |
Offset in the queue. |
Example Requests
Exporting dead letter messages with the specified message IDs and keys in the topic
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages/export { "topic" : "%DLQ%group1", "msg_id_list" : [ "C0A8011700002774000000000013B19D", "C0A8011700002774000000000013B30F" ], "uniq_key_list" : [ "7F000001001C18B4AAC26B8AED170010", "7F000001001C18B4AAC26B8AEE030015" ] }
Example Responses
Status code: 200
Dead letter messages exported successfully.
{ "topic" : "topic_01", "body" : "Hello world", "property_list" : { "name" : "ORIGIN_MESSAGE_ID", "value" : "C0A8005B00002775000000000000EBAE" }, "msg_id" : "C0A8005B0000277500000000000133A2", "instance_id" : "56055acb-3c3b-4481-aeab-10464086c2b4", "store_timestamp" : 1662690563020, "born_timestamp" : 1662690324415, "reconsume_times" : 5, "body_crc" : 198614610, "store_size" : 317, "born_host" : "10.58.233.224:63529", "store_host" : "192.168.0.91:10101", "queue_id" : 0, "queue_offset" : 0 }
SDK Sample Code
The SDK sample code is as follows.
Exporting dead letter messages with the specified message IDs and keys in the topic
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 59 60 61 |
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 ExportDlqMessageSolution { 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(); ExportDlqMessageRequest request = new ExportDlqMessageRequest(); request.withInstanceId("{instance_id}"); ExportDlqMessageReq body = new ExportDlqMessageReq(); List<String> listbodyUniqKeyList = new ArrayList<>(); listbodyUniqKeyList.add("7F000001001C18B4AAC26B8AED170010"); listbodyUniqKeyList.add("7F000001001C18B4AAC26B8AEE030015"); List<String> listbodyMsgIdList = new ArrayList<>(); listbodyMsgIdList.add("C0A8011700002774000000000013B19D"); listbodyMsgIdList.add("C0A8011700002774000000000013B30F"); body.withUniqKeyList(listbodyUniqKeyList); body.withMsgIdList(listbodyMsgIdList); body.withTopic("%DLQ%group1"); request.withBody(body); try { ExportDlqMessageResponse response = client.exportDlqMessage(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()); } } } |
Exporting dead letter messages with the specified message IDs and keys in the topic
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 |
# 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 = ExportDlqMessageRequest() request.instance_id = "{instance_id}" listUniqKeyListbody = [ "7F000001001C18B4AAC26B8AED170010", "7F000001001C18B4AAC26B8AEE030015" ] listMsgIdListbody = [ "C0A8011700002774000000000013B19D", "C0A8011700002774000000000013B30F" ] request.body = ExportDlqMessageReq( uniq_key_list=listUniqKeyListbody, msg_id_list=listMsgIdListbody, topic="%DLQ%group1" ) response = client.export_dlq_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) |
Exporting dead letter messages with the specified message IDs and keys in the topic
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 |
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.ExportDlqMessageRequest{} request.InstanceId = "{instance_id}" var listUniqKeyListbody = []string{ "7F000001001C18B4AAC26B8AED170010", "7F000001001C18B4AAC26B8AEE030015", } var listMsgIdListbody = []string{ "C0A8011700002774000000000013B19D", "C0A8011700002774000000000013B30F", } topicExportDlqMessageReq:= "%DLQ%group1" request.Body = &model.ExportDlqMessageReq{ UniqKeyList: &listUniqKeyListbody, MsgIdList: &listMsgIdListbody, Topic: &topicExportDlqMessageReq, } response, err := client.ExportDlqMessage(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 |
Dead letter messages exported successfully. |
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