Tenant Cloud Security Cloud Workload Protection Platform Intrusion Detection - APIs of Logins from Unusual Locations DescribeHostLoginList

DescribeHostLoginList

Last Updated At: 2026-08-02 00:05:00

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

API for querying login audits

Default interface request rate limit: 20 times per second.

Interface update time: 2022-06-06 17:19:32.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeHostLoginList
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
By No No String Field for sorting. LoginTime: occurrence time.
Example: LoginTime
Filters No No Array of Filter Filtering conditions. 
  • Quuid - String - required: no - CVM UUID.
    •  
  • Uuid - String - required: no - CWP unique UUID.
    •  
  • MachineName - String - required: no - host alias.
    •  
  • Ip - String - required: no - host IP address.
    •  
  • InstanceID - String - required: no - host instance ID.
    •  
  • SrcIp - String - required: no - filter by source IP address.
    •  
  • UserName - String - required: no - filter by username.
    •  
  • Status - String - required: no - filter by status: 1: logged in normally; 5: allowlisted; 14: processed; 15: ignored.
    •  
  • LoginTimeBegin - String - required: no - filter by modification time; start time.
    •  
  • LoginTimeEnd - String - required: no - filter by modification time; end time.
    •  
  • RiskLevel - String - required: no - filter by risk level: 0: high; 1: suspicious.

    • Example:View
    Limit No No Uint64 Maximum number of entries to return. Maximum value: 100.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 1
    Order No No String Sorting order. asc: ascending order. desc: descending order.
    Example: asc

    3. Output Parameters

    Parameter name Type Description
    HostLoginList Array of HostLoginList List of login audits.
    Example:View
    TotalCount Uint64 Total number.
    Example: 12
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InternalError Internal error.
    InvalidParameter.ParsingError Parameter parsing error.
    InvalidParameter.MissingParameter Missing parameter.
    MissingParameter Missing parameter.
    InvalidParameter.DateRange The time range format is incorrect.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.