1. 接口描述
接口请求域名： captcha.tencentcloudapi.com 。
查询单个CaptchaAppID验证的统计数据，包括：请求量、验证量、验证通过量、验证拦截量。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetRequestStatistics。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-22。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CaptchaAppId | 是 | String | 验证码AppId 示例值："19901111" |
| StartTimeStr | 是 | String | 开始时间字符串 示例值："2022-05-14 01:00" |
| EndTimeStr | 是 | String | 结束时间字符串 示例值："2022-06-15 20:00" |
| Dimension | 是 | String | 查询粒度 示例值："3" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | CaptchaStatisticObj | 查询后数据块 注意：此字段可能返回 null，表示取不到有效值。 示例值：{ "ActionTotal": 155, "VerifyTotal": 32, |
| CaptchaCode | Integer | 验证码返回码 示例值：11000 |
| CaptchaMsg | String | 验证码返回信息 示例值："success" |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求和返回示例
查询单个CaptchaAppID验证数据
输入示例
POST / HTTP/1.1
Host: captcha.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRequestStatistics
<公共请求参数>
{
"CaptchaAppId": "\"19901111\"",
"EndTimeStr": "\"2022-08-14 14:00\"",
"StartTimeStr": "\"2022-05-14 10:00\"",
"Dimension": "\"3\""
}输出示例
{
"Response": {
"RequestId": "247b9e9d-abda-41a6-b067-979961aba989",
"Data": null,
"CaptchaCode": 11000,
"CaptchaMsg": ""
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation.ErrAuth | 鉴权失败。 |
| UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
