You need to enable JavaScript to run this app.
导航
请求结构
最近更新时间:2025.04.23 12:06:55首次发布时间:2021.02.25 21:02:47
我的收藏
有用
有用
无用
无用

火山引擎的OpenAPI的请求结构如下:

服务地址

服务地址(Endpoint)用于访问火山引擎的云服务,通常是一个URL,客户端可以通过该地址与服务进行通信。
火山引擎服务地址的标准形式为:

Regional服务 (区域化部署)Global服务(中心化部署)

{service}.{region}.volcengineapi.com

例如:云服务器的Service为:ecs,其在cn-beijing-autodriving Region的服务地址为:
ecs.cn-beijing-autodriving.volcengineapi.com
{service}.volcengineapi.com

例如:访问控制的Service为:iam,作为Global服务,其服务地址为:iam.volcengineapi.com

注意

  • 当Service中存在下划线( _ )符号时,Endpoint需转为中划线( - )符号。存在大写字母时需转成小写。
  • 存在部分云产品暂未适配标准Endpoint,请前往您所使用的云产品-API参考或开发指南中查看详情。

通信协议

推荐使用安全性更高的 HTTPS方式发送请求。

请求方法

请求方法详见各个接口具体的需求。在火山引擎中的OpenAPI大多数支持GET或POST请求。

请求参数

火山引擎的OpenAPI请求包含两类参数:公共请求参数和接口请求参数。其中公共请求参数在每个请求中都必须包含。接口请求参数需参考各个服务的接口文档。

字符编码

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