tencent cloud

APIs

文档APIsCaptchaConsole v2.0 APIsModifyIpWhiteListInternational

编辑IP白名单国际

下载
聚焦模式
字号
最后更新时间: 2026-09-08 19:37:53

1. 接口描述

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

编辑IP白名单国际:您可以基于不同业务需求编辑IP白名单。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyIpWhiteListInternational。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,此参数为可选参数。
Name String

ip白名单名称

Id Integer

记录编号

CaptchaAppid Integer

验证码appid

Status Integer

IP白名单状态

枚举值:

  • 0: 开启
  • 1: 关闭
Comment String

备注信息

3. 输出参数

参数名称 类型 描述
Data Integer

结果数据

CaptchaCode Integer

验证码状态码

CaptchaMsg String

验证码信息

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 编辑Ip白名单

输入示例

POST / HTTP/1.1
Host: captcha.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyIpWhiteList
<公共请求参数>

{
    "Name": "内网测试",
    "Status": 1,
    "Id": 1,
    "Comment": "内网测试",
    "CaptchaAppid": 1
}

输出示例

{
    "Response": {
        "Data": 0,
        "CaptchaCode": 0,
        "CaptchaMsg": "success",
        "RequestId": "c634b435-7bfe-4f04-b447-b995a2dd8adb"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation.ErrAuth 鉴权失败。
UnauthorizedOperation.Unauthorized 未开通权限/无有效套餐包/账号已欠费。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈