You need to enable JavaScript to run this app.
导航

公共参数

最近更新时间2024.04.17 17:16:07

首次发布时间2022.05.11 11:26:47

本文介绍每个接口都需要使用的请求参数和返回参数。

请求头参数

参数名

类型

是否必选

含义

Content-Length

Integer

可选

RFC2616 中定义的请求内容,不包含消息头长度。

Content-Type

String

可选

指定了请求消息体的结构化格式,日志服务的 Content-Type 固定为 application/json

Host

String

可选

即服务地址 Endpoint。日志的服务不同地域的服务地址不同,详细说明请查看服务地址

X-Tls-Apiversion

String

可选

操作的 API 的版本。默认为 0.3.0,支持设置为 0.2.0 或 0.3.0。
其中,0.3.0 版本中的 SearchLogs 接口支持的 SQL 函数语法将持续更新,0.2.0 版本中的 SearchLogs 接口仅支持部分早期上线的 SQL 函数,此接口后续将不再更新。

X-Date

String

必选

这是您发出请求的日期和时间。在请求中指定日期有助于防止第三方拦截您的请求并稍后重新提交。该日期使用 UTC 时间,精确到秒,格式为 YYYYMMDD'T'HHMMSS'Z',例如 20201103T104027Z。

Authorization

String

必选

HTTP 标准身份认证头部字段。
格式为HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

Authorization 字段说明如下。

参数名

类型

是否必选

含义

AccessKeyId

String

必选

访问服务使用的密钥 ID,即 Access Key ID。

ShortDate

String

必选

请求服务时的 UTC 短时间,精确到日。格式为 YYYYMMDD,例如 20180201。

Region

String

必选

访问的服务地域 ID,例如 cn-beijing。日志服务支持的地域列表请查看服务地址

ServiceName

String

必选

访问的服务名称,日志服务服务名称为 TLS

SignedHeaders

String

必选

参与签名的 Header,用分号分隔。

Signature

String

必选

计算完毕的签名结果字符串。如何计算签名,请参考签名机制