文档服务 公共请求头部(页面导航)

此篇文档将介绍在使用 API 时会使用到的公共请求头部(Request Header),下面提到的头部在之后的具体 API 文档中不再赘述。

相关产品
文档服务 产品页,含版本规格、价格与购买入口。

一、描述

此篇文档将为你介绍在使用 API 时会使用到的公共请求头部(Request Header),下文提到的头部在之后的具体 API 文档中不再赘述。

二、请求头部列表

Header 名称 描述 类型 是否必选
Authorization 携带鉴权信息,用以验证请求合法性的签名信息。针对公有读的对象可不携带此头部,如通过请求参数传递鉴权信息也无需携带此头部,详情请参见 请求签名 文档。 string 否。针对私有读的对象,此头部是必选项。
Content-Length RFC 2616中定义的 HTTP 请求内容长度(字节)。 integer 否。针对 PUT 和 POST 请求,此头部是必选项。
Content-Type RFC 2616中定义的 HTTP 请求内容类型(MIME),例如 application/xml。 string 否。针对有请求体的 PUT 和 POST 请求,此头部是必选项。
Content-MD5 RFC 1864中定义的经过 Base64编码的请求体内容 MD5哈希值,例如 ZzD3iDJdrMAAb00lgLLeig==。此头部用于完整性检查,验证请求体在传输过程中是否发生变化。 string 否
Date RFC 1123中定义的 GMT 格式当前时间,例如Wed, 29 May 2019 04:10:12 GMT。 string 否
Host 请求的主机,包含三种域名形式:<BucketName-APPID>.cos.<Region>.myqcloud.com<BucketName-APPID>.ci.<Region>.myqcloud.com<BucketName-APPID>.pic.<Region>.myqcloud.com不同 API 接口使用不同的形式,具体使用哪种形式,可见 API 文档中的参数示例说明。 string 是
x-cos-security-token 使用临时安全凭证时需要传入的安全令牌字段,详情请参见 临时安全凭证 相关说明。与 x-ci-security-token 二选一,根据不同的 Host 进行选择,cos 域名需要使用 x-cos-security-token,ci 和 pic 域名可使用 x-ci-security-token 或 x-cos-security-token。 string 否。当使用临时密钥并通过 Authorization 携带鉴权信息时,此头部为必选项。
x-ci-security-token 使用临时安全凭证时需要传入的安全令牌字段,计算方法与x-cos-security-token相同,详情请参见 临时安全凭证 相关说明。与 x-cos-security-token 二选一,根据不同的 Host 进行选择,cos 域名需要使用 x-cos-security-token,ci 和 pic 域名可使用 x-ci-security-token 或 x-cos-security-token。 string 否。当使用临时密钥并通过 Authorization 携带鉴权信息时,此头部为必选项。
赞 (0)
上一篇 4天前
下一篇 4天前