tencent cloud

APIs

ModifyLoginWhiteCustomEDR

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

1. API Description

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

Modify the CSC abnormal login custom allowlist with full coverage saving (fields not passed are deemed as cleared). This API does not trigger historical alarm rescanning. Exclude itself during deduplication. If the rule does not exist, return ResourceNotFound.

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: ModifyLoginWhiteCustomEDR.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Id No Integer

Rule ID; for self-learning, it is the rule group ID (minimum line ID in the group)

MemberId.N No Array of String

Group account member id

SrcIp No String

Login source IP. Use commas (,) to separate multiple items. Supports individual IPs, intervals (a-b), and CIDR. Supports IPv4 and IPv6. Up to 2048 characters.

UserName No String

Login username separated by commas; up to 1024 characters

StartTime No String

Login time start HH:MM; it must be filled in or left empty simultaneously with EndTime

EndTime No String

Login period end HH:MM; must be filled in or empty at the same time as StartTime

Places.N No Array of LoginWhitePlaceInput

List of common login locations, up to 200. Set ProvinceId/CityId to 99999 to indicate all provinces/all cities.

Remark No String

Remark, up to 255 characters

Scope No Integer

Effective asset scope: 0-specified hosts (host or tag hit) 1-all hosts

InstanceIDsWithAppId.N No Array of InstanceIDWithAppIdItem

List of specified hosts (in instance ID form), up to 10,000 items. The server translates them to QUUIDs via idmap, then merges and deduplicates them with QUUIDSWithAppId.

ExcludeInstanceIDsWithAppId.N No Array of InstanceIDWithAppIdItem

List of hosts (instance ID form) to remove, up to 10,000 items

TagIDs.N No Array of String

Security center tag ID list, up to 100. When Scope=0, it is in an OR relationship with the host. Self-learning allowlist does not support taking effect by tag (a non-empty value will be rejected).

TargetAppIDs.N No Array of Integer

Target appid

DealOldEvents No Integer

Whether to add historical alarm data to whitelist

3. Output Parameters

Parameter Name Type Description
FailedAppIds Array of Integer

Failed account

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 ModifyLoginWhiteCustomEDR

Modify exception logon custom allowlist (full coverage, no rescan)

Input Example

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

{
    "Id": 2,
    "Places": [
        {
            "CountryId": 1,
            "ProvinceId": 1,
            "CityId": 1
        }
    ],
    "Remark": "Remark 3",
    "Scope": 0,
    "InstanceIDsWithAppId": [
        {
            "AppId": 260199983,
            "InstanceID": "ins-2zltluch"
        }
    ],
    "TargetAppIDs": [
        260199983
    ]
}

Output Example

{
    "Response": {
        "FailedAppIds": [],
        "RequestId": "356104a2-3d15-49aa-baed-106a76dbaf2c"
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
ResourceNotFound The resource does not exist.

帮助和支持

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

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

文档反馈