API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 主机安全 > 入侵检测-异常登录相关接口 > 批量添加异地登录白名单

批量添加异地登录白名单

最近更新时间：2024-03-12 01:21:37

我的收藏

本页目录：

1. 接口描述

接口请求域名： cwp.tencentcloudapi.com 。

批量添加异地登录白名单

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：AddLoginWhiteLists。
Version 是 String 公共参数，本接口取值：2018-02-28。
Region 否 String 公共参数，此参数为可选参数。
HostLoginWhiteObj 是 HostLoginWhiteObj 异地登录白名单实体
示例值：[]
ProcessType 否 String 事件同步处理方式：
"" -- 不操作
"All" -- 将符合此配置的所有事件记录加白
"Id" -- 将EventId对应的事件记录加白
示例值：All
EventId 否 Integer 异地登录事件ID，当ProcessType为Id时此项必填
示例值：1

3. 输出参数

参数名称 类型 描述
DuplicateHosts Array of DuplicateHosts 重复添加的提示列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量添加异地登录白名单

入侵检测-登录审计-批量添加异地登录白名单

输入示例

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

{
    "EventId": 11234,
    "ProcessType": "Id",
    "HostLoginWhiteObj": {
        "UserName": "xx",
        "Remark": "xx",
        "Places": [
            {
                "CityId": 0,
                "CountryId": 0,
                "ProvinceId": 135
            }
        ],
        "IsGlobal": 0,
        "HostInfos": [
            {
                "Quuid": "66640e61-aaaa-4632-aaaa-aaaa037e7ba0",
                "Uuid": "66640e61-aaaa-4632-aaaa-aaaa037e7ba0"
            }
        ],
        "StartTime": "00:00",
        "SrcIp": "1.2.3.4",
        "EndTime": "00:01"
    }
}

输出示例

{
    "Response": {
        "RequestId": "4234234",
        "Error": {
            "Code": "InvalidParameter.RuleHostipErr",
            "Message": "无对应主机信息"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.MissingParameter 参数缺失。
InvalidParameter.ParsingError 参数解析错误。
InvalidParameter.RuleHostDuplicateErr 规则类接口，主机重复。
InvalidParameter.RuleHostipErr 规则类接口，主机IP不正确。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
中国站