Tenant Cloud Security Cloud Workload Protection Platform Other APIs DescribeGeneralStat

DescribeGeneralStat

Last Updated At: 2026-08-03 00:04:49

1. Interface Description

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

API for querying server-related statistics

Default interface request rate limit: 20 times per second.

Interface update time: 2022-08-19 10:10:24.

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: DescribeGeneralStat
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.
Filters No No Array of Filters Filter parameter CloudFrom. 0: cloud platform; 1: other; 2: Alibaba Cloud; 3: Huawei Cloud; 4: Amazon; 5: Microsoft; 6: Google; 7: Oracle; 8: DigitalOcean; 9: Baidu.
Example:View
MachineRegion No No String Region of a server.
Example: ap-region1
MachineType No No String Cloud host type.
  • CVM: Cloud Virtual Machine.
  • BM: Bare Metal Service.
  • ECM: Edge Computing Machine.
  • LH: Cloud Platform Lighthouse.
  • Other: Hybrid cloud machines.

    • Example: CVM

    3. Output Parameters

    Parameter name Type Description
    AddedOnTheFifteen Uint64 Number of servers that were added within the last 15 days.
    Example: 12
    AgentsAll Uint64 Total number of CWP agents.
    Example: 2
    AgentsBasic Uint64 Total number of CWP agents of the Basic Edition.
    Example: 15
    AgentsOffline Uint64 Total number of offline and shutdown CWP agents.
    Example: 4
    AgentsOnline Uint64 Total number of online CWP agents.
    Example: 8
    AgentsPro Uint64 Total number of CWP agents of the Professional Edition.
    Example: 5
    AgentsProExpireWithInSevenDays Uint64 Total number of prepaid CWP Pro agents that will expire in 7 days.
    Example: 27
    FlagshipMachineCnt Uint64 Total number of servers with CWP Ultimate.
    Example: 1
    MachinesAll Uint64 Total number of cloud servers.
    Example: 100
    MachinesUninstalled Uint64 Total number of cloud servers on which no CWP agent is installed.
    Example: 3
    Offline Uint64 Total number of offline servers.
    Example: 0
    ProtectDays Uint64 Protection period. Unit: days.
    Example: 1
    RiskMachine Uint64 Total number of servers at risk.
    Example: 6
    Shutdown Uint64 Total number of shutdown servers.
    Example: 0
    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.InvalidFormat Incorrect parameter format.
    MissingParameter Missing parameter.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.