本文介绍文档数据库 MongoDB 版的 API 请求结构信息。
文档数据库 MongoDB 版已开通服务的地域如下表。
开通地域 | RegionId | 服务接入地址 | |
---|---|---|---|
中国大陆地域 | 华北 2(北京) | cn-beijing | mongodb.volcengineapi.com |
华南 1(广州) | cn-guangzhou | mongodb.volcengineapi.com | |
华东 2(上海) | cn-shanghai | mongodb.volcengineapi.com | |
海外地域 | 亚太东南 (柔佛) | ap-southeast-1 | mongodb.volcengineapi.com |
支持通过 HTTP 或 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式来发送请求。
支持 HTTP POST 请求方法,其中 POST 请求支持的 Content-Type 类型为 application/JSON(推荐)。
说明
请求必须使用火山签名机制。
您可以通过发送 HTTPS POST 请求来调用 MongoDB 的 API 服务。HTTPS 请求 URI 的格式如下:
POST {URI-scheme}://{Endpoint}/?Action={Action}&Version={Version} HTTP/1.1
其中:
URI-scheme
:表示用于传输请求的协议,当前所有 API 均采用 HTTPS 协议。Endpoint
:指定承载服务端点的服务器域名或 IP,即服务地址。文档数据库 MongoDB 版的服务地址为 mongodb.volcengineapi.com
。更多详情,请参见服务地址。Action
:要执行的操作,此处请填写要调用的 API 接口名称。文档数据库 MongoDB 版支持的 API 接口详情,请参见 API 概览。Version
:API 版本号,格式为 YYYY-MM-DD
格式。文档数据库 MongoDB 版的 API 版本号是 2022-01-01
。以创建 MongoDB 实例为例,未编码的 HTTPS 请求 URI 如下。
https://mongodb.volcengineapi.com/?Action=CreateDBInstance&Version=2022-01-01
每个API请求都包含如下两类参数:
均使用 UTF-8
编码。