Confluence Cloud 集成

用于维基/文档管理的Confluence Cloud REST API v2集成，包括空间、页面、附件、评论和标签。

身份验证

Confluence Cloud使用API令牌进行身份验证。所需的环境变量：

• - CONFLUENCEBASEURL - 您的Confluence实例（例如 https://yourcompany.atlassian.net）
• CONFLUENCEUSEREMAIL - Atlassian账户邮箱
• CONFLUENCEAPITOKEN - 来自 https://id.atlassian.com/manage-profile/security/api-tokens 的API令牌

测试连接：
bash
curl -s -u $CONFLUENCEUSEREMAIL:$CONFLUENCEAPITOKEN $CONFLUENCEBASEURL/wiki/api/v2/spaces?limit=1 | jq .

快速参考

所有操作均使用 scripts/confluence.py 脚本：

操作	命令
空间
列出空间

confluence.py spaces |
| 按ID获取空间 | confluence.py space SPACE_ID |
| 按键获取空间 | confluence.py space-by-key PROJ |
| 创建空间 | confluence.py create-space --name 我的空间 --key MYSP |
| 页面 | |
| 列出页面 | confluence.py pages --space-id SPACE_ID |
| 获取页面 | confluence.py page PAGE_ID |
| 创建页面 | confluence.py create-page --space-id ID --title 标题 --body

内容

|
| 更新页面 | confluence.py update-page PAGE_ID --body

新内容

|
| 删除页面 | confluence.py delete-page PAGE_ID |
| 页面树 | |
| 获取子页面 | confluence.py children PAGE_ID |
| 获取祖先页面 | confluence.py ancestors PAGE_ID |
| 搜索 | |
| CQL搜索 | confluence.py search type=page AND space=PROJ |
| 附件 | |
| 列出附件 | confluence.py attachments PAGE_ID |
| 获取附件 | confluence.py attachment ATT_ID |
| 上传文件 | confluence.py upload PAGE_ID /path/to/file.pdf |
| 下载 | confluence.py download ATT_ID -o output.pdf |
| 删除附件 | confluence.py delete-attachment ATT_ID |
| 评论 | |
| 列出评论 | confluence.py comments PAGE_ID |
| 获取评论 | confluence.py comment COMMENT_ID |
| 创建评论 | confluence.py create-comment PAGE_ID 评论文本 |
| 更新评论 | confluence.py update-comment COMMENT_ID 新文本 |
| 删除评论 | confluence.py delete-comment COMMENT_ID |
| 标签 | |
| 获取标签 | confluence.py labels PAGE_ID |
| 添加标签 | confluence.py add-labels PAGE_ID label1,label2 |
| 移除标签 | confluence.py remove-label PAGE_ID labelname |
| 用户 | |
| 当前用户 | confluence.py me |

常见工作流程

空间管理

bash

列出所有空间

confluence.py spaces

仅列出全局空间

confluence.py spaces --type global

按键获取空间

confluence.py space-by-key PROJ

创建新空间

confluence.py create-space --name 项目文档 --key DOCS --description 团队文档

创建私有空间

confluence.py create-space --name 私人笔记 --key PRIV --private

页面操作

bash

列出空间中的页面（需要空间ID，而非键）

首先获取空间ID：

confluence.py space-by-key PROJ

然后列出页面：

confluence.py pages --space-id 12345678

按标题筛选页面

confluence.py pages --title 会议记录

获取包含正文内容的页面

confluence.py page 98765432 --body-format storage

获取包含标签的页面

confluence.py page 98765432 --include-labels

获取特定版本

confluence.py page 98765432 --version 5

创建页面

页面使用Confluence存储格式（基于XHTML）：

bash

简单页面

confluence.py create-page --space-id 12345678 --title 新页面 \
--body

你好世界

带格式的页面

confluence.py create-page --space-id 12345678 --title 格式化页面 \ --body

标题

包含粗体文本的段落。

• 项目1
• 项目2

子页面（在父页面下）

confluence.py create-page --space-id 12345678 --title 子页面 \ --parent-id 98765432 --body

这是一个子页面

草稿页面

confluence.py create-page --space-id 12345678 --title 草稿 \ --status draft --body

进行中

更新页面

bash

更新页面内容

confluence.py update-page 98765432 --body

已更新内容

更新标题

confluence.py update-page 98765432 --title 新标题 --body

内容

带版本消息更新

confluence.py update-page 98765432 --body

修复了拼写错误

\ --message 修正了拼写错误

删除页面

bash

移至回收站（可恢复）

confluence.py delete-page 98765432

永久删除（清除）

confluence.py delete-page 98765432 --purge

页面树导航

bash

获取子页面

confluence.py children 98765432

获取父链（祖先）

confluence.py ancestors 98765432

内容搜索（CQL）

Confluence查询语言（CQL）支持强大的筛选：

bash

按类型搜索

confluence.py search type=page

在特定空间中搜索

confluence.py search type=page AND space=PROJ

全文搜索

confluence.py search text ~ 会议记录

最近修改

confluence.py search type=page AND lastModified > now(-7d)

按标签

confluence.py search type=page AND label=important

按创建者

confluence.py search type=page AND creator=currentUser()

组合查询

confluence.py search type=page AND space=PROJ AND text ~ api AND lastModified > now(-30d)

附件

bash

列出页面上的附件

confluence.py attachments 98765432

按文件名筛选

confluence.py attachments 98765432 --filename report.pdf

按媒体类型筛选

confluence.py attachments 98765432 --media-type image/png

上传文件

confluence.py upload 98765432 /path/to/document.pdf

带评论上传

confluence.py upload 98765432 /path/to/file.pdf --comment Q3报告

下载附件

confluence.py download att123456 -o downloaded_file.pdf

删除附件（移至回收站）

confluence.py delete-attachment att123456

永久删除

confluence.py delete-attachment att123456 --purge

评论

bash

列出页面上的评论

confluence.py comments 98765432

获取带正文的评论

confluence.py comment comm123456 --body-format storage

添加评论

confluence.py create-comment 98765432

做得好！

更新评论

confluence.py update-comment comm123456

已更新评论

删除评论

confluence.py delete-comment comm123456

标签

bash

获取页面的标签

confluence.py labels 98765432

添加标签

confluence.py add-labels 98765432 documentation,api,important

移除标签

confluence.py remove-label 98765432 draft

存储格式参考

Confluence使用存储格式（基于XHTML）表示页面内容。详情请参见 references/storage-format.md。

常见元素

html

一级标题

二级标题

普通段落

粗体和斜体文本

• 无序项目