2.4.1 获取附件下载历史记录

功能描述：一次性获取整个 Confluence 网站当前留存的全部附件下载历史记录。

方式：GET

地址：{Confluence_BaseUrl}/rest/attachmentListener/latest/downloadHistory/queryAllDownload

Auth：Basic Auth（使用 Confluence 系统管理员用户的 username + password）

返回结果：

[
    {
        "id": 5,
        "downloadDate": "2021-01-23 11:05:38",
        "userName": "userName 10",
        "userKey": "admin",
        "spaceKey": "ds",
        "spaceName": "Demonstration Space",
        "pageId": 65546,
        "pageName": "spaceName 82389",
        "attachmentId": 0,
        "attachmentName": "Attachment Name2A",
        "url": "http://localhost:1990/confluence/ds/65546"
    },
    {
        "id": 23,
        "downloadDate": "2021-01-23 12:22:13",
        "userName": "Poppy",
        "userKey": "1",
        "spaceKey": "123",
        "spaceName": "spaceName 12345",
        "pageId": 82389,
        "pageName": "spaceName 82389",
        "attachmentId": 82389,
        "attachmentName": "Attachment Name2A",
        "url": "http://localhost:1990/confluence/ds/65546"
    }
]


2.4.2 添加附件下载历史记录

功能描述：本插件不监控其他插件所实现的附件下载行为。可通过本接口自行添加附件下载历史记录。

方式：POST

地址：{Confluence_BaseUrl}/rest/attachmentListener/latest/downloadHistory/addRecord

Auth：Basic Auth（使用 Confluence 系统管理员用户的 username + password）

Body 示例：

{
    "userKey": "1",
    "userName": "Poppy",
    "spaceKey": "123",
    "spaceName": "spaceName 12345",
    "pageId": "82389",
    "pageName": "spaceName 82389",
    "attachmentId": "82389",
    "attachmentName": "Attachment Name2A",
    "url": "http://localhost:1990/confluence/ds/65546"
}

Body 字段说明：

字段

类型

必须

页面中显示

说明

userKey

String

非必须

不显示

用户 key，最大长度255

userName

String

非必须

显示

用户名，最大长度255

spaceKey

String

非必须

不显示

空间 key，最大长度255

spaceName

String

非必须

显示

空间名称，最大长度255

pageId

long

非必须

不显示

页面 ID

pageName

String

非必须

显示

页面名称

attachmentId

long

非必须

不显示

附件 ID

attachmentName

String

必须

显示

附件名称

url

String

非必须

显示

附件位置

返回结果：

状态码

返回结果

说明

200

{
    "msg": "ok"
}

添加成功。

400


请求异常，确认参数格式及必填参数。

401

Administrator permission is Required.

当前 Auth 用户的权限不足，需管理员权限。

500

Fail to add record. Please check the log.

添加失败，请确认参数长度，或通过日志排查问题。

500

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><status><status-code>500</status-code><message>...

请确保请求 body 中的 JSON 数据正确，排查返回的 message 内容。

  • 无标签