主机安全获取异地登录白名单合并后列表-API 文档-文档中心-腾讯云

1. 接口描述

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

获取异地登录白名单合并后列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLoginWhiteCombinedList。
Version	是	String	公共参数，本接口取值：2018-02-28。
Region	否	String	公共参数，此参数为可选参数。
Limit	否	Integer	需要返回的数量，默认为10，最大值为100 示例值：10
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of Filter	过滤条件。 IpOrAlias - String - 是否必填：否 - 主机ip或别名筛选 UserName - String - 是否必填：否 - 用户名筛选 SrcIP - String - 是否必填：否 - 来源IP筛选 Location - String - 是否必填：否 - 登录地筛选 ModifyBeginTime - String - 是否必填：否 - 按照修改时间段筛选，开始时间 ModifyEndTime - String - 是否必填：否 - 按照修改时间段筛选，结束时间示例值：[{"ExactMatch": false, "Name": "Uuid", "Values": ["loginwhite****"]}]

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总数量示例值：12
LoginWhiteCombinedInfos	Array of LoginWhiteCombinedInfo	合并后的白名单列表示例值：[ { "Id": 357790160, "Places": [ { "CityId": 0, "ProvinceId": 0, "CountryId": 52, "Location": "阿尔及利亚" } ], "UserName": "root", "SrcIp": "1.1.1.1", "IsGlobal": 0, "CreateTime": "2019-12-25 11:57:15", "ModifyTime": "2019-12-25 11:57:15", "Locale": "", "Locations": "", "Remark": "myremark***", "StartTime": "2020-11-21 15:16:00", "EndTime": "2020-11-21 15:16:00", "Name": "cwp", "Desc": "1.1.1.1", "Uuid": "be6f6eec-0825-4e67-ab9a-c8568bbf736c" } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取登录审计白名单列表-支持新版本筛选

获取登录审计白名单列表-支持新版本筛选

输入示例

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

{
    "Limit": "10",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "be6f6eec-0825-4e67-ab9a-c8568bbf736c",
        "LoginWhiteCombinedInfos": [
            {
                "Id": 357790160,
                "Places": [
                    {
                        "CityId": 0,
                        "ProvinceId": 0,
                        "CountryId": 52,
                        "Location": "阿尔及利亚"
                    }
                ],
                "UserName": "root",
                "SrcIp": "1.1.1.1",
                "IsGlobal": 0,
                "CreateTime": "2019-12-25 11:57:15",
                "ModifyTime": "2019-12-25 11:57:15",
                "Locale": "52:0:0,103:0:0,141:0:0,165:0:0,210:0:0,177:0:0",
                "Locations": "阿尔及利亚,阿尔巴尼亚,奥地利,海地,奥兰群岛,安提瓜和巴布达",
                "Remark": "myremark***",
                "StartTime": "2020-11-21 15:16:00",
                "EndTime": "2020-11-21 15:16:00",
                "Name": "cwp",
                "Desc": "1.1.1.1",
                "Uuid": "be6f6eec-0825-4e67-ab9a-c8568bbf736c"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.MissingParameter	参数缺失。
InvalidParameter.ParsingError	参数解析错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。