当您调用火山引擎的OpenAPI,是通过向指定服务地址发送请求,并需满足火山引擎签名信息和具体接口的业务信息来完成的。火山引擎OpenAPI的请求结构组织如下,以DescribeVpcEndpointServices一条未编码的URL请求示例:
GET /?Action=DescribeTransitRouters&Version=2020-04-01&<接口请求参数> Host: open.volcengineapi.com HTTP/1.1 Region: cn-guangzhou Service: transitrouter
GET
表示中转路由器的OpenAPI仅支持Get请求。Action=DescribeTransitRouters
指定了要调用的OpenAPI,Version=2020-04-01
指定了OpenAPI的版本。HTTP
指定了请求通信协议。Host
指定了火山引擎服务接入地址(Endpoint)。Region
和Service
是请求的Region和服务名称,具体请参见公共参数。火山引擎的OpenAPI的通用服务接入地址为:open.volcengineapi.com
。
支持通过HTTP
和 HTTPS
两种方式进行请求通信,推荐使用安全性更高的HTTPS
方式发送API请求。
请求方法详见各个接口具体的需求。中转路由器的OpenAPI仅支持Get请求。
说明
Action
和Version
必须放在Query String
中。火山引擎的OpenAPI请求包含两类参数:公共请求参数和接口请求参数。其中,公共请求参数是每一个接口需要包含的,具体可参见公共参数。接口请求参数是各个接口特有的,详见各个接口描述。
请求及返回结果使用UTF-8的字符集进行编码。