文档中心

公共参数

最近更新时间：2023.10.08 19:44:29

首次发布时间：2023.08.24 19:59:28

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

Action & Version

名称	类型	是否必填	描述	示例
Action	string	是	接口名称，格式为 `[a-zA-Z]+`。	CreateCloudServer
Version	string	是	接口版本信息，以具体接口说明为准，格式为 `YYYY-MM-DD`。	2022-05-12

说明

签名参数是请求必不可少的部分，既可以在 Query 当中，也可以在 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	请求的短时间，精确到日。格式为 YYYYMMDD。	20210430
Region	string	请求的地域。对于边缘托管产品，可填写默认值`cn-north-1`。更多 Region 信息，请参见地域和可用区列表。	cn-north-1
Service	string	请求的服务。对于边缘托管产品，需填写`veecp_openapi`。	veecp_openapi
SignedHeaders	string	参与签名的 Header，用分号分隔。	详情参考签名机制
Signature	string	计算完毕的签名。	详情参考签名机制

名称	类型	是否必填	描述	示例
X-Date	string	是	使用 UTC 时间，精确到秒。	20201103T104027Z
X-Algorithm	string	是	固定值：HMAC-SHA256。	HMAC-SHA256
X-Credential	string	是	{AccessKey}/{ShortDate}/{Region}/{Service}/request	详情参考签名机制
X-SignedHeaders	string	是	参与签名的 Header，用分号分隔。	详情参考签名机制
X-Signature	string	是	计算完毕的签名。	详情参考签名机制

Action & Version

签名参数

签名参数放置在请求 Header

签名参数放置在请求 Query