Appearance
Query Subscription List
API Address:/v2/quecrule/{version}/openapi/subscribe/list
Request Method:POST
Request Data Type:application/json
Response Data Type:*/*
API Description:Subscription list
Request Example:
javascript
{
"pageNum": 1,
"pageSize": 10,
"queueName": "testQueue",
"status": 1,
"subscribeName": "test"
}Request Parameters:
| Parameter Name | Parameter Description | Request Type | Required | Data Type | Schema |
|---|---|---|---|---|---|
| subscribeDTO | Query parameters | body | true | OpenApiQuerySubscribeDTO | OpenApiQuerySubscribeDTO |
| pageNum | Page number, starting from 1 | false | integer(int32) | ||
| pageSize | Number of items per page, range 1~100 | false | integer(int32) | ||
| queueName | Queue name | false | string | ||
| status | Status, 0-Not started 1-Running | false | integer(int32) | ||
| subscribeName | Subscription name | false | string | ||
| version | Current version, valid value:r1 | path | true | string |
Response Status:
| Status Code | Description | Schema |
|---|---|---|
| 200 | OK | ActionResultOfListOfSubscribeRuleDTO |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 50000 | Service exception | |
| 50005 | Parameter check error | |
| 70060 | Permission Denied | |
| 91004 | Token incorrect | |
| 91005 | Doesn't have permission |
Response Parameters:
| Parameter Name | Parameter Description | Type | Schema |
|---|---|---|---|
| code | Return code | integer(int32) | integer(int32) |
| data | Object | array | SubscribeRuleDTO |
| createTime | Creation time | string(date-time) | |
| projectId | Project ID | integer(int64) | |
| projectName | Project name | string | |
| queueId | Queue ID | string | |
| queueName | Queue name | string | |
| status | Subscription status | integer(int32) | |
| subscribeId | Subscription ID | integer(int64) | |
| subscribeLevel | Message subscription level: 1-Product level 3-Device level 6-SaaS level | integer(int32) | |
| subscribeName | Subscription name | string | |
| msg | Prompt message | string | |
| pageNum | Current page number | integer(int32) | integer(int32) |
| pageSize | Items per page | integer(int32) | integer(int32) |
| pages | Total pages | integer(int32) | integer(int32) |
| total | Total count | integer(int32) | integer(int32) |
Response Example:
javascript
{
"code": 0,
"data": [
{
"createTime": 1623814212000,
"projectId": 0,
"projectName": "",
"queueId": "",
"queueName": "",
"status": 0,
"subscribeId": 0,
"subscribeLevel": 0,
"subscribeName": ""
}
],
"msg": "",
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"total": 0
}