You need to enable JavaScript to run this app.
导航
调用方法
最近更新时间:2025.04.28 12:21:15首次发布时间:2025.04.28 12:21:15
我的收藏
有用
有用
无用
无用

您可使用 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,
SignedHeaders={SignedHeaders}, Signature={Signature}

为保证 OpenAPI 的安全调用,在调用 OpenAPI 时,火山引擎会对每个 OpenAPI 请求通过签名进行身份验证。
火山引擎 提供了多种语言的签名 SDK,您可以直接调用进行签名,也可以参考签名 SDK 实现自己的 OpenAPI。

HMAC-SHA256:签名方法
Credential:签名凭证,其中,
-AccessKeyId是访问密钥ID,可在 访问密钥(Access Key) 获取;
-ShortDate是请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
-Region默认为cn-north-1
-Service默认为cv
SignedHeaders是参与签名计算的头部信息,content-type 和 host 为必选头部
Signature是签名,可在 签名方法 获取。

X-Security-Token

String

指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken:
1.用户 / Service 访问自己的资源则可以使用 AK/SK 直接访问(长期 Token),无需填写该参数。
2.用户 / Service 通过扮演角色去调用接口时需要使用 STS。具体流程:先调用 AssumeRole 获得短期 token, 然后将该 Token 放入该参数去请求目标接口。