Tenant Cloud Security Cloud Workload Protection Platform Asset Management APIs DescribeMachineInfo

DescribeMachineInfo

Last Updated At: 2026-08-02 00:04:58

1. Interface Description

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

This API is used to get server details.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-05-20 15:11:35.

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: DescribeMachineInfo
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.
Quuid No No String QUUID. You must specify at least one of the Quuid and Uuid parameters.
Example: e5b4724c-49af-46ab-bd84-cdbae897e7e0
Uuid No No String CWP client UUID.
Example: e5b4724c-49af-46ab-bd84-cdbae897e7e0

3. Output Parameters

Parameter name Type Description
AgentVersion String Agent version number.
Example: 10
FreeMalwaresLeft Uint64 Number of free trojan detections remaining.
Example: 1
FreeVulsLeft Uint64 Number of free vulnerability detections remaining.
Example: 1
HasAssetScan Uint64 Whether there is an asset scan record. 0: no. 1: yes.
Example: 1
InstanceId String Unique identifier of the CVM or BM host.
Example: CVM
IsProVersion Bool Whether to enable the professional version.
  • true: yes.
  • false: no.

    • Example: false
    MachineIp String Machine IP.
    Example: 10.0.0.0
    MachineName String Host name.
    Example: redis_node_cvm
    MachineOs String Operating system.
    Example: Windows Server 2022
    MachineRegion String Region of a server.
    Example: ap-region1
    MachineStatus String Status.
  • ONLINE: online.
  • OFFLINE: Offline.

    • Example: OFFLINE
    MachineType String CVM type.
  • CVM: CVM.
  • BM: Bare Metal Service.
  • ECM: Edge Computing Machine.
  • LH: Cloud Platform Lighthouse.
  • Other: Hybrid cloud machines.

    • Example: CVM
    MachineWanIp String Public IP of the host.
    Example: 10.0.0.0
    PayMode String Host status.
  • POSTPAY: postpaid mode, that is, pay-as-you-go.  
  • PREPAY: prepaid mode, that is, monthly subscription.

    • Example: PREPAY
    ProVersionDeadline String Expiration time of the professional version (only valid for prepaid mode).
    Example: 2025-10-17 20:08:03
    ProVersionOpenDate String Time when the professional version was enabled.
    Example: 2024-10-17 20:08:03
    ProtectDays Uint64 Protection duration in days by CWP.
    Example: 1
    ProtectType String Protection edition: BASIC_VERSION - Basic Edition; PRO_VERSION - Pro Edition; Flagship - Ultimate Edition; GENERAL_DISCOUNT - General Edition.
    Example: BASIC_VERSION
    Quuid String Unique UUID of the CVM or BM host.
    Example: e5b4724c-49af-46ab-bd84-cdbae897e7e0
    Uuid String CWP client UUID.
    Example: e5b4724c-49af-46ab-bd84-cdbae897e7e0
    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.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    ResourceNotFound The resource does not exist.
    InvalidParameterValue The parameter value is invalid.