公共参数
最近更新时间:2026-03-19 18:16:28
公共参数是用于标识用户和接口签名的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
1. 公共参数说明
公共参数需要统一放到 HTTP Header 请求头部中,如下:
| 名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| Authorization | String | 是 | HTTP 标准身份认证头部字段。例如:CT-HMAC-SHA256 Credential={AccessKeyId}/{Date}/vss, SignedHeaders=content-type;host;timestamp, Signature=d74a04362e6a848f5b39b15421cb449427f419c95a480fd6b8cf9fc783e2999e。其中,CT-HMAC-SHA256:签名方法,目前固定取该值。Credential:签名凭证,AccessKeyId 是访问密钥 ID,Date 是 UTC 标准时间的日期,一律采用 YYYY-MM-DD 格式,取值需要和公共参数 Timestamp 换算的 UTC 标准时间日期一致。SignedHeaders:参与签名计算的头部信息。Signature:签名摘要,计算过程详见签名方法。 |
| Content-Type | String | 是 | 内容类型。 |
| Host | String | 是 | 访问主机。 |
| Version | String | 是 | API 版本号。格式:YYYY-MM-DD。本版本对应为 2021-11-25。 |
| Timestamp | Integer | 是 | 当前系统时间戳,可记录发起 API 请求的时间。例如:1645679518。如果与当前时间相差过大(前后5分钟),会引起签名过期错误。 |
2. 公共参数请求示例
HTTP Header (application/json) 请求结构示例:
{
"Authorization": "CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1P****/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f",
"Content-Type": "application/json;charset=utf-8",
"Host": "vssapi.ctyun.cn",
"Version": "2021-11-25",
"Timestamp": "1689643309"
}
本页目录: