公共请求头部
最近更新时间: 2024-12-19 17:12:00
描述
此篇文档将为您介绍在使用 API 时候会使用到的公共请求头部(Request Header),下文提到的头部会在之后的具体 API 文档中不再赘述。
请求头部列表
Header名称 | 描述 | 类型 | 必选 |
Authorization | 携带鉴权信息, 用以验证请求合法性的签名信息。针对公有读的文件,无需携带此头部。 | String | 否 |
Content-Length | RFC 2616 中定义的 HTTP 请求内容长度(字节),常用于 PUT 类型的 API 的操作。 | String | 否 |
Content-Type | RFC 2616 中定义的 HTTP 请求内容类型(MIME),例如text/plain。 | String | 否 |
Content-MD5 | RFC 1864 中定义的经过 Base64 编码的 128-bit 内容 MD5 校验值。此头部用来校验文件内容是否发生变化。 | String | 否 |
Date | RFC 1123 中定义的 GMT 时间,例如 Wed, 30 Mar. 2016 23:00:00 GMT。 | String | 否 |
Expect | 当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容。该选项可以被用于验证头部是否有效,而无需发送数据内容。 有效值:100-continue。 | String | 否 |
Host | 请求的主机,形式为 -.cos..myqcloud.com。 | String | 是 |
服务端加密专用头部
对于支持服务端加密(Server Side Encryption,SSE)的接口,根据不同的加密方式适用如下请求头部,请参阅具体的接口文档确定是否适用 SSE。下列头部的是否必选仅针对使用 SSE 的场景,如果请求不支持 SSE 的接口或不使用 SSE ,则以下头部均无需携带。详情请参见 服务端加密概述。
SSE-COS
Header 名称 | 描述 | 类型 | 是否必选 |
x-cos-server-side-encryption | 服务端加密算法,使用 SSE-COS 时根据所选加密算法可指定为 AES256 或 SM4 | string | 上传或复制对象(包括简单上传/复制与分块上传/复制)时必选,下载对象时不能指定此头部 |
SSE-KMS
Header 名称 | 描述 | 类型 | 是否必选 |
x-cos-server-side-encryption | 服务端加密算法,使用 SSE-KMS 时根据所选加密算法可指定为 cos/kms 或 cos/kms/sm4 | string | 上传或复制对象(包括简单上传/复制与分块上传/复制)时必选,下载对象时不能指定此头部 |
x-cos-server-side-encryption-cos-kms-key-id | 当 x-cos-server-side-encryption 值为 cos/kms 或 cos/kms/sm4 时,用于指定 KMS 的用户主密钥 CMK,如不指定,则使用 CSP 默认创建的 CMK,更多详细信息可参见 SSE-KMS 加密 | string | 否 |
SSE-C
Header 名称 | 描述 | 类型 | 是否必选 |
x-cos-server-side-encryption-customer-algorithm | 服务端加密算法,目前仅支持 AES256 | string | 是 |
x-cos-server-side-encryption-customer-key | 服务端加密密钥的 Base64 编码,例如`MDEyMzQ1Njc4OUFCQ0RFRjAxMjM0NTY3ODlBQkNERUY=` | string | 是 |
x-cos-server-side-encryption-customer-key-MD5 | 服务端加密密钥的 MD5 哈希值,使用 Base64 编码,例如`U5L61r7jcwdNvT7frmUG8g==` | string | 是 |