1. API 参考

API URL 路径的组成部分有助于确定正在访问的 CouchDB 服务器的哪个部分。结果是 URL 请求的结构既识别又有效地描述了您正在访问的数据库区域。

与所有 URL 一样，各个组件由正斜杠分隔。

一般来说，以 _（下划线）字符开头的 URL 组件和 JSON 字段代表服务器或返回对象中的特殊组件或实体。例如，URL 片段 /_all_dbs 获取 CouchDB 实例中所有数据库的列表。

本参考根据 URL 结构进行组织，如下所示。

• 1.1. API 基础
  • 1.1.1. 请求格式和响应
  • 1.1.2. HTTP 头
  • 1.1.3. JSON 基础
  • 1.1.4. HTTP 状态码
• 1.2. 服务器
  • 1.2.1. /
  • 1.2.2. /_active_tasks
  • 1.2.3. /_all_dbs
  • 1.2.4. /_dbs_info
  • 1.2.5. /_cluster_setup
  • 1.2.6. /_db_updates
  • 1.2.7. /_membership
  • 1.2.8. /_replicate
  • 1.2.9. /_scheduler/jobs
  • 1.2.10. /_scheduler/docs
  • 1.2.11. /_node/{node-name}
  • 1.2.12. /_node/{node-name}/_stats
  • 1.2.13. /_node/{node-name}/_prometheus
  • 1.2.14. /_node/{node-name}/_system
  • 1.2.15. /_node/{node-name}/_restart
  • 1.2.16. /_node/{node-name}/_versions
  • 1.2.17. /_search_analyze
  • 1.2.18. /_utils
  • 1.2.19. /_up
  • 1.2.20. /_uuids
  • 1.2.21. /favicon.ico
  • 1.2.22. /_reshard
  • 1.2.23. 身份验证
  • 1.2.24. 配置
• 1.3. 数据库
  • 1.3.1. /db
  • 1.3.2. /{db}/_all_docs
  • 1.3.3. /{db}/_design_docs
  • 1.3.4. /{db}/_bulk_get
  • 1.3.5. /{db}/_bulk_docs
  • 1.3.6. /db/_find
  • 1.3.7. /db/_index
  • 1.3.8. /db/_explain
  • 1.3.9. /db/_shards
  • 1.3.10. /db/_shards/doc
  • 1.3.11. /db/_sync_shards
  • 1.3.12. /db/_changes
  • 1.3.13. /db/_compact
  • 1.3.14. /db/_compact/design-doc
  • 1.3.15. /db/_ensure_full_commit
  • 1.3.16. /db/_view_cleanup
  • 1.3.17. /db/_security
  • 1.3.18. /db/_purge
  • 1.3.19. /db/_purged_infos_limit
  • 1.3.20. /db/_missing_revs
  • 1.3.21. /db/_revs_diff
  • 1.3.22. /db/_revs_limit
• 1.4. 文档
  • 1.4.1. /db/doc
  • 1.4.2. /db/doc/attachment
• 1.5. 设计文档
  • 1.5.1. /db/_design/design-doc
  • 1.5.2. /db/_design/design-doc/attachment
  • 1.5.3. /db/_design/design-doc/_info
  • 1.5.4. /db/_design/design-doc/_view/view-name
  • 1.5.5. /db/_design/design-doc/_search/index-name
  • 1.5.6. /db/_design/design-doc/_search_info/index-name
  • 1.5.7. /db/_design/design-doc/_show/show-name
  • 1.5.8. /db/_design/design-doc/_show/show-name/doc-id
  • 1.5.9. /db/_design/design-doc/_list/list-name/view-name
  • 1.5.10. /db/_design/design-doc/_list/list-name/other-ddoc/view-name
  • 1.5.11. /db/_design/design-doc/_update/update-name
  • 1.5.12. /db/_design/design-doc/_update/update-name/doc-id
  • 1.5.13. /db/_design/design-doc/_rewrite/path
• 1.6. 分区数据库
  • 1.6.1. /db/_partition/partition
  • 1.6.2. /db/_partition/partition/_all_docs
  • 1.6.3. /db/_partition/partition/_design/design-doc/_view/view-name
  • 1.6.4. /db/_partition/partition_id/_find
  • 1.6.5. /db/_partition/partition_id/_explain
• 1.7. 本地（非复制）文档
  • 1.7.1. /db/_local_docs
  • 1.7.2. /db/_local/id