可视化-数据订阅 Open API

订阅资源（Subscription）：Subscription 描述一个完整的订阅配置。

用于获取有权限的仪表盘订阅配置列表。项目管理员、系统管理员能获取所有订阅；仪表盘管理员能获取仪表盘的所有订阅；其他权限能获取创建人、接收人、权限依据人为本人的订阅。

3.1 请求

GET /aeolus/api/open/v2/subscription/subscriptions

3.2 请求头

3.3 请求参数

3.4 响应

3.5 响应示例

{
    "code":"aeolus/ok",
    "data":{
        "pageNumber":20,
        "pageSize":1,
        "results":[
            {
                "id":1000,
                "owner":"hezhongwei",
                "status":0,
                "title":{
                    "offset":1,
                    "title":"datawind订阅",
                    "withDate":true
                },
                "content":{
                    "dashboardContentFormat":"img",
                    "dashboardContentVisible":true,
                    "dashboardLinkVisible":false
                },
                "description":"description",
                "dashboard":{
                    "id":144250,
                    "name":"datawind仪表盘"
                },
                "noticeType":0,
                "pushTime":{
                    "frequency":3,
                    "offset":2,
                    "time":[
                        "10:00"
                    ],
                    "timezone":"UTC+08:00",
                    "untilDataReady":true,
                    "weekdays":[
                        1,
                        2
                    ]
                },
                "pushType":"lark",
                "subscribers":[
                    {
                        "agent":"hezhongwei",
                        "subscriber":"hezhongwei"
                    }
                ],
                "urls":[
                    {
                        "title":"仪表盘sheet-01",
                        "url":"仪表盘URL"
                    }
                ],
                "remark":{
                    "content":"订阅说明",
                    "manageLinkVisible":true,
                    "screenshotTimeVisible":true
                },
                "config":{
                    "autoRetry":false,
                    "autoSyncSheets":false,
                    "language":"auto",
                    "manageUrl":"订阅管理URL",
                    "noPushIfAbnormal":false
                }
            }
        ],
        "total":1
    },
    "msg":"成功"
}

用于创建仪表盘订阅配置。

4.1 请求

POST /aeolus/api/open/v2/subscription/subscriptions

4.2 权限要求

只能创建有对应仪表盘权限的订阅。

4.3 请求头

4.4 Body 参数

4.5 Body 示例

{
    "config": {
        "autoRetry": true,
        "autoSyncSheets": false,
        "language": "auto",
        "manageUrl": "订阅管理URL",
        "noPushIfAbnormal": true
    },
    "content": {
        "dashboardContentFormat": "img",
        "dashboardContentVisible": true,
        "dashboardLinkVisible": false
    },
    "appId": 555371,
    "dashboardId": 144250,
    "description": "description",
    "noticeType": 0,
    "pushTime": {
        "frequency": 3,
        "offset": 2,
        "weekdays": [
            1,
            2
        ],
        "time": [
            "10:00"
        ],
        "timezone": "UTC-08:00",
        "untilDataReady": true
    },
    "pushType": "lark",
    "remark": {
        "content": "",
        "manageLinkVisible": true,
        "screenshotTimeVisible": true
    },
    "subscribers": [
        {
            "agent": "hezhongwei",
            "subscriber": "hezhongwei"
        }
    ],
    "title": {
        "offset": 1,
        "title": "DataWind订阅",
        "withDate": true
    },
    "urls": [
        {
            "url": "仪表盘链接URL"
        }
    ]
}

4.6 响应

4.7 响应示例

{
    "code": "aeolus/ok",
    "data": {
        "subscriptionId": 1000
    },
    "msg": "成功"
}

用于修改已有的仪表盘订阅。

5.1 请求

PATCH /aeolus/api/open/v2/subscription/subscriptions

5.2 权限限制

只能修改有权限的订阅，项目管理员、系统管理员可以修改任意订阅，仪表盘管理员可修改对应仪表盘的订阅，订阅所有者可修改自己创建的订阅。

5.3 请求头

5.4 Body 参数

5.5 Body 示例

{
    "id": 1000,
    "status": 0,
    "config": {
        "autoRetry": true,
        "autoSyncSheets": false,
        "language": "auto",
        "manageUrl": "订阅管理URL",
        "noPushIfAbnormal": true
    },
    "content": {
        "dashboardContentFormat": "img",
        "dashboardContentVisible": true,
        "dashboardLinkVisible": false
    },
    "appId": 555371,
    "dashboardId": 144250,
    "description": "description",
    "noticeType": 0,
    "pushTime": {
        "frequency": 3,
        "offset": 2,
        "weekdays": [
            1,
            2
        ],
        "time": [
            "10:00"
        ],
        "timezone": "UTC-08:00",
        "untilDataReady": true
    },
    "pushType": "lark",
    "remark": {
        "content": "",
        "manageLinkVisible": true,
        "screenshotTimeVisible": true
    },
    "subscribers": [
        {
            "agent": "hezhongwei",
            "subscriber": "hezhongwei"
        }
    ],
    "title": {
        "offset": 1,
        "title": "DataWind订阅",
        "withDate": true
    },
    "urls": [
        {
            "url": "仪表盘URL"
        }
    ]
}

5.6 响应

5.7 响应示例

{
    "code": "aeolus/ok",
    "data": {
        "subscriptionId": 1000
    },
    "msg": "成功"
}

用于批量删除有权限的仪表盘订阅。

6.1 请求

DELETE /aeolus/api/open/v2/subscription/subscriptions

6.2 权限

只能删除有权限的订阅，项目管理员、系统管理员可以删除任意订阅，仪表盘管理员可删除对应仪表盘的订阅，订阅所有者可删除自己创建的订阅。

6.3 请求头

6.4 Body 参数

6.5 响应

6.6 响应示例

{
    "code": "aeolus/ok",
    "data": {
        "deletedSubscriptions": [
            10827
        ],
        "totalCount": 1
    },
    "msg": "成功"
}

退订指定用户的订阅，同时支持根据仪表盘ID退订全部订阅以及根据订阅ID退订指定订阅。

7.1 请求

DELETE /aeolus/api/open/v2/subscription/unsubscribe

7.2 权限

只能退订有修改删除权限的订阅。

7.3 请求头

7.4 Body 参数

7.5 响应

7.6 响应示例

{
    "code": "aeolus/ok",
    "data": {
        "totalCount": 5,
        "unsubscribedSubscriptions": [
            10825
        ]
    },
    "msg": "成功"
}