API Introduction
Used to query the resettable time range for a topic.
API Restrictions
None.
URl
GET https://[endpoint]/v2/consumer/timeSpan
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
topicName | Yes | url | String | Topic Name |
Response Parameter
Response Parameter | Parameter Type | Description |
statusCode | String | The status code of the interface on the system layer. Success: 800; failure: 900. |
message | String | Status Description |
returnObj | String | Return the object. The parameters included in this parameter are described in the comments in Response Examples. |
Description of Return Value returnObj
Response Parameter | Parameter Type | Description |
data | Json | Information of the resettable time range |
Description of Return Value data
Response Parameter | Parameter Type | Description |
tenantId | String | Tenant ID |
clusterName | String | Instance ID |
topicName | String | Topic Name |
minTimeStamp | Long | Min Timestamp, in milliseconds. |
maxTimeStamp | Long | Max Timestamp, in milliseconds. |
Sample Request
GET https://[endpoint]/v2/consumer/timeSpan?prodInstId=70687660456281088&topicName=test
Examples of a Successful Response
{
"returnObj":{
"data":{
"tenantId":"2147483647",
"clusterName":"mq_test",
"topicName":"test",
"minTimeStamp":1660548910643,
"maxTimeStamp":1661857434591
}
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}