当您调用火山引擎 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 版本,详情请参见 公共参数。Region
和ServiceName
:请求的 Region 和服务名称,详情请参见公共参数。AccessKey
和SecretKey
:用于验证签名信息,详情请参见 签名机制。Data
:接口的请求参数。火山引擎 OpenAPI 的通用服务接入地址为open.volcengineapi.com
。
支持通过HTTP
和HTTPS
两种方式进行请求通信,推荐使用安全性更高的HTTPS
方式发送 OpenAPI 请求。
请求方法详见各个接口具体的需求。云监控的 OpenAPI 仅支持 POST 请求。
火山引擎 OpenAPI 请求包含如下两类参数:
请求及返回结果使用 UTF-8 字符集进行编码。