For the complete documentation index, see llms.txt. This page is also available as Markdown.

获取筛查用量

查询筛查用量

get

按 screen 任务统计账户的筛查(screening)用量。可按时间区间和目标类型过滤。如果 startTime 和 endTime 均不传,默认返回当前计费周期(billing cycle)内的用量。

授权
API-Keystring必填
查询参数
startTimeinteger · int64可选

时间区间的起点(含),Unix 秒时间戳。如果 startTime 和 endTime 均不传,则使用当前计费周期。

Example: 1704067200
endTimeinteger · int64可选

时间区间的终点(含),Unix 秒时间戳。如果 startTime 和 endTime 均不传,则使用当前计费周期。

Example: 1706745600
targetstring · enum可选

要统计的目标类型。不传则统计所有类型。

Example: address可能的值:
响应
200

响应。即使 HTTP 状态码为 200,code 非 0 也表示业务错误。

application/json
codeinteger可选

业务状态码。0 表示请求成功,其它值表示失败。业务错误以 HTTP 200 加非 0 code 的形式返回,因此收到 200 并不代表成功,必须检查该字段;鉴权失败与限流则返回非 200 的 HTTP 状态码。两者都需要判断。

Example: 0
msgstring可选

code 为 0 时返回 "Success",否则返回该错误码对应的错误信息。

Example: Success
get/account/usage/screening
GET /phalcon/compliance/v2/account/usage/screening HTTP/1.1
Host: api.blocksec.com
API-Key: YOUR_API_KEY
Accept: */*
{
  "code": 0,
  "msg": "Success",
  "data": {
    "screeningCount": 1234
  }
}

最后更新于