tencent cloud

APIs

DescribeLoginWhiteLearnListEDR

下载
聚焦模式
字号
最后更新时间: 2026-11-10 20:05:13

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

This API is used to query the CSC abnormal login self-learning allowlist (rule group). Rule groups are aggregated by (AppId, common login location), and the ID is the minimum line ID in the group. The output fields SrcIp, UserName, StartTime, and EndTime are always empty. AutoLearnEnable returns the self-learning switch state for the frontend to determine whether to redirect to enable it based on the empty state.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeLoginWhiteLearnListEDR.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
MemberId.N No Array of String

Group account member id

Filters.N No Array of EDRFilter

Filter condition array (multiple Filters have an AND relationship). Supports Name: Keyword or Location (common login location blurry), Remark, ModifyBeginTime, ModifyEndTime (time format 2006-01-02 15:04:05); unknown Name is ignored with no error reported

Limit No Integer

Page size. Default: 10. Upper limit: 100. If 0 or more than 100 is passed, the default or upper limit is used.

Offset No Integer

Pagination offset. Default value: 0.

Order No String

Sorting order: ASC - ascending, DESC - descending (not case-sensitive). Default: DESC

By No String

Sorting field: CreateTime-creation time, ModifyTime-last modified. Default: ModifyTime. If an illegal value is passed, InvalidParameter is returned.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total number of rule groups (aggregated by AppId + common login location)

List Array of LoginWhiteItem

Self-learning allowlist rule group list (Type is always Learn). If empty, [] is returned.

AutoLearnEnable Boolean

Self-learning allowlist switch status; for multi-account, the current account is used to prompt the frontend to go to enable in the empty state

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.

4. Example

Example1 DescribeLoginWhiteLearnListEDR

Query the self-learning allowlist for abnormal logins

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoginWhiteLearnListEDR
<Common request parameters>

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

Output Example

{
    "Response": {
        "TotalCount": 1,
        "AutoLearnEnable": true,
        "List": [
            {
                "Type": "Learn",
                "AppId": 1250000000,
                "Id": 42383278,
                "SrcIp": "",
                "UserName": "",
                "StartTime": "",
                "EndTime": "",
                "Places": [
                    {
                        "CountryId": 1,
                        "ProvinceId": 19,
                        "CityId": 197,
                        "Location": "China - Guangdong - Shenzhen"
                    },
                    {
                        "CountryId": 1,
                        "ProvinceId": 99999,
                        "CityId": 99999,
                        "Location": "China-all provinces"
                    }
                ],
                "Locations": "China - Guangdong - Shenzhen, China - all provinces",
                "Scope": 0,
                "QUUIDS": [
                    "cd7eba4e-3a35-4e3d-aa41-8fce6c46e8ff"
                ],
                "InstanceIDs": [
                    "ins-xxxxxxxx"
                ],
                "ExcludeQUUIDS": [],
                "ExcludeInstanceIDs": [],
                "TagItems": [],
                "HostCount": 1,
                "Remark": "",
                "CreateTime": "2026-10-20 09:00:00",
                "ModifyTime": "2026-10-21 09:00:00"
            }
        ],
        "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.

帮助和支持

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

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

文档反馈