Last updated: 2020-09-11 10:41:07

    1. API Description

    Domain name for API request:

    This API is used to get the list of servers in a specified region.

    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 parameter. The value used for this API: DescribeMachines.
    Version Yes String Common parameter. The value used for this API: 2018-02-28.
    Region No String Common parameter. This parameter is not required for this API.
    MachineType Yes String Server type.
  • CVM: CVM
  • BM: BM
  • MachineRegion Yes String Server region, such as ap-guangzhou or ap-shanghai
    Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.
    Filters.N No Array of Filter Filter.
  • Keywords - String - Required: no - Query keywords
  • Status - String - Required: no - CWP client status (valid values: OFFLINE, ONLINE, UNINSTALLED)
  • Version - String - Required: no - Current CWP version (valid values: PRO_VERSION, BASIC_VERSION)

  • Each filter can have only one value but does not support "OR" queries with multiple values

    3. Output Parameters

    Parameter Name Type Description
    Machines Array of Machine Server list
    TotalCount Integer Number of servers
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the list of servers in region

    This example shows you how to get the list of servers in a region.

    Input Example
    &<Common request parameters>

    Output Example

      "Response": {
        "Machines": [
            "MachineName": "ccs_cls-i4vyo8qa_node",
            "MachineIp": "",
            "MachineWanIp": "",
            "MachineOs": "ubuntu16.04.1 LTSx86_64",
            "MachineStatus": "OFFLINE",
            "Quuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76",
            "Uuid": "",
            "IsProVersion": false,
            "PayMode": "",
            "VulNum": 0,
            "Tag": [],
            "MalwareNum": 0,
            "BaseLineNum": 0,
            "CyberAttackNum": 0,
            "SecurityStatus": "SAFE"
            "MachineName": "piperpeng-mnet",
            "MachineIp": "",
            "MachineWanIp": "",
            "MachineOs": "centos7.5x86_64",
            "MachineStatus": "ONLINE",
            "Quuid": "d095145f-d417-49a7-8d83-da19320fd419",
            "Uuid": "ecc9dfd0-674b-11e9-950f-40f2e9f553a2",
            "IsProVersion": false,
            "PayMode": "",
            "VulNum": -1,
            "Tag": [
                "Rid": 174,
                "Name": "Forest"
            "MalwareNum": -1,
            "BaseLineNum": 0,
            "CyberAttackNum": 0,
            "SecurityStatus": "UNKNOWN"
            "MachineName": "jaryzhou-hp",
            "MachineIp": "",
            "MachineWanIp": "",
            "MachineOs": "centos7.2x86_6