查看App消费状态
功能介绍
本接口用于查询APP消费状态。
URI
GET /v2/{project_id}/apps/{app_name}/streams/{stream_name}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
app_name |
是 |
String |
需要查询的App名称。 |
stream_name |
是 |
String |
需要查询的通道名称。 最大长度:60 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
单次请求返回的最大分区数。最小值是1,最大值是1000;默认值是100。 最小值:1 最大值:1000 缺省值:100 |
start_partition_id |
否 |
String |
从该分区值开始返回分区列表,返回的分区列表不包括此分区。 |
checkpoint_type |
是 |
String |
Checkpoint类型。
枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
app_name |
String |
App的名称。 |
app_id |
String |
App的唯一标识符。 |
create_time |
Long |
App创建的时间,单位毫秒。 |
commit_checkpoint_stream_names |
Array of strings |
关联通道列表。 |
请求示例
查询App消费状态
GET https://{Endpoint}/v2/{project_id}/apps/{app_name}/streams/{stream_name}
响应示例
状态码: 200
正常返回
{ "stream_name" : "newstream", "app_name" : "newapp", "partition_consuming_states" : [ { "partition_id" : "2", "sequence_number" : "485", "latest_offset" : "1000", "earliest_offset" : "10", "checkpoint_type" : "LAST_READ" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
正常返回 |
错误码
请参见错误码。