You need to enable JavaScript to run this app.
导航
公共参数
最近更新时间:2024.06.24 20:30:02首次发布时间:2024.06.24 20:30:02

本文档介绍了证书中心私有CA服务OpenAPI的公共参数。

公共参数是每个API请求必须包含的参数。如果一个API请求缺失公共参数,请求会失败。

请求头

以下表格中的公共参数必须包含在请求头(header)中。

参数类型是否必选描述
RegionString服务地区。该参数的取值是 cn-north-1
ServiceNameString服务名称。该参数的取值是 pca

查询字符串

以下表格中的公共参数必须包含在查询字符串(query string)中。

参数类型是否必选描述
ActionString表示API名称。名称格式为 [a-zA-Z]+。
VersionString表示API版本。该参数的取值是 2023-05-01
X-Expiresint表示签名的有效时间,单位是秒。该参数的默认值是 900

签名参数

公共参数还包含签名参数 Signature。该签名参数可以包含在请求头中,也可以包含在查询字符串中。推荐您将签名参数包含在请求头中。

(推荐)在请求头中包含该签名参数

您可以在请求头中包含该签名参数。当包含在请求头中,签名参数 SignatureAuthorization 参数所表示的结构体的一部分。请求头必须包含以下参数。

参数类型是否必选描述示例值

X-Date

String

表示签名计算的时间,以 UTC 表示。时间精度是秒。

关于该参数,您需要留意以下内容:

  • 在请求到达时,证书中心会计算请求到达时间与 X-Date 之间的差距。如果差距超过 X-Expires 指定的时间范围,证书中心判定该请求无效。因此,在计算签名前,建议您校准系统时间。

20210913T081805Z

AuthorizationString该参数表示一个结构体。结构体中包含了签名参数 Signature。参见 Authorization

Authorization

Authorization 的伪代码结构如下:

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

Authorization 伪代码中的 Signature 参数表示签名。关于 Signature 参数的计算步骤,参见签名计算机制。关于 Authorization 伪代码中其他参数的说明,参见伪代码中参数的说明

在查询字符串中包含该签名参数

您可以在查询字符串中包含该签名参数。当包含在查询字符串中,签名参数的名称是 X-Signature。查询字符串需要包含以下参数。

参数类型是否必选描述示例值

X-Date

String

表示签名计算的时间,以 UTC 表示。时间精度是秒。

关于该参数,您需要留意以下内容:

  • 在请求到达时,证书中心会计算请求到达时间与 X-Date 之间的差距。如果差距超过 X-Expires 指定的时间范围,证书中心判定该请求无效。因此,在计算签名前,建议您校准系统时间。

20210913T081805Z

X-AlgorithmString表示签名计算所使用的算法。该参数的值是 HMAC-SHA256HMAC-SHA256
X-CredentialString参见 X-CredentialAKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZkYzE/20210913/cn-north-1/CDN/request

X-SignedHeaders

String

表示参与签名计算的请求头参数。多个请求头参数使用分号(;)分隔。这些请求头参数是根据参数名称升序排序的。X-SignedHeadersSignedHeaders 参数的定义是相同的。在您计算 CanonicalRequest 的参数值的时候需要使用 X-SignedHeaders

一般来说,X-SignedHeaders 的值是 host;x-content-sha256;x-date。您也可以指定任意请求头参数作为 X-SignedHeaders 的值。

host;x-content-sha256;x-date

X-SignatureString表示签名。关于签名的计算步骤,参见签名计算机制

X-Credential

X-Credential 的伪代码结构如下:

{AccessKey}/{ShortDate}/{Region}/{Service}/{Request}

关于 X-Credential伪代码中参数的说明,参见伪代码中参数的说明