当您调用控制台OpenAPI接口时,是通过向指定服务地址发送请求,并需满足签名信息和具体接口的业务信息来完成的。OpenAPI的请求需要包含服务地址、请求方式、请求参数等信息。
以创建空间接口为例,一条未编码的URL请求示例如下:
POST https://{Host}/?Action={Action name}&Version={Registered version} ServiceName: {server name} AccessKey: xxx SecretKey: xxx Region: xxx Data: {<接口请求参数>}
POST
表示控制台的OpenAPI支持的请求方法,支持的 Content-Type 类型为application/json
。Host
指定了服务接入地址(Endpoint),当前接入地址为open.volcengineapi.com。Action={Action name}
指定了要调用的API。Version={Registered version}
指定了要调用的API的版本,具体请参见公共参数。Region
是请求的Region,具体请参见地域限制。ServiceName
是请求的服务名称,具体请参见公共参数。AccessKey
和SecretKey
用于验证签名信息,具体请参见签名机制。Data
指定接口的请求参数。火山引擎的OpenAPI的通用服务接入地址为:open.volcengineapi.com
。
支持通过HTTP
和 HTTPS
两种方式进行请求通信,推荐使用安全性更高的HTTPS
方式发送API请求。
请求方法详见各个接口具体的需求,选择GET或POST方式发起请求。
在发起OpenAPI请求时,请求体中可能会包含两类参数:公共请求参数和接口请求参数。
请求及返回结果使用UTF-8的字符集进行编码。