API Introduction
Used to query topic status.
API Restrictions
None.
URl
GET https://[endpoint].ctapi.ctyun.cn/v2/topic/status
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 data
Response Parameter | Parameter Type | Description |
perm | Integer | Topic Permission |
totalCount | Long | Total Number of Messages |
lastTimeStamp | Long | Last Updated Timestamp (ms) |
Sample Request
GET https://[endpoint].ctapi.ctyun.cn/v2/topic/status?prodInstId=70687660456281088&topicName=test
Examples of a Successful Response
{
"returnObj":{
"data":{
"perm":7,
"totalCount":27,
"lastTimeStamp":1661857434599
}
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}