tencent cloud

APIs

DescribeLoginWhiteCombinedList

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-01 10:20:54

1. API Description

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

This API is used to obtain the list of cross-region log-in allowlists after merge.

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: DescribeLoginWhiteCombinedList.
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.

Limit No Integer

Number of items to return. The default number is 10, and the maximum number is 100.

Offset No Integer

Offset. Default value: 0.

Filters.N No Array of EDRFilter

Filter criteria. IpOrAlias - String - Required: No - host ip or alias filter. UserName - String - Required: No - UserName filter. SrcIP - String - Required: No - source ip filtering. Location - String - Required: No - login Location filter. ModifyBeginTime - String - Required: No - filter by modification time range, start time. ModifyEndTime - String - Required: No - filter by modification time range, end time.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total quantity.

LoginWhiteCombinedInfos Array of LoginWhiteCombinedInfo

Merged allowlist.

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 Obtaining the Log-in Audit Allowlist List (Filtering by Version Supported)

This example shows you how to obtain the log-in audit allowlist list (filtering by version supported).

Input Example

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

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

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "be6f6eec-0825-4e67-ab9a-c8568bbf736c",
        "LoginWhiteCombinedInfos": [
            {
                "Id": 357790160,
                "Places": [
                    {
                        "CityId": 0,
                        "ProvinceId": 0,
                        "CountryId": 52,
                        "Location": "Algeria"
                    }
                ],
                "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": "Algeria,Albania,Austria,Haiti,Aland Islands,Antigua and Barbuda",
                "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. 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.
InvalidParameter.MissingParameter InvalidParameter.MissingParameter
InvalidParameter.ParsingError InvalidParameter.ParsingError
InvalidParameterValue Parameter value error.
MissingParameter Parameters are missing.
ResourceNotFound The resource does not exist.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan