请求结构
更新时间:2022-12-07
您调用火山引擎的OpenAPI接口,是通过向指定服务地址发送请求,并需满足火山引擎签名信息和具体接口的业务信息来完成的。火山引擎的OpenAPI的请求结构组织如下,以CreateVpc一条未编码的URL请求示例:
GET /?Action=CreateVpc&<接口请求参数> HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing
-
GET
表示VPC中的OpenAPI仅支持Get请求。 -
Action=CreateVpc
指定了要调用的API。 -
HTTP
指定了请求通信协议。 -
Host
指定了火山引擎服务接入地址(Endpoint)。 -
Service
是请求的服务名称。 -
Region
是请求的Region,具体请参见公共参数。
通信协议#
私有网络API支持HTTP和HTTPS两种协议请求通信,推荐使用安全性更高的HTTPS方式发送API请求。
服务地址#
火山引擎OpenAPI的通用服务接入地址为:open.volcengineapi.com。
请求方法#
请求方法详见各个接口具体的需求。VPC中的OpenAPI仅支持GET请求。
注意:
使用GET方式调用API时,公共参数中的和必须放在中,且所有请求参数均需要做URL编码。Action
Version
Query String
请求参数#
火山引擎的OpenAPI请求包含两类参数:公共请求参数和接口请求参数。其中,公共请求参数是每一个接口都需要包含,具体可参见公共参数。接口请求参数是各个API特有参数,详见各个接口描述。
字符编码#
调用请求及返回结果,均使用UTF-8的字符集进行编码。