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

请求结构

最近更新时间2023.09.08 16:31:00

首次发布时间2023.09.08 16:31:00

客户调用火山引擎的OpenAPI接口,是通过向指定服务地址发送请求,并需满足火山引擎签名信息和具体接口的业务信息来完成的。火山引擎的OpenAPI的请求结构组织如下,以 AllocateDedicatedHosts 一条未编码的URL请求示例:

GET /?Action=AllocateDedicatedHosts&Version=2020-04-01&<接口请求参数> HTTP/1.1
Host: open.volcengineapi.com 
Region: cn-beijing
Service: ecs
  • GET表示请求方法,专有宿主机服务的OpenAPI支持GET请求。

  • Action=AllocateDedicatedHosts指定了要调用的API,Version=2020-04-01是API的版本。

  • Host指定了火山引擎服务接入地址(Endpoint)。

  • RegionService是请求的Region和服务名称,具体请参见公共参数

  • HTTP指定了请求通信协议。

服务地址

火山引擎的OpenAPI的通用服务接入地址为:open.volcengineapi.com

通信协议

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

请求方法

请求方法详见各个接口具体的需求。云服务器的OpenAPI支持GET请求。

注意

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

请求参数

火山引擎的OpenAPI请求包含两类参数:公共请求参数和接口请求参数。其中,公共请求参数是每一个接口需要包含的,具体可参见公共参数小节。接口请求参数是各个接口特有的,详见各个接口描述。

字符编码

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