文档中心 验证码 API 文档 控制台相关接口 安全验证码查询请求数据概况

安全验证码查询请求数据概况

最近更新时间:2019-12-26 16:13:55

1. 接口描述

接口请求域名: captcha.tencentcloudapi.com 。

安全验证码查询请求数据概况,例如:按照时间段查询数据 昨日请求量、昨日恶意比例、昨日验证量、昨日通过量、昨日恶意拦截量……

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCaptchaDataSum
Version String 公共参数,本接口取值:2019-07-22
Region String 公共参数,本接口不需要传递此参数。
CaptchaAppId Integer 验证码应用ID
Start Integer 查询开始时间
End Integer 查询结束时间

3. 输出参数

参数名称 类型 描述
GetSum Integer 请求总量
VfySuccSum Integer 请求验证成功量
VfySum Integer 请求验证量
AttackSum Integer 拦截攻击量
CaptchaMsg String 返回信息
注意:此字段可能返回 null,表示取不到有效值。
CaptchaCode Integer 成功返回0 其它失败
CheckTicketSum Integer 票据校验量
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求和返回示例

输入示例

https://captcha.tencentcloudapi.com/?Action=DescribeCaptchaDataSum
&CaptchaAppId=2010000000
&Start=20191201
&End=20191202
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "c7151640-8351-46d5-86f9-ce886cf37111",
    "CaptchaCode": 0,
    "CaptchaMsg": "OK",
    "GetSum": 123,
    "VfySuccSum": 112,
    "VfySum": 110,
    "AttackSum": 13,
    "CheckTicketSum": 100
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation.ErrAuth 鉴权失败。
UnauthorizedOperation.Unauthorized 未开通权限。