Tenant Cloud Security Cloud Workload Protection Platform Asset Management APIs DescribeMachines

DescribeMachines

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 the list of servers in a specified region.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-10-18 17:27:47.

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: DescribeMachines
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 Filter Filtering conditions.
  • Ips - String - required: no - query by IP address.
  • Names - String - required: no - query by instance name.
  • InstanceIds - String - required: no - query by instance ID.
  • Status - String - required: no - client status (OFFLINE: offline/shut down 
    		•
    Limit No No Uint64 Number of items returned. The default value is 10, and the maximum value is 100.
    Example: 10
    MachineRegion Yes No String Region of a server.
    Example: ap-region1
    MachineType Yes No String Zone type of the server. 
    CVM: CVM zone
    BM: BM zone
    ECM: ECM zone
    LH: Lighthouse zone
    Other: hybrid cloud zone.
    Example: CVM
    Offset No No Uint64 Offset. Default value: 0.
    Example: 0
    ProjectIds No No Array of Uint64 List of business IDs to which the machine belongs.
    Example: [1]

    3. Output Parameters

    Parameter name Type Description
    Machines Array of Machine Server list
    Example:View
    TotalCount Uint64 Number of hosts.
    Example: 10
    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.
    MissingParameter Missing parameter.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.