文档中心

公共参数

最近更新时间：2023.07.03 16:32:40

首次发布时间：2022.02.25 18:58:32

公共请求参数是指调用任意 API 接口时都需要使用到的请求参数。即每次发送 API 请求时，都需要携带这些公共请求参数，否则会导致请求失败。

说明

为了简洁性，在具体的接口文档中，将仅对 Action 和 Version 这两个公共请求参数进行说明。在使用接口前，请确保您已了解以下公共请求参数相关内容。

Action 与 Version

注意

Action 和 Version 必须放在 Query 中。

名称	类型	是否必选	描述
Action	String	是	接口名称，格式为 `[a-zA-Z]+`
Version	String	是	接口版本信息，格式为 `YYYY-MM-DD` 边缘计算节点 API 接口版本为 2021-04-30
X-Expires	Integer	否	签名的有效时间，单位为秒，不填时默认值为 900

说明

签名参数可以放在 Header 或 Query 中。

名称	类型	是否必选	描述
X-Date	String	是	使用 UTC 时间，精确到秒
Authorization	String	是	签名值。内容如下： `HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的 SessionToken，使用长期密钥时无需填写该参数

Authorization 中各字段含义如下：

名称	类型	描述
AccessKeyId	String	请求的 Access Key ID。请前往秘钥管理获取
ShortDate	String	请求的短时间，使用 UTC 时间，精确到日。格式为 YYYYMMDD，例如：20201103
Region	String	请求的 Region。对于边缘计算节点产品，可填写默认值 cn-north-1
Service	String	请求的服务。对于边缘计算节点产品，需填写 veenedge
SignedHeaders	String	参与签名的 Header，用分号分隔
Signature	String	计算完毕的签名

名称	类型	是否必选	描述
X-Date	String	是	使用 UTC 时间，精确到秒，例如：20201103T104027Z
X-Algorithm	String	是	固定值：HMAC-SHA256
X-Credential	String	是	由 `{AccessKeyId}/{ShortDate}/{Region}/{Service}/request` 组成
X-SignedHeaders	String	是	参与签名的 Header，用分号分隔
X-Signature	String	是	计算完毕的签名

Action 与 Version

签名参数

放置在请求 Header

放置在请求 Query