You need to enable JavaScript to run this app.
导航
请求结构
最近更新时间:2024.07.08 10:41:36首次发布时间:2024.07.08 10:41:36

调用火山引擎的 OpenAPI 接口需要向指定服务地址发送请求。该请求需要满足火山引擎签名信息和具体接口的业务信息,否则将调用失败。火山引擎的 OpenAPI 的请求结构组织如下,以调用 CreateDataMigrateTask 时的一条未编码的 URL 为例:

POST /?Action=CreateDataMigrateTask&Version=2018-01-01 HTTP/1.1 
Host: open.volcengineapi.com 
Region: cn-beijing
Service: dms
<接口请求参数>
  • POST 表示请求方法,存储迁移服务的 OpenAPI 支持 POST 请求。
  • Action=CreateDataMigrateTask 指定了要调用的 API,Version=2018-01-01 是 API 的版本。
  • Host 指定了火山引擎服务接入地址(Endpoint)。
  • RegionService 是请求的 Region 和服务,具体请参见公共参数
  • HTTP 指定了请求通信协议。

服务地址

存储迁移服务已开通服务的地域如下表所示。

开通地域

RegionId

服务接入地址

华北 2 (北京)

cn-beijing

open.volcengineapi.com

华东 2 (上海)

cn-shanghai

open.volcengineapi.com

华南 1 (广州)

cn-guangzhou

open.volcengineapi.com

通信协议

支持通过 HTTP 或 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。

请求方法

请求方法详见各个接口具体的需求。

说明

  • 公共参数中的 Action 和 Version 必须放在 Query String 中。
  • 使用 GET 方式时,所有请求参数均需要做 URL 编码。

请求参数

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

  • 公共请求参数:每个 API 接口都需要使用的参数为公共请求参数。关于公共参数的更多详情,请参见公共参数
  • 接口请求参数:每个 API 接口特有的参数为接口请求参数。关于各个接口的请求参数,请参见 API 概览中各接口的详细描述。

字符编码

请求及返回结果均使用 UTF-8 的字符集进行编码。