查询消息
功能介绍
查询消息的偏移量和消息内容。
先根据时间戳查询消息的偏移量,再根据偏移量查询消息内容。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/messages
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
topic |
是 |
String |
参数解释: Topic名称。 约束限制: Topic名称必须以字母开头且只支持大小写字母、中横线、下划线以及数字。 取值范围: 不涉及。 默认取值: 不涉及。 |
asc |
否 |
Boolean |
参数解释: 是否按照时间排序。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
start_time |
否 |
String |
参数解释: 开始时间。 Unix毫秒时间戳。 约束限制: 查询消息偏移量时,为必选参数。 取值范围: 不涉及。 默认取值: 不涉及。 |
end_time |
否 |
String |
参数解释: 结束时间。 Unix毫秒时间戳。 约束限制: 查询消息偏移量时,为必选参数。 取值范围: 不涉及。 默认取值: 不涉及。 |
limit |
否 |
String |
参数解释: 每一页显示的消息数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
offset |
否 |
String |
参数解释: 页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
download |
否 |
Boolean |
参数解释: 是否下载消息到本地。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
message_offset |
否 |
String |
参数解释: 消息偏移量。 约束限制: 查询消息内容时,为必选参数。 若start_time、end_time参数不为空,该参数无效。 取值范围: 不涉及。 默认取值: 不涉及。 |
partition |
否 |
String |
参数解释: 分区。 约束限制: 查询消息内容时,为必选参数。 若start_time、end_time参数不为空,该参数无效。 取值范围: 不涉及。 默认取值: 不涉及。 |
keyword |
否 |
String |
参数解释: 设置查询消息的关键词。 约束限制: 不涉及。 取值范围: 0~50字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
messages |
Array of MessagesEntity objects |
参数解释: 消息列表。 |
total |
Long |
参数解释: 消息总条数。 取值范围: 不涉及。 |
size |
Long |
参数解释: 每页消息条数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
topic |
String |
参数解释: Topic名称。 取值范围: 不涉及。 |
partition |
Integer |
参数解释: 消息所在的分区。 取值范围: 不涉及。 |
key |
String |
参数解释: 消息key。 取值范围: 不涉及。 |
value |
String |
参数解释: 消息内容。 取值范围: 不涉及。 |
size |
Integer |
参数解释: 消息大小。 取值范围: 不涉及。 |
timestamp |
Long |
参数解释: 生产消息的时间。 格式为Unix时间戳。单位为毫秒。 取值范围: 不涉及。 |
huge_message |
Boolean |
参数解释: 大数据标识。 取值范围: 不涉及。 |
message_offset |
Long |
参数解释: 消息偏移量。 取值范围: 不涉及。 |
message_id |
String |
参数解释: 消息ID。 取值范围: 不涉及。 |
app_id |
String |
参数解释: 应用ID。 取值范围: 不涉及。 |
tag |
String |
参数解释: 消息标签。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
-
查询消息偏移量。
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages?asc=false&end_time=1608609032042&limit=10&offset=0&start_time=1608608432042&topic=topic-test
-
查询消息内容。
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages?download=false&message_offset=0&partition=0&topic=topic-test
响应示例
状态码:200
查询成功。
{ "messages" : [ { "topic" : "topic-test", "partition" : 0, "value" : "hello world", "size" : 21, "timestamp" : 1607598463502, "huge_message" : false, "message_offset" : 4, "message_id" : "", "app_id" : "", "tag" : "" } ], "total" : 1, "size" : 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 |
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.kafka.v2.region.KafkaRegion; import com.huaweicloud.sdk.kafka.v2.*; import com.huaweicloud.sdk.kafka.v2.model.*; public class ShowInstanceMessagesSolution { 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); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("<YOUR REGION>")) .build(); ShowInstanceMessagesRequest request = new ShowInstanceMessagesRequest(); request.withInstanceId("{instance_id}"); try { ShowInstanceMessagesResponse response = client.showInstanceMessages(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkafka.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 = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowInstanceMessagesRequest() request.instance_id = "{instance_id}" response = client.show_instance_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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/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 := kafka.NewKafkaClient( kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowInstanceMessagesRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowInstanceMessages(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询成功。 |
400 |
参数无效。 |
403 |
鉴权失败。 |
错误码
请参见错误码。