Domain name for API request: captcha.intl.tencentcloudapi.com.
IP allowlist list: You can query the IP whitelist list based on different business needs.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeIpWhiteListInternational. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | No | String | Common Params. This parameter is not required. |
| PageIndex | Yes | Integer | Page number. |
| PageSize | Yes | Integer | Page length. |
| CaptchaAppid | No | Integer | Captcha appid |
| Name | No | String | Allowlist name |
| Ip | No | String | Ip address |
| Status | No | Integer | IP Whitelist Configuration Status Enumeration values:
Default value: 0 |
| Parameter Name | Type | Description |
|---|---|---|
| Data | DescribeCaptchaIpWhiteListDataNew | Result data |
| CaptchaCode | Integer | Captcha status code |
| CaptchaMsg | String | Captcha information |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: captcha.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIpWhiteList
<Common request parameters>
{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| UnauthorizedOperation.ErrAuth | Authentication failed. |
| UnauthorizedOperation.Unauthorized | Operation not authorized/No valid package/The account is overdue |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback