当您调用火山引擎的OpenAPI,是通过向指定服务地址发送请求,并需满足火山引擎签名信息和具体接口的业务信息来完成的。火山引擎的OpenAPI的请求结构组织如下,以DescribeLoadBalancers一条未编码的URL请求示例:
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}
:要调用的API。Version={Registered version}
:要调用的API的版本,具体请参见公共参数。Region
和ServiceName
:请求的Region和服务名称,具体请参见公共参数。AccessKey
和SecretKey
:用于验证签名信息,具体请参见签名机制。Data
:接口的请求参数。火山引擎的OpenAPI的通用服务接入地址为:open.volcengineapi.com
。
支持通过HTTP
和 HTTPS
两种方式进行请求通信,推荐使用安全性更高的HTTPS
方式发送API请求。
请求方法详见各个接口具体的需求。云监控的OpenAPI仅支持POST请求。
火山引擎的OpenAPI请求包含两类参数:公共请求参数和接口请求参数。
请求及返回结果使用UTF-8的字符集进行编码。