云服务器内容精选

  • 按照不同的消费需求,请使用不同的构造方法 指定消费开始时间,不指定结束时间。 例如StartTimeNs = 0L,即从头开始一直拉取到当前最新。如果还有新的日志产生就一直拉取。 例如StartTimeNs = 1685444710000000000L,即从1685444710000000000纳秒所代表的时间开始拉取,一直拉取到当前最新。如果还有新的日志产生就一直拉取。 // 不设置batchSize,即每次拉取1000条 LogConsumerConfig config = new LogConsumerConfig("TEST_REGION_NAME", "TEST_PROJECT","TEST_ LOG _GROUP_ID","TEST_LOG_STREAM_ID","AC CES S_KEY_ID","ACCESS_KEY_SECRET","CONSUMER_GROUP_NAME", 1685444710000000000L); // 设置batchSize = 500,即每次拉取500条 LogConsumerConfig config = new LogConsumerConfig("TEST_REGION_NAME", "TEST_PROJECT","TEST_LOG_GROUP_ID","TEST_LOG_STREAM_ID","ACCESS_KEY_ID","ACCESS_KEY_SECRET","CONSUMER_GROUP_NAME", 1685444710000000000L, 500); /* 如果需要按照日志组/日志流名称消费,此功能仅1.0.3版本以上才支持 LogConsumerConfig config = new LogConsumerConfig("TEST_REGION_NAME", "TEST_PROJECT","TEST_LOG_GROUP_NAME","TEST_LOG_STREAM_NAME", true ,"ACCESS_KEY_ID","ACCESS_KEY_SECRET","CONSUMER_GROUP_NAME", 1685444710000000000L, 500); */ 指定消费开始时间,且指定结束时间。 例如StartTimeNs = 0L,EndTimeNs=1685444710000000000L。即从头开始一直拉取到EndTimeNs所代表的时间。不会拉取这段时间范围以外的数据。 例如StartTimeNs = 1685444710000000000L,EndTimeNs=1685445470192043318L。即从StartTimeNs所代表的时间开始一直拉取到EndTimeNs所代表的时间。不会拉取这段时间范围以外的数据。 // 不设置batchSize,即每次拉取1000条 LogConsumerConfig config = new LogConsumerConfig("TEST_REGION_NAME", "TEST_PROJECT","TEST_LOG_GROUP_ID","TEST_LOG_STREAM_ID","ACCESS_KEY_ID","ACCESS_KEY_SECRET","CONSUMER_GROUP_NAME",1685444710000000000L, 1685445470192043318L); // 设置batchSize = 500,即每次拉取500条 LogConsumerConfig config = new LogConsumerConfig("TEST_REGION_NAME", "TEST_PROJECT","TEST_LOG_GROUP_ID","TEST_LOG_STREAM_ID","ACCESS_KEY_ID","ACCESS_KEY_SECRET","CONSUMER_GROUP_NAME",1685444710000000000L, 1685445470192043318L, 500); /* 如果需要按照日志组/日志流名称消费,此功能仅1.0.3版本以上才支持 LogConsumerConfig config = new LogConsumerConfig("TEST_REGION_NAME", "TEST_PROJECT","TEST_LOG_GROUP_NAME","TEST_LOG_STREAM_NAME", true ,"ACCESS_KEY_ID","ACCESS_KEY_SECRET","CONSUMER_GROUP_NAME",1685444710000000000L, 1685445470192043318L, 500); */
  • 响应示例 状态码: 200 查询实例集群的消费组信息成功。 { "group" : { "members" : [ { "host" : "/172.31.1.102", "assignment" : [ { "topic" : "test", "partitions" : [ 0, 1, 2 ] } ], "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785", "client_id" : "consumer-1" } ], "state" : "STABLE", "group_id" : "test-consumer-group", "coordinator_id" : 2, "group_message_offsets" : [ { "partition" : 0, "lag" : 31396, "topic" : "test", "message_current_offset" : 935, "message_log_end_offset" : 32331 }, { "partition" : 0, "lag" : 0, "topic" : "aaaa", "message_current_offset" : 0, "message_log_end_offset" : 0 }, { "partition" : 1, "lag" : 31279, "topic" : "test", "message_current_offset" : 1058, "message_log_end_offset" : 32337 }, { "partition" : 1, "lag" : 0, "topic" : "aaaa", "message_current_offset" : 0, "message_log_end_offset" : 0 }, { "partition" : 2, "lag" : 31603, "topic" : "test", "message_current_offset" : 739, "message_log_end_offset" : 32342 } ], "assignment_strategy" : "range" } }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 [数组元素] Array of ShowGroupResp objects 查询实例集群的消费组信息成功。 表3 ShowGroupResp 参数 参数类型 描述 group Array of ShowGroupEntity objects 消费组信息。 表4 ShowGroupEntity 参数 参数类型 描述 group_id String 消费组的名称。 state String 消费组状态。包含以下状态: Dead:消费组内没有任何成员,且没有任何元数据。 Empty:消费组内没有任何成员,存在元数据。 PreparingRebalance:准备开启rebalance。 CompletingRebalance:所有成员加入group。 Stable:消费组内成员可正常消费。 coordinator_id Integer 协调器编号。 members Array of MemberEntity objects 消费者列表。 group_message_offsets Array of GroupMessageOffsetsEntity objects 消费进度。 assignment_strategy String 分区分配策略。 表5 MemberEntity 参数 参数类型 描述 host String 消费组consumer地址。 assignment Array of AssignmentEntity objects consumer分配到的分区信息。 member_id String 消费组consumer的ID。 client_id String 客户端ID。 表6 AssignmentEntity 参数 参数类型 描述 topic String Topic名称。 partitions Array of integers 分区列表。 表7 GroupMessageOffsetsEntity 参数 参数类型 描述 partition Integer 分区编号。 lag Integer 剩余可消费消息数,即消息堆积数。 topic String Topic名称。 message_current_offset Integer 当前消费进度。 message_log_end_offset Integer 最大消息位置(LEO)。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 failed_groups Array of FailedGroupsEntity objects 删除失败的消费组列表。 total Integer 删除失败的个数。 表4 FailedGroupsEntity 参数 参数类型 描述 group_id String 删除失败的消费组ID。 error_message String 删除失败的原因。
  • 响应示例 状态码: 200 查询消费组成功。 { "total" : 1, "groups" : [ { "enabled" : true, "broadcast" : false, "brokers" : [ "broker-0" ], "name" : "aaaaa", "retry_max_time" : 16, "from_beginning" : false } ], "max" : 4000, "remaining" : 3999, "next_offset" : -1, "previous_offset" : -1 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Number 消费组总数。 groups Array of ConsumerGroup objects 消费组列表。 max Number 最大可创建消费组数量。 remaining Number 剩余可创建消费组数量。 next_offset Number 下个分页的offset。 previous_offset Number 上个分页的offset。 表4 ConsumerGroup 参数 参数类型 描述 enabled Boolean 是否可以消费。 broadcast Boolean 是否广播。 brokers Array of strings 关联的代理列表。 name String 消费组名称,只能由英文字母、数字、百分号、竖线、中划线、下划线组成,长度3~64个字符。 group_desc String 消费组描述,长度0~200个字符。 最小长度:0 最大长度:200 retry_max_time Number 最大重试次数,取值范围为1~16。 from_beginning Boolean 是否重头消费。
  • URI GET /v2/{project_id}/instances/{instance_id}/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 group 否 String 消费组名称。 limit 否 Integer 查询数量。 缺省值:10 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 缺省值:0
  • URI GET /v2/{project_id}/queues/{queue_id}/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 queue_id 是 String 指定的队列ID 表2 Query参数 参数 是否必选 参数类型 描述 include_deadletter 否 Boolean 是否包含死信信息。默认值为:false include_messages_num 否 Boolean 是否查询消费组的详情,默认值为true。 配置为false时,查询的消费组列表不包含消费详情,接口响应速度快。 page_size 否 Integer 设置每页显示的消费组数量。 page_size和current_page必须同时配置有效值,否则默认查询所有消费组。 current_page 否 Integer 设置查询消费组的页码。 page_size和current_page必须同时配置有效值,否则默认查询所有消费组。
  • 响应示例 状态码: 200 获取信息成功。 { "queue_id" : "f5b6dd28-08dd-4f0f-866c-2eadf6788163", "queue_name" : "queue-772289871", "groups" : [ { "name" : "group-1690260950", "id" : "g-eb9305bb-5bec-4712-84ab-0a36fbe9c2c0", "consumed_messages" : 0, "available_messages" : 8, "produced_messages" : 10 } ], "redrive_policy" : "enable"}