调用火山引擎的 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)。Region 和 Service 是请求的 Region 和服务,具体请参见公共参数。HTTP 指定了请求通信协议。存储迁移服务已开通服务的地域如下表所示。
开通地域 | Region ID | 服务接入地址 |
|---|---|---|
华北2(北京) | cn-beijing | dms.cn-beijing.volcengineapi.com |
华南1(广州) | cn-guangzhou | dms.cn-guangzhou.volcengineapi.com |
华东2(上海) | cn-shanghai | dms.cn-shanghai.volcengineapi.com |
中国香港 | cn-hongkong | dms.cn-hongkong.volcengineapi.com |
亚太东南(柔佛) | ap-southeast-1 | dms.ap-southeast-1.volcengineapi.com |
亚太东南(雅加达) | ap-southeast-3 | dms.ap-southeast-3.volcengineapi.com |
支持通过 HTTP 或 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。
请求方法详见各个接口具体的需求。
说明
每个 API 请求都包含如下两类参数:
请求及返回结果均使用 UTF-8 的字符集进行编码。