您可使用 OpenAPI 向 火山引擎服务端地址发送请求,并按照接口说明在请求中加入相应请求参数。系统会根据请求的处理情况,返回处理结果。本章节为您介绍 身份认证 OpenAPI 的调用方法,包括但不限于请求结构、公共参数、签名机制和公共错误码
visual.volcengineapi.com
你可以使用 HTTP 和 HTTPS 两种协议进行请求通信。我们强烈推荐你使用安全性更高的 HTTPS 方式发送请求。
主要为限流限制,具体值请参看各个接口描述。
根据各个接口的具体需求,选择 GET 或 POST 方式发起请求。
公共参数
公共参数是每个接口都需要使用的请求参数,开发者每次使用火山引擎 API 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。
在发起所有 OpenAPI 请求时,请求Header中必须包含以下公共参数:
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
X-Date | String | 是 | 20201103T104027Z | 使用UTC标准时间,日期精确到秒,格式:YYYYMMDD'T'HHMMSS'Z'。 |
Authorization | String | 是 | HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, | 为保证 OpenAPI 的安全调用,在调用 OpenAPI 时,火山引擎会对每个 OpenAPI 请求通过签名进行身份验证。 HMAC-SHA256:签名方法 |
X-Security-Token | String | 否 | 无 | 指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken: |