更新时间:2024-04-19 GMT+08:00

公共消息头

公共请求消息头

表1 公共请求消息头

参数名

说明

是否必选

示例

Content-type

消息体的类型(格式),默认取值为“application/json”

application/json

X-Project-Id

project id,用于不同project取token,获取方法请参见获取项目ID/账号名/AK/SK

e9993fc787d94b6c886cbaa340f9c0f4

X-Auth-Token

用户Token,也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

使用Token认证时必选。

-

X-Sdk-Date

请求的发生时间,格式为(YYYYMMDD'T'HHMMSS'Z')。

取值为当前系统的GMT时间。

如果使用AK/SK做接口认证的时候,那么此字段必须设置;如果使用PKI token的时候,不必设置。

20190307T101459Z

Authorization

签名认证信息。

该值来源于请求签名结果,使用AK/SK进行加密签名的时候需要。

类型:字符串

默认值:无

使用AK/SK认证时必选。AK/SK认证请参见认证鉴权

SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994

Host

请求的服务器信息,从服务API的URL中获取。

值为hostname[:port]。

端口缺省时使用默认的端口,https的默认端口为443。

使用AK/SK认证时必选。

code.test.com

or

code.test.com:443

其它header属性,请遵照https协议。

公共响应消息头

表2 公共响应消息头

消息头名称

说明

是否必选

Content-Type

用于指明发送给接收者的实体正文的媒体类型。

类型:字符串。

默认值:application/json; charset=UTF-8

X-request-id

此字段携带请求ID号,以便任务跟踪。

类型:字符串。request_id-timestamp-hostname(request_id在服务器端生成UUID, timestamp为当前时间戳,hostname为处理当前接口的服务器名称)。

默认值:无。

X-ratelimit

此字段携带总计流控请求数。

类型:整型。

默认值:无。

X-ratelimit-used

此字段携带剩下请求数。

类型:整型。

默认值:无。

X-ratelimit-window

此字段携带流控单位。

类型:字符串。单位按照分钟、小时、天。

默认值:小时。