You need to enable JavaScript to run this app.
导航
公共参数
最近更新时间:2023.02.15 19:04:53首次发布时间:2023.02.15 19:04:53

公共参数是每个接口都需要使用的请求参数,开发者每次使用 OpenAPI 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。公共请求参数首字母均为大写,以此区分接口请求参数。

1.Action&Version

说明

Action和Version必须放在Query当中。

名称类型是否必填描述示例
ActionString接口名称,具体业务侧。接口格式为 [a-zA-Z]+CreateSparrow
VersionString接口版本信息,以具体业务接口说明为准。格式为 YYYY-MM-DD2021-04-30

2.签名参数

签名参数是请求必不可少的部分,可以放在Header或Query中:

  • 签名函数在Header中的场景
名称类型是否必填描述示例
X-DateString使用UTC时间,精确到秒。20201103T104027Z
AuthorizationString签名值见下文说明

Authorization内容如下:

HMAC-SHA256 Credential = {AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

{}内的各字段对应信息如下:

名称类型描述示例
AccessKeyString火山引擎账号的 AccessKey ID前往 秘钥管理 页面获取。
ShortDateString请求的短时间,精确到日20210430
RegionString请求的 Regioncn-north-1
ServiceString请求的服务名称veefedge
SignedHeadersString参与签名的Header,用分号分隔详情参考签名机制
SignatureString计算完毕的签名详情参考签名机制
  • 签名函数在Query中的场景
    X-Date与Authorization的信息可以直接存在在Query当中。
名称类型是否必填描述示例
X-DateString使用UTC时间,精确到秒20201103T104027Z
X-AlgorithmString固定值HMAC-SHA256
X-CredentialString{AccessKey}/{ShortDate}/{Region}/{Service}/request详情参考签名机制
X-SignedHeadersString参与签名的Header,用分号分隔详情参考签名机制
X-SignatureString计算完毕的签名详情参考签名机制