接口请求域名： captcha.intl.tencentcloudapi.com 。
IP白名单列表国际：您可以基于不同业务需求查询Ip白名单列表。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeIpWhiteListInternational。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-22。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| PageIndex | 是 | Integer | 页码 |
| PageSize | 是 | Integer | 页长 |
| CaptchaAppid | 否 | Integer | 验证码appid |
| Name | 否 | String | 白名单名称 |
| Ip | 否 | String | Ip地址 |
| Status | 否 | Integer | IP白名单配置状态 枚举值：
默认值：0 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeCaptchaIpWhiteListDataNew | 结果数据 |
| CaptchaCode | Integer | 验证码状态码 |
| CaptchaMsg | String | 验证码信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: captcha.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIpWhiteList
<公共请求参数>
{
"Name": "haha",
"PageIndex": 1,
"PageSize": 10,
"CaptchaAppid": 179000009
}{
"Response": {
"RequestId": "c634b435-7bfe-4f04-b447-b995a2dd8adb",
"Data": {
"DataList": [
{
"Id": 173,
"Name": "formdata",
"CaptchaAppid": 199999290,
"Ip": "93.26.59.11",
"Status": 0,
"CreatedTime": "2024-01-30T08:01:59+08:00",
"UpdatedTime": "2024-01-30T08:19:16+08:00",
"Comment": ""
},
{
"Id": 170,
"Name": "formdata",
"CaptchaAppid": 199999290,
"Ip": "127.0.0.1",
"Status": 0,
"CreatedTime": "2024-01-30T07:41:29+08:00",
"UpdatedTime": "2024-01-30T08:19:16+08:00",
"Comment": ""
}
],
"Total": 2,
"PageIndex": 1
},
"CaptchaCode": 0,
"CaptchaMsg": "success"
}
}云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation.ErrAuth | 鉴权失败。 |
| UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
文档反馈