You need to enable JavaScript to run this app.
导航

请求结构

最近更新时间2022.11.18 17:51:00

首次发布时间2022.11.18 17:51:00

本文介绍数据库工作台 DBW 的 API 请求结构信息。

服务地址

数据库工作台 DBW 的服务地址为dbw.volcengineapi.com。目前已开通的地域如下表所示。

开通地域RegionId
华北2(北京)cn-beijing
华南1(广州)cn-guangzhou
华东2(上海)cn-shanghai

说明

  • 对时延敏感的业务,建议在请求 Header 中指定地域(Region),详细信息,请参见公共参数

  • 域名是 API 的接入点,并不代表产品或接实际提供服务的地域。

通信协议

支持通过 HTTP 或 HTTPS 两种请求通信方式,建议您使用安全性更高的 HTTPS 方式来发送请求。

请求方法

支持 HTTP POST 请求方法,其中 POST 请求支持的 Content-Type 类型为 application/JSON (推荐)。

说明

请求必须使用火山签名机制

请求参数

每个 API 请求都包含以下两类参数:

  • 公共请求参数:每个 API 接口都需要使用的参数为公共请求参数。关于公共请求参数的更多详情,请参见公共参数

  • 接口请求参数:每个 API 接口特有的参数为接口请求。关于各个接口的请求参数,请参见 API 概览中各接口的详细描述。

字符编码

均使用UTF-8编码。