You need to enable JavaScript to run this app.
导航
请求方法
最近更新时间:2025.05.12 18:01:38首次发布时间:2021.11.10 18:21:34
我的收藏
有用
有用
无用
无用

当您调用火山引擎 OpenAPI 时,是通过向指定服务地址发送请求,并需满足火山引擎签名信息和具体接口的业务信息来实现的。本文介绍火山引擎的 OpenAPI 请求的基本结构和通信方法。

POST https://{Host}?Action={Action name}&Version={Registered version}
ServiceName: {Monitor server name}
AccessKey: xxx
SecretKey: xxx
Region: xxx
Data: {<接口请求参数>}

参数说明:

  • POST:火山引擎云监控的 OpenAPI 仅支持 POST 请求。
  • Host:火山引擎服务接入地址(Endpoint),当前接入地址为 open.volcengineapi.com。
  • Action={Action name}:调用的 OpenAPI。
  • Version={Registered version}:调用的 OpenAPI 版本,详情请参见 公共参数
  • RegionServiceName:请求的 Region 和服务名称,详情请参见公共参数
  • AccessKeySecretKey:用于验证签名信息,详情请参见 签名机制
  • Data:接口的请求参数。

服务地址

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

通信协议

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

请求方法

请求方法详见各个接口具体的需求。云监控的 OpenAPI 仅支持 POST 请求。

请求参数

火山引擎 OpenAPI 请求包含如下两类参数:

  • 公共请求参数:每个接口均需要包含的参数,详情请参见 公共参数
  • 接口请求参数:不同接口特有的参数,详情请参见各个接口描述。

字符编码

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