火山引擎的OpenAPI的请求结构如下:
客户调用火山引擎的OpenAPI接口,是通过向指定服务地址发送请求,并需满足火山引擎签名信息和具体接口的业务信息来完成的。火山引擎的OpenAPI的请求结构组织如下,以GetCluster一条未编码的URL请求示例:
POST /?Action=GetCluster&Version=2025-08-15&<接口请求参数> HTTP/1.1 Host: las.cn-beijing.volcengineapi.com Region: cn-beijing Service: las
POST表示请求方法。Action=GetCluster指定了要调用的API,Version=2025-08-15是API的版本。Host指定了火山引擎服务接入地址(Endpoint),具体请参见服务地址。Region和Service是请求的Region和服务名称,具体请参见公共参数。HTTP指定了请求通信协议。推荐使用安全性更高的 HTTPS方式发送请求。
请求方法详见各个接口具体的需求。在火山引擎中的OpenAPI大多数支持GET或POST请求。
火山引擎的OpenAPI请求包含两类参数:公共请求参数和接口请求参数。其中公共请求参数在每个请求中都必须包含。接口请求参数需参考各个服务的接口文档。
请求及返回结果使用UTF-8的字符集进行编码。