tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyLoginWhiteRecord

Last updated: 2024-08-27 11:45:59

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to update the log-in audit allowlist information. (The number of server lists needs to be less than 1,000.)

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: ModifyLoginWhiteRecord.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
UserName Yes String Allowlisted users (Multiple users are separated by commas.)
SrcIp Yes String Allowlisted dimension information recorded after the update
StartTime Yes String Start time
EndTime Yes String End time
Remark Yes String Remarks
IsGlobal Yes Integer Whether it applies to all servers: 0: no; 1: yes
Id Yes Integer Allowlist ID
Hosts.N No Array of HostInfo Server list
Places.N No Array of Place Region list

3. Output Parameters

Parameter Name Type Description
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 Editing Log-in Audit Allowlist

This example shows you how to edit the log-in audit allowlist.

Input Example

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

{
    "UserName": "abc",
    "SrcIp": "abc",
    "StartTime": "abc",
    "EndTime": "abc",
    "Remark": "abc",
    "IsGlobal": 1,
    "Id": 1,
    "Hosts": [
        {
            "Quuid": "abc",
            "Uuid": "abc"
        }
    ],
    "Places": [
        {
            "CityId": 1,
            "ProvinceId": 1,
            "CountryId": 1,
            "Location": "abc"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "4234234"
    }
}

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 Incorrect parameter.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameter.RuleHostDuplicateErr Rule-based API with duplicate hosts.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy