Last updated: 2019-06-26 20:07:59

1. API Description

Domain name for API request:

This API (DescribeMachines) is used to get the list of regional hosts.

Default request rate limit: 20/sec.

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: 2/28/2018
Region No String Common parameter. This parameter is not required for this API.
MachineType Yes String Host type.
  • CVM: Cloud virtual machine
  • BM: Cloud physical machine
  • MachineRegion Yes String Region to which the host belongs, such as ap-guangzhou, and ap-shanghai.
    Limit No Integer Number of returned results. It defaults to 10. The maximum is 100.
    Offset No Integer Offset. It defaults to 0.
    Filters.N No Array of Filter Filter.
  • Keywords - String - Required: No - Query keywords
  • Status - String - Required: No - Client status (OFFLINE: Offline | ONLINE: Online)
  • Version - String - Required: No - Current protection version (PRO_VERSION: Pro | BASIC_VERSION: Basic)

  • Only one value is allowed for each filter. Querying multiple values using "OR" relationship is not supported.

    3. Output Parameters

    Parameter Name Type Description
    Machines Array of Machine Host list.
    TotalCount Integer Number of hosts.
    RequestId String The unique ID of a request, which is required for each troubleshooting case.

    4. Example

    Example 1 Get the list of regional hosts

    Input example
    &<Common request parameters>

    Output example

      "Response": {
        "TotalCount": 100,
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "Machines": [
            "IsProVersion": true,
            "MachineOs": "centos6.5",
            "Uuid": "9c6cd943-dbc1-4011-a74c-x4d9d26a7891",
            "MachineName": "h2-stevenyu",
            "PayMode": "PREPAY",
            "Quuid": "6b6cd843-6bc1-4011-a74c-dc3fd26a7dd1",
            "MachineStatus": "ONLINE",
            "MachineWanIp": "",
            "MachineIp": "",
            "VulNum": 10

    5. Resources for Developers

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using cloud APIs.

    6. Error Codes

    The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Parameter parsing error.
    MissingParameter A parameter is missing.