You need to enable JavaScript to run this app.
导航
文件存储 NAS
  • 文档首页
    • /
  • 文件存储 NAS

公共参数

最近更新时间：2023.07.10 11:11:51

首次发布时间：2023.07.10 11:11:51

我的收藏

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

Action 和 Version

说明

Action 和 Version 必须在 Query 当中。

名称类型是否必填示例值描述
ActionString是CreateFileSystem接口名称，表示要执行的操作。文件存储支持的操作列表，请参见 API 概览。
VersionString是2022-01-01接口的版本信息，当前版本为 2022-01-01。
X-ExpiresInt否300签名的有效时间，单位秒，默认为 900 秒。

签名参数

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

在 Header 中的场景

名称类型是否必填描述示例值

X-Date

String

是

使用UTC时间，精确到秒，使用遵循ISO 8601标准的格式：YYYYMMDD'T'HHMMSS'Z'。

20201103T104027Z

AuthorizationString是HTTP 标准身份认证头部字段。 格式为 HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}。HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZkYzE/20201230/cn-north-1/iam/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=28eeabbbd726b87002e0fe58ad8c1c768e619b06e2646f35b6ad7ed029a6d8a7

其中，Authorization 中的信息含义如下表。

名称类型备注
AccessKeyString请求的 AccessKey 信息。查看 AK/SK 信息的具体步骤，请参见查看 AK/SK 信息。
ShortDateString请求的短时间，精确到日。使用 UTC 时间，例如：20180201。
RegionString请求的地域，例如：华北2（北京）：cn-beijing。
ServiceNameString请求的服务，当前为 FileNAS。
SignedHeadersString参与签名的 Header，用分号分隔。
SignatureString计算完毕的签名。签名计算方式详情，请参见签名机制。

在 Query 中的场景

说明

X-Date 与 Authorization 的信息可以直接存在 Query 当中。

名称类型是否必填描述
X-DateString是20201103T104027Z， 使用 UTC 时间，精确到秒。
X-AlgorithmString是固定值， HMAC-SHA256；为将来扩展做准备。
X-CredentialString是由 {AccessKey}/{ShortDate}/{Region}/{Service}/request 组成。
X-SignedHeadersString是参与签名的 Header，用分号分隔。
X-SignatureString是计算完毕的签名。签名计算方式详情，请参见签名机制。

更多详情，请参见公共参数。