导出死信消息
功能介绍
导出死信消息。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/instances/{instance_id}/messages/export
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
topic |
否 |
String |
主题名称。 |
msg_id_list |
否 |
Array of strings |
消息ID列表。 |
uniq_key_list |
否 |
Array of strings |
唯一Key列表。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of Message objects |
消息。 |
参数 |
参数类型 |
描述 |
---|---|---|
msg_id |
String |
消息ID。 |
instance_id |
String |
实例ID。 |
topic |
String |
主题名称。 |
store_timestamp |
Number |
存储消息的时间。 |
born_timestamp |
Number |
产生消息的时间。 |
reconsume_times |
Integer |
重试次数。 |
body |
String |
消息体。 |
body_crc |
Number |
消息体校验和。 |
store_size |
Number |
存储大小。 |
property_list |
Array of property_list objects |
消息属性列表。 |
born_host |
String |
产生消息的主机IP。 |
store_host |
String |
存储消息的主机IP。 |
queue_id |
Integer |
队列ID。 |
queue_offset |
Integer |
在队列中的偏移量。 |
请求示例
导出主题中指定消息ID和Key的死信消息。
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages/export { "topic" : "%DLQ%group1", "msg_id_list" : [ "C0A8011700002774000000000013B19D", "C0A8011700002774000000000013B30F" ], "uniq_key_list" : [ "7F000001001C18B4AAC26B8AED170010", "7F000001001C18B4AAC26B8AEE030015" ] }
响应示例
状态码: 200
导出死信消息成功。
{ "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代码示例
SDK代码示例如下。
导出主题中指定消息ID和Key的死信消息。
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()); } } } |
导出主题中指定消息ID和Key的死信消息。
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) |
导出主题中指定消息ID和Key的死信消息。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
导出死信消息成功。 |
错误码
请参见错误码。