You need to enable JavaScript to run this app.
导航

公共参数

最近更新时间2023.10.11 10:11:21

首次发布时间2023.02.22 17:09:41

公共参数是每个接口都需要使用的请求参数。您每次使用 API 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。

Action & Version

Action 和 Version 需要放在 Query 中。

名称

类型

是否必填

描述

示例

Action

String

接口名称,格式为 [a-zA-Z]+

CreateApplication

Version

String

接口版本信息,格式为 YYYY-MM-DD
。当前边缘容器的接口版本为2022-10-01

2022-10-01

签名参数

签名参数是请求必不可少的部分。对于 GET 请求,既可以在 Query 当中,也可以在 Header 当中;对于 POST 请求,只能放在 Header 中。

签名参数放置在请求 Header

名称

类型

是否必填

描述

示例

X-Date

String

使用 UTC 时间,精确到秒

20201103T104027Z

Authorization

String

签名值

见下文说明

Authorization 内容如下:

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

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

名称

类型

描述

示例

AccessKey

String

火山引擎账号 AccessKey ID

前往 秘钥管理 获取

ShortDate

String

请求的短时间,精确到日

20210430

Region

String

请求的 Region

cn-north-1

Service

String

请求的服务

veecc

SignedHeaders

String

参与签名的 Header,用分号分隔

详情参考 签名机制

Signature

String

计算完毕的签名

详情参考 签名机制

签名参数放置在请求 Query

名称

类型

是否必填

描述

示例

X-Date

String

使用 UTC 时间,精确到秒

20201103T104027Z

X-Algorithm

String

固定值

HMAC-SHA256

X-Credential

String

{AccessKey}/{ShortDate}/{Region}/{Service}/request

详情参考 签名机制

X-SignedHeaders

String

参与签名的Header,用分号分隔

详情参考 签名机制

X-Signature

String

计算完毕的签名

详情参考 签名机制