其他接口说明

云数据库 DocDB for MongoDB MONGODB

  • 功能发布记录
  • 产品描述
    • 实例规格
    • 产品特性
    • 系统架构
    • 应用场景
    • 产品术语
    • 概述
  • 重要通知
    • 品牌升级
  • 快速入门
    • 副本集实例快速入门
    • 分片集实例快速入门
  • 典型实践
    • MongoDB数据迁移典型实践
    • MongoDB数据安全典型实践
    • MongoDB监控报警典型实践
    • 如何连接副本集实例实现读写分离和高可用
    • MongoDB使用典型实践
    • MongoDB参数配置典型实践
  • 操作指南
    • 开通服务
    • 参数配置
      • 参数说明
      • 参数修改记录查询
      • 查询参数
      • 修改参数
    • 日志管理
      • 查询运行日志
      • 审计日志
        • 关闭审计日志
        • 开通审计日志
        • 查询审计日志
      • 慢日志
        • 查询慢日志
        • 关闭慢日志
        • 开通慢日志
      • 错误日志
        • 关闭错误日志
        • 开通错误日志
        • 查询错误日志
    • 监控与报警
      • 设置报警规则
      • 监控项说明
      • 查看监控信息
    • 公网访问
      • 释放公网访问
      • 申请公网访问
    • 实例管理
      • 重启实例
      • 迁移可用区
      • 回收站和释放实例
      • 改配实例
        • 改配分片集实例
        • 改配副本集实例
        • 改配方案概览
      • 创建实例
        • 创建副本集实例
        • 创建分片集实例
    • 数据安全
      • 透明加密
      • 使用Mongo Shell通过SSL加密连接数据库
      • 设置SSL加密
      • 白名单管理
    • 连接实例
      • 通过MongoShell连接分片集实例
      • 通过公网连接MongoDB实例
      • 通过MongoShell连接副本集实例
      • 通过程序代码连接MongoDB实例
    • 数据备份
      • 开启增量备份
      • 设置自动备份MongoDB数据
      • MongoDB数据备份方案概览
      • 手动备份MongoDB数据
    • 同城容灾
      • 创建多可用区分片集群实例
      • 创建多可用区副本集群实例
    • 帐号管理
      • 多用户访问控制
      • 重置密码
    • 主从切换
      • 副本集实例设置主从切换
      • 分片集设置主从切换
    • 计费管理
      • 手动续费包年包月实例
      • 预付费转后付费
      • 后付费转预付费
      • 开通或关闭自动续费包年包月实例
      • 取消预付费转后付费
    • 标签管理
      • 绑定已有标签
      • 新建标签
      • 根据标签筛选实例
      • 解绑删除标签
    • 数据恢复
      • 物理备份恢复至自建数据库
      • 按时间点恢复至新实例
      • 逻辑备份恢复至自建数据库
      • MongoDB数据恢复方案概览
      • 从备份点创建实例
  • 服务等级协议SLA
    • 服务等级协议SLA
  • API参考
    • 其他接口说明
    • 调用说明
    • 附录
    • API简介
    • 按时间点恢复相关接口
      • 获取可恢复的时间区间
    • 权限管理相关接口
      • 查看用户数据库列表
      • 创建用户数据库
      • 查看用户列表
      • 删除用户
      • 删除用户数据库
      • 更新用户权限
      • 创建用户
    • 备份相关接口
      • 更改备份策略
      • 创建备份
      • 查询备份列表
      • 更改备份备注
      • 查询备份策略
      • 查询备份详情
      • 删除备份
    • 日志管理相关接口
      • 开通运行日志
      • 查询运行日志列表
    • 实例相关接口
      • 副本集实例添加只读节点
      • 重启实例
      • 迁移可用区
      • 修改账号密码
      • 重启分片集实例组件
      • 分片集实例组件改配
      • 更改实例名称
      • 回收站和释放实例
      • 副本集实例改配
      • 分片集实例组件主从切换
      • 获取只读节点列表
      • 更改分片集实例组件名称
      • 查询实例列表
      • 新增分片集实例组件
      • 计费停服和启动服务
      • 副本集实例主从切换
      • 创建副本集实例
      • 创建分片集实例
      • 查询实例详情
    • 白名单相关接口
      • 删除白名单
      • 查询白名单
      • 添加白名单
  • 常见问题
    • 产品使用问题
    • 运维类问题
    • 常见问题总览
  • 产品定价
    • 计费变更
    • 产品定价
  • SDK
    • GO-SDK
      • 标签管理
      • 日志管理
      • 白名单管理
      • 初始化
      • 实例管理
      • 备份管理
      • 安装SDK工具包
      • 概述
所有文档
menu
没有找到结果,请重新输入

云数据库 DocDB for MongoDB MONGODB

  • 功能发布记录
  • 产品描述
    • 实例规格
    • 产品特性
    • 系统架构
    • 应用场景
    • 产品术语
    • 概述
  • 重要通知
    • 品牌升级
  • 快速入门
    • 副本集实例快速入门
    • 分片集实例快速入门
  • 典型实践
    • MongoDB数据迁移典型实践
    • MongoDB数据安全典型实践
    • MongoDB监控报警典型实践
    • 如何连接副本集实例实现读写分离和高可用
    • MongoDB使用典型实践
    • MongoDB参数配置典型实践
  • 操作指南
    • 开通服务
    • 参数配置
      • 参数说明
      • 参数修改记录查询
      • 查询参数
      • 修改参数
    • 日志管理
      • 查询运行日志
      • 审计日志
        • 关闭审计日志
        • 开通审计日志
        • 查询审计日志
      • 慢日志
        • 查询慢日志
        • 关闭慢日志
        • 开通慢日志
      • 错误日志
        • 关闭错误日志
        • 开通错误日志
        • 查询错误日志
    • 监控与报警
      • 设置报警规则
      • 监控项说明
      • 查看监控信息
    • 公网访问
      • 释放公网访问
      • 申请公网访问
    • 实例管理
      • 重启实例
      • 迁移可用区
      • 回收站和释放实例
      • 改配实例
        • 改配分片集实例
        • 改配副本集实例
        • 改配方案概览
      • 创建实例
        • 创建副本集实例
        • 创建分片集实例
    • 数据安全
      • 透明加密
      • 使用Mongo Shell通过SSL加密连接数据库
      • 设置SSL加密
      • 白名单管理
    • 连接实例
      • 通过MongoShell连接分片集实例
      • 通过公网连接MongoDB实例
      • 通过MongoShell连接副本集实例
      • 通过程序代码连接MongoDB实例
    • 数据备份
      • 开启增量备份
      • 设置自动备份MongoDB数据
      • MongoDB数据备份方案概览
      • 手动备份MongoDB数据
    • 同城容灾
      • 创建多可用区分片集群实例
      • 创建多可用区副本集群实例
    • 帐号管理
      • 多用户访问控制
      • 重置密码
    • 主从切换
      • 副本集实例设置主从切换
      • 分片集设置主从切换
    • 计费管理
      • 手动续费包年包月实例
      • 预付费转后付费
      • 后付费转预付费
      • 开通或关闭自动续费包年包月实例
      • 取消预付费转后付费
    • 标签管理
      • 绑定已有标签
      • 新建标签
      • 根据标签筛选实例
      • 解绑删除标签
    • 数据恢复
      • 物理备份恢复至自建数据库
      • 按时间点恢复至新实例
      • 逻辑备份恢复至自建数据库
      • MongoDB数据恢复方案概览
      • 从备份点创建实例
  • 服务等级协议SLA
    • 服务等级协议SLA
  • API参考
    • 其他接口说明
    • 调用说明
    • 附录
    • API简介
    • 按时间点恢复相关接口
      • 获取可恢复的时间区间
    • 权限管理相关接口
      • 查看用户数据库列表
      • 创建用户数据库
      • 查看用户列表
      • 删除用户
      • 删除用户数据库
      • 更新用户权限
      • 创建用户
    • 备份相关接口
      • 更改备份策略
      • 创建备份
      • 查询备份列表
      • 更改备份备注
      • 查询备份策略
      • 查询备份详情
      • 删除备份
    • 日志管理相关接口
      • 开通运行日志
      • 查询运行日志列表
    • 实例相关接口
      • 副本集实例添加只读节点
      • 重启实例
      • 迁移可用区
      • 修改账号密码
      • 重启分片集实例组件
      • 分片集实例组件改配
      • 更改实例名称
      • 回收站和释放实例
      • 副本集实例改配
      • 分片集实例组件主从切换
      • 获取只读节点列表
      • 更改分片集实例组件名称
      • 查询实例列表
      • 新增分片集实例组件
      • 计费停服和启动服务
      • 副本集实例主从切换
      • 创建副本集实例
      • 创建分片集实例
      • 查询实例详情
    • 白名单相关接口
      • 删除白名单
      • 查询白名单
      • 添加白名单
  • 常见问题
    • 产品使用问题
    • 运维类问题
    • 常见问题总览
  • 产品定价
    • 计费变更
    • 产品定价
  • SDK
    • GO-SDK
      • 标签管理
      • 日志管理
      • 白名单管理
      • 初始化
      • 实例管理
      • 备份管理
      • 安装SDK工具包
      • 概述
  • 文档中心
  • arrow
  • 云数据库 DocDB for MongoDBMONGODB
  • arrow
  • API参考
  • arrow
  • 其他接口说明
本页目录
  • 获取可用区列表
  • 查询目录价
  • 副本集查询目录价
  • 分片集查询目录价

其他接口说明

更新时间:2025-08-21

获取可用区列表

请求结构

Plain Text
1GET /v{version}/zone HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必须 参数位置 描述
version String 是 URL参数 API版本号

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称 类型 描述
zones List ZoneNames 可用区列表

ZoneNames

参数名称 类型 描述
zoneNames List<String> 可用区列表

请求示例

Plain Text
1GET /v1/zone HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3ETag:xxx-xxx-xxx
4Content-Type: application/json
5Content-Length: 567
6{
7    "zones": [
8       {"zoneNames":["cn-bj-a"]},
9       {"zoneNames":["cn-bj-b"]},
10       {"zoneNames":["cn-bj-a","cn-bj-b"]}
11    ]
12}

查询目录价

副本集查询目录价

请求结构

Plain Text
1POST /v1/price/queryCatalog HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4{
5    "billing":{
6        "paymentTiming": paymentTiming,
7        "reservation": {
8            "reservationLength": reservationLength
9        }
10    },
11    "purchaseCount":purchaseCount,
12    "dbInstanceType": dbInstanceType,
13    "dbInstanceCpuCount": dbCpu,
14    "dbInstanceMemoryCapacity": dbMemory,
15    "readonlyNodeNum": readonlyNodeNum,
16    "dbInstanceStorageType": storageType,
17    "dbInstanceStorage": dbStorage,  
18    "votingMemberNum": votingMemberNum
19}

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必选 参数位置 描述
version String 是 URL参数 API版本号
billing Billing 是 RequestBody参数 订单、计费相关参数。结构及取值参考
purchaseCount Integer 否 RequestBody参数 批量创建实例个数, 目前仅支持一次创建一个;默认1。
dbInstanceType String 否 RequestBody参数 实例类型。默认值replica。取值参考
dbInstanceCpuCount Integer 是 RequestBody参数 副本集实例CPU规格。取值参考
dbInstanceMemoryCapacity Integer 是 RequestBody参数 副本集实例内存规格,单位GB。取值参考
readonlyNodeNum Integer 是 RequestBody参数 副本集实例只读节点数量。默认为0,最多可创建5个只读节点,针对三节点的副本集有效。
dbInstanceStorageType String 否 RequestBody参数 实例存储类型。默认值CDS_PREMIUM_SSD。取值参考
dbInstanceStorage Integer 是 RequestBody参数 副本集实例存储规格,单位GB。取值参考
votingMemberNum Integer 是 RequestBody参数 副本集实例投票节点数量。取值为1、3。默认为3,当取值1时表示单节点实例。

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称 类型 描述
price Double 所选套餐*个数的总价
perPrice Double 单个套餐的价格

请求示例

Plain Text
1POST /v1/price/queryCatalog HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3ContentType: application/json 
4{
5  "billing":{
6        "paymentTiming":"Postpaid",                   
7        "reservation":{                              
8                "reservationLength":1,               
9                "reservationTimeUnit":"Month"  
10        }
11   },
12   "purchaseCount":1,
13   "dbInstanceType":"replica",
14   "dbInstanceCpuCount":1,  
15   "dbInstanceMemoryCapacity":2,                
16   "readonlyNodeNum":0,                   
17   "dbInstanceStorageType":"CDS_ENHANCED_SSD",  
18   "dbInstanceStorage":5,
19   "votingMemberNum":3
20}

返回示例

Plain Text
1{
2  "price": "0.0510174744",
3  "perPrice": "0.05"
4}

分片集查询目录价

请求结构

Plain Text
1POST /v1/price/queryCatalog HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4{
5    "billing":{
6        "paymentTiming": paymentTiming,
7        "reservation": {
8            "reservationLength": reservationLength
9        }
10    },
11    "purchaseCount":purchaseCount,
12    "dbInstanceType": dbInstanceType,
13    "mongosCount": mognosCount,
14    "mongosCpuCount": mongosCpuCount,
15    "mongosMemoryCapacity": mongosMemoryCapacity,
16    "shardCount": shardCount,
17    "shardCpuCount": shardCount,
18    "shardMemoryCapacity": shardMemoryCapacity,
19    "shardStorageType": shardStorageType,
20    "shardStorage": shardStorage
21}

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必选 参数位置 描述
version String 是 URL参数 API版本号
billing Billing 是 RequestBody参数 订单、计费相关参数。结构及取值参考
purchaseCount Integrer 否 RequestBody参数 批量创建实例个数, 目前仅支持一次创建一个;默认1。
dbInstanceType String 否 RequestBody参数 实例类型。默认值replica。取值参考
mongosCount Integer 否 RequestBody参数 Mongos组件数量。创建分片集实例该参数必填。取值范围[2,32]
mongosCpuCount Integer 否 RequestBody参数 Mongos组件CPU规格。创建分片集实例该参数必填。取值参考
mongosMemoryCapacity Integrer 否 RequestBody参数 Mongos组件内存规格。创建分片集实例该参数必填。取值参考
shardCount Integer 否 RequestBody参数 Shard组件数量。创建分片集实例该参数必填。取值范围[2,32]
shardCpuCount Integer 否 RequestBody参数 Shard组件CPU规格。创建分片集实例该参数必填。取值参考
shardMemoryCapacity Integer 否 RequestBody参数 Shard组件内存规格。创建分片集实例该参数必填。取值参考
shardStorageType String 否 RequestBody参数 shard组件存储类型。默认值CDS_PREMIUM_SSD。取值参考
shardStorage Integer 否 RequestBody参数 Shard组件存储规格。创建分片集实例该参数必填。取值参考

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称 类型 描述
price Double 所选套餐*个数的总价
perPrice Double 单个套餐的价格

请求示例

Plain Text
1POST /v1/price/queryCatalog HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3ContentType: application/json 
4{
5   "billing": {
6        "paymentTiming": "Prepaid",
7        "reservation": {
8            "reservationLength": 1,
9            "reservationTimeUnit": "Month"
10        }
11    }, 
12    "purchaseCount": 1, 
13    "dbInstanceType": "sharding", 
14    "mongosCount": 2, 
15    "mongosCpuCount": "1", 
16    "mongosMemoryCapacity": "2",     
17    "shardCount": 2, 
18    "shardCpuCount": "1", 
19    "shardMemoryCapacity": "2",      
20    "shardStorageType": "LOCAL_DISK", 
21    "shardStorage": 5
22}

返回示例

Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5    "price": "0.51352187",
6    "perPrice": "0.5"
7}

上一篇
服务等级协议SLA
下一篇
调用说明