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

请求方法

最近更新时间2023.11.23 11:21:45

首次发布时间2022.11.25 11:53:32

当您调用控制台OpenAPI接口时,是通过向指定服务地址发送请求,并需满足签名信息和具体接口的业务信息来完成的。OpenAPI的请求需要包含服务地址、请求方式、请求参数等信息。
以创建空间接口为例,一条未编码的URL请求示例如下:

POST https://{Host}?Action={Action name}&Version={Registered version}
ServiceName: {server name}
AccessKey: xxx
SecretKey: xxx
Region: xxx
Data: {<接口请求参数>}
  • POST表示控制台的OpenAPI支持的请求方法。
  • Host指定了服务接入地址(Endpoint),当前接入地址为open.volcengineapi.com。
  • Action={Action name}指定了要调用的API。
  • Version={Registered version}指定了要调用的API的版本,具体请参见公共参数
  • RegionServiceName是请求的Region和服务名称,具体请参见公共参数
  • AccessKeySecretKey用于验证签名信息,具体请参见签名机制
  • Data指定接口的请求参数。

服务地址

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

通信协议

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

请求方法

请求方法详见各个接口具体的需求,选择GET或POST方式发起请求。

请求参数

在发起OpenAPI请求时,请求体中可能会包含两类参数:公共请求参数和接口请求参数。

  • 公共请求参数是每一个接口需要包含的,具体请参见公共参数
  • 接口请求参数是各个接口特有的,详见各个接口的描述。

字符编码

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