You need to enable JavaScript to run this app.
导航
公共参数
最近更新时间:2023.11.10 17:41:29首次发布时间:2023.11.10 17:41:29

本文介绍了在调用 API 时,必须要传递的公共参数。公共参数一般为 OpenAPI 版本和鉴权等信息,在具体的 API 接口文档中不再重复描述这部分参数,请您在请求 API 时携带这部分参数,否则请求将无法通过合法性验证。
签名参数可以在 Query 中也可以在 Header 中,但 Action 和 Version 必须在 Query 中。

Action 与 Version

参数

类型

是否必填

描述

示例值

Action

String

接口名称。与实际业务的接口名称一致。

CreateBlockRule

Version

String

接口的版本。Web 应用防火墙提供的 OpenAPI 版本为2020-12-092022-12-09。具体请参考对应接口的详细说明。

2022-12-09

Header 签名参数

参数

类型

是否必填

说明

X-Expires

Integer

签名的有效时间,单位为秒,不填时默认值为 900。

X-Date

String

使用 UTC 时间,精确到秒。格式为 YYYYMMDD'T'HHMMSS'Z' ,例如: 20201103T104027Z

Authorization

String

HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}
其中:

  • AccessKeyId (String):发起请求的账号的 Access Key ID。例如:AKLTNGU0OGEyMT***
  • ShortDate (String):请求的短时间,使用 UTC 时间,精确到日。请使用格式: YYYYMMDD,例如:20230201
  • Region (String):请求的地域,例如:cn-beijing。请求地域需要与购买的实例所在地域保持一致。其对应关系可参考地域信息
  • Service (String):请求的服务。Web 应用防火墙提供的 OpenAPI 所属产品为waf
  • SignedHeaders (String):参与签名的 Header,用分号分隔。
  • Signature (String):计算后的签名。例如:da4fac562d00f41ad8***

X-Security-Token

String

指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的 SessionToken,使用长期密钥时无需填写该参数。

Query 签名参数

参数

类型

是否必填

说明

X-Expires

Integer

签名的有效时间,单位为秒,不填时默认值为 900。

X-Date

String

使用 UTC 时间,精确到秒。格式为 YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z。

X-Algorithm

String

固定值:HMAC-SHA256。

X-Credential

String

认证信息,由 {AccessKeyId}/{ShortDate}/{Region}/{Service}/request 组成。
其中:

  • AccessKeyId (String):发起请求的账号的 Access Key ID。
  • ShortDate (String):请求的短时间,使用 UTC 时间,精确到日。请使用格式:YYYYMMDD,例如:20180201。
  • Region (String):请求的地域,例如:cn-beijing。
  • Service (String):请求的服务。

X-SignedHeaders

String

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

X-Signature

String

计算后的签名。