接口请求域名: captcha.intl.tencentcloudapi.com 。
新建IP白名单国际:您可以基于不同业务需求创建IP白名单。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateIpWhiteListInternational。 |
| Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Name | 是 | String | ip白名单名称 |
| CaptchaAppid | 是 | Integer | captchaAppid |
| Ip | 是 | String | ip数据 |
| Comment | 否 | String | 备注信息 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Integer | 结果数据 |
| IdList | Array of Integer | IP白名单资源id |
| 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: CreateIpWhiteList
<公共请求参数>
{
"Name": "abc",
"CaptchaAppid": 179000003,
"Ip": "127.0.0.1",
"Comment": "abc"
}
{
"Response": {
"Data": 0,
"CaptchaCode": 0,
"CaptchaMsg": "",
"RequestId": "637bbeab-43c8-4074-96af-0d0e66f95ba0",
"IdList": [
2100000000
]
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation.ErrAuth | 鉴权失败。 |
| UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
文档反馈