API 快速参考

 
/
GET / 返回欢迎消息和版本信息
 
/_active_tasks
GET /_active_tasks 获取服务器中运行的任务列表
 
/_all_dbs
GET /_all_dbs 返回所有数据库的列表
 
/_cluster_setup
GET /_cluster_setup 返回集群设置向导的状态
POST /_cluster_setup 将节点设置为单节点或集群的一部分。
 
/_db_updates
GET /_db_updates 返回数据库的服务器更改
 
/_dbs_info
GET /_dbs_info 返回所有数据库信息
POST /_dbs_info 返回指定数据库列表的信息
 
/_membership
GET /_membership 返回节点列表
 
/_node
GET /_node/{node-name} 返回节点名称
GET /_node/{node-name}/_config 获取整个服务器配置的列表
GET /_node/{node-name}/_config/{section} 返回指定部分的所有配置值
GET /_node/{node-name}/_config/{section}/{key} 返回特定部分/配置值
GET /_node/{node-name}/_prometheus 以 Prometheus 格式返回服务器统计信息
GET /_node/{node-name}/_stats 返回服务器统计信息
GET /_node/{node-name}/_system 返回系统级服务器统计信息
GET /_node/{node-name}/_versions 返回系统级服务器版本信息
POST /_node/{node-name}/_config/_reload 从磁盘重新加载配置
POST /_node/{node-name}/_restart 在给定节点上重启 CouchDB 应用程序
PUT /_node/{node-name}/_config/{section}/{key} 设置指定的配置值
DELETE /_node/{node-name}/_config/{section}/{key} 删除当前设置
 
/_replicate
POST /_replicate 启动或取消复制
 
/_reshard
GET /_reshard 检索有关集群上重新分片的摘要信息
GET /_reshard/jobs 检索有关集群上所有重新分片作业的信息
GET /_reshard/jobs/{jobid} 检索有关特定重新分片作业的信息
GET /_reshard/jobs/{jobid}/state 检索单个重新分片作业的状态
GET /_reshard/state 检索集群上重新分片的状态
POST /_reshard/jobs 创建一个或多个重新分片作业
PUT /_reshard/jobs/{jobid}/state 更改重新分片作业的状态
PUT /_reshard/state 更改集群上的重新分片状态
DELETE /_reshard/jobs/{jobid} 删除重新分片作业
 
/_scheduler
GET /_scheduler/docs 从 ``_replicator`` 数据库中检索有关复制文档的信息。
GET /_scheduler/docs/{replicator_db} 从特定复制器数据库中检索有关复制文档的信息。
GET /_scheduler/docs/{replicator_db}/{docid} 检索有关特定复制文档的信息
GET /_scheduler/jobs 检索有关复制作业的信息
 
/_search_analyze
POST /_search_analyze 测试分析器标记化的结果
 
/_session
GET /_session 返回基于 Cookie 的登录用户信息
POST /_session 通过基于 Cookie 的用户登录验证用户
DELETE /_session 注销基于 Cookie 的用户
 
/_up
GET /_up 健康检查端点
 
/_utils
GET /_utils 重定向到 /_utils/
GET /_utils/ CouchDB 管理界面 (Fauxton)
 
/_uuids
GET /_uuids 从服务器生成 UUID 列表
 
/favicon.ico
GET /favicon.ico 返回网站图标
 
/{db}
HEAD /{db} 检查数据库是否存在
HEAD /{db}/_design/{ddoc} 返回设计文档的 HTTP 标头中的基本信息
HEAD /{db}/_design/{ddoc}/{attname} 返回附件的 HTTP 标头中的基本信息
HEAD /{db}/{docid} 返回文档的 HTTP 标头中的基本信息
HEAD /{db}/{docid}/{attname} 返回附件的 HTTP 标头中的基本信息
GET /{db} 返回数据库信息
GET /{db}/_all_docs 返回此数据库中所有文档的内置视图
GET /{db}/_changes 返回给定数据库的更改
GET /{db}/_design/{ddoc} 返回设计文档
GET /{db}/_design/{ddoc}/_info 返回指定设计文档的视图索引信息
GET /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} 对来自其他设计文档的视图执行列表函数
GET /{db}/_design/{ddoc}/_list/{func}/{view} 对来自同一设计文档的视图执行列表函数
GET /{db}/_design/{ddoc}/_search/{index} 返回指定搜索索引的结果
GET /{db}/_design/{ddoc}/_search_info/{index} 返回指定搜索索引的元数据
GET /{db}/_design/{ddoc}/_show/{func} 对空文档执行 show 函数
GET /{db}/_design/{ddoc}/_show/{func}/{docid} 对指定文档执行 show 函数
GET /{db}/_design/{ddoc}/_view/{view} 返回指定存储视图的结果
GET /{db}/_design/{ddoc}/{attname} 获取设计文档的附件
GET /{db}/_design_docs 返回此数据库中所有设计文档的内置视图
GET /{db}/_index 列出所有索引。
GET /{db}/_local/{docid} 返回本地文档的最新修订版
GET /{db}/_local_docs 返回此数据库中所有本地(非复制)文档的内置视图
GET /{db}/_partition/{partition} 返回给定分区的文档和大小信息
GET /{db}/_partition/{partition}/_all_docs 返回指定分区中的所有文档
GET /{db}/_partition/{partition}/_design/{ddoc}/_view/{view} 执行分区查询
GET /{db}/_purged_infos_limit 返回数据库中要存储的历史清除的限制
GET /{db}/_revs_limit 返回数据库中单个文档要存储的历史修订版的限制
GET /{db}/_security 返回数据库的特殊安全对象
GET /{db}/_shards 显示数据库的分片映射布局
GET /{db}/_shards/{docid} 返回存储文档的特定分片
GET /{db}/{docid} 返回文档
GET /{db}/{docid}/{attname} 获取文档的附件
POST /{db} 如果未指定 _id,则创建具有生成 ID 的新文档
POST /{db}/_all_docs 返回此数据库中所有文档的内置视图
POST /{db}/_all_docs/queries 返回指定查询的结果
POST /{db}/_bulk_docs 将多个文档插入或更新到数据库中,在一个请求中
POST /{db}/_bulk_get 以给定修订版获取多个文档
POST /{db}/_changes 返回给定数据库的某些文档 ID 的更改
POST /{db}/_compact 启动数据库的压缩
POST /{db}/_compact/{ddoc} 启动所选设计文档中所有视图的压缩
POST /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} 与相关端点的 GET 方法相同
POST /{db}/_design/{ddoc}/_list/{func}/{view} 与相关端点的 GET 方法相同
POST /{db}/_design/{ddoc}/_show/{func} 与相关端点的 GET 方法相同
POST /{db}/_design/{ddoc}/_show/{func}/{docid} 与相关端点的 GET 方法相同
POST /{db}/_design/{ddoc}/_update/{func} 对空文档执行更新函数
POST /{db}/_design/{ddoc}/_view/{view} 返回指定视图的结果
POST /{db}/_design/{ddoc}/_view/{view}/queries 返回指定查询的结果
POST /{db}/_design_docs 返回此数据库中所有设计文档的内置视图
POST /{db}/_ensure_full_commit 已弃用的端点,用于支持 CouchDB 版本 < 3.0 复制器。
POST /{db}/_explain 确定特定查询正在使用哪个索引。
POST /{db}/_find 在给定数据库中查找文档
POST /{db}/_index 创建新索引。
POST /{db}/_local_docs 返回此数据库中所有本地(非复制)文档的内置视图
POST /{db}/_missing_revs 通过给定的文档修订版列表返回数据库中不存在的文档修订版
POST /{db}/_partition/{partition_id}/_explain 查找与查询一起使用的索引
POST /{db}/_partition/{partition_id}/_find 查询由 ``partition_id`` 指定的分区
POST /{db}/_purge 从数据库中完全清除文档
POST /{db}/_revs_diff 通过给定的文档修订版列表返回给定修订版与数据库中存在的修订版之间的差异
POST /{db}/_sync_shards 触发数据库中所有分片副本的同步
POST /{db}/_view_cleanup 删除任何设计文档都不使用的视图文件
PUT /{db} 创建新数据库
PUT /{db}/_design/{ddoc} 创建新设计文档或现有设计文档的新版本
PUT /{db}/_design/{ddoc}/_update/{func}/{docid} 对指定文档执行更新函数
PUT /{db}/_design/{ddoc}/{attname} 添加设计文档的附件
PUT /{db}/_local/{docid} 插入本地文档的新版本
PUT /{db}/_purged_infos_limit 设置数据库中要存储的历史清除的限制
PUT /{db}/_revs_limit 设置数据库中单个文档要存储的历史修订版的限制
PUT /{db}/_security 设置数据库的特殊安全对象
PUT /{db}/{docid} 创建新文档或现有文档的新版本
PUT /{db}/{docid}/{attname} 添加文档的附件
DELETE /{db} 删除现有数据库
DELETE /{db}/_design/{ddoc} 删除设计文档
DELETE /{db}/_design/{ddoc}/{attname} 删除设计文档的附件
DELETE /{db}/_index/{designdoc}/json/{name} 删除索引
DELETE /{db}/_local/{docid} 删除本地文档
DELETE /{db}/{docid} 删除文档
DELETE /{db}/{docid}/{attname} 删除文档的附件
COPY /{db}/_design/{ddoc} 复制设计文档
COPY /{db}/_local/{docid} 复制同一数据库中的本地文档
COPY /{db}/{docid} 复制同一数据库中的文档
ANY /{db}/_design/{ddoc}/_rewrite/{path} 使用存储的路由规则数组或 JavaScript 函数重写指定路径的 HTTP 请求