更新时间:2024-07-05 GMT+08:00

查询消息

功能介绍

查询消息。

调用方法

请参见如何调用API

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

消息引擎。

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

topic

String

主题名称。

limit

String

查询数量。

offset

String

偏移量,表示从此偏移量开始查询, offset大于等于0。

key

String

消息的key。

start_time

String

开始时间(不通过msg_id精确查询消息时,此参数必填)。

end_time

String

结束时间(不通过msg_id精确查询消息时,此参数必填)。

msg_id

String

消息ID。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

messages

Array of Message objects

消息列表。

total

Number

消息总数。

表4 Message

参数

参数类型

描述

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

在队列中的偏移量。

表5 property_list

参数

参数类型

描述

name

String

属性名称。

value

String

属性值。

请求示例

查询消息。

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/messages?topic={topic}

响应示例

状态码: 200

查询消息成功。

{
  "messages" : [ {
    "msg_id" : "C0A807C9000027740000000000000030",
    "instance_id" : "11c45539-xxxx-xxxx-xxxx-812c41f61f30",
    "topic" : "topic-test",
    "store_timestamp" : 1648888166319,
    "born_timestamp" : 1648888166275,
    "reconsume_times" : 0,
    "body" : "xxxx",
    "body_crc" : 1932557065,
    "store_size" : 175,
    "property_list" : [ {
      "name" : "KEYS",
      "value" : ""
    }, {
      "name" : "UNIQ_KEY",
      "value" : "7F00000123DC6E0BE85808B037820000"
    }, {
      "name" : "CLUSTER",
      "value" : "DmsCluster"
    }, {
      "name" : "TAGS",
      "value" : ""
    } ],
    "born_host" : "192.168.0.66:50098",
    "store_host" : "192.168.7.201:10100",
    "queue_id" : 2,
    "queue_offset" : 0
  } ],
  "total" : 1
}

SDK代码示例

SDK代码示例如下。

 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
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.*;


public class ListMessagesSolution {

    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();
        ListMessagesRequest request = new ListMessagesRequest();
        request.withEngine(ListMessagesRequest.EngineEnum.fromValue("{engine}"));
        request.withInstanceId("{instance_id}");
        try {
            ListMessagesResponse response = client.listMessages(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());
        }
    }
}
 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
# 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 = ListMessagesRequest()
        request.engine = "{engine}"
        request.instance_id = "{instance_id}"
        response = client.list_messages(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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.ListMessagesRequest{}
	request.Engine = model.GetListMessagesRequestEngineEnum().ENGINE
	request.InstanceId = "{instance_id}"
	response, err := client.ListMessages(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询消息成功。

错误码

请参见错误码