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


1. API Description

Domain name for API request:

This API (DescribeMachineInfo) is used to get details about a host.

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: DescribeMachineInfo.
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.
Uuid No String Unique Uuid of the HS client.

3. Output Parameters

Parameter Name Type Description
MachineIp String Host IP.
ProtectDays Integer Number of days when HS is under protection.
MachineOs String Operating system.
MachineName String Host name.
MachineStatus String Host status.
  • ONLINE: Online
  • OFFLINE: Offline
  • InstanceId String Unique ID of a CVM or BM.
    MachineWanIp String Host public IP.
    Quuid String Unique Uuid of a CVM or BM.
    Uuid String Unique Uuid of the HS client.
    IsProVersion Boolean Indicates whether HS Pro is activated.
  • true: Yes
  • false: No
  • ProVersionOpenDate String Time when HS Pro is activated.
    MachineType String Host type.
  • CVM: Cloud virtual machine
  • BM: Cloud physical machine
  • MachineRegion String Region to which the host belongs, such as ap-guangzhou, and ap-shanghai.
    PayMode String Billing mode.
  • POSTPAY: Postpaid
  • PREPAY: Prepaid
  • RequestId String The unique ID of a request, which is required for each troubleshooting case.

    4. Example

    Example 1 Get details about a host

    Input example
    &<Common request parameters>

    Output example

      "Response": {
        "PayMode": "PREPAY",
        "IsProVersion": true,
        "MachineWanIp": "",
        "Uuid": "e3fcbf68-3bd6-11e8-8954-0819a624c497",
        "RequestId": "ad31cc35-8523-42a2-93e0-b733ad247daa",
        "InstanceId": "ins-ibqb87x3",
        "MachineName": "Developer machine",
        "ProtectDays": 120,
        "MachineRegion": "ap-guangzhou",
        "MachineOs": "3.10.0-327.36.3.el7.x86_64",
        "Quuid": "56af8eea-5a2a-4f0c-81ca-47208e7cd9b2",
        "MachineStatus": "ONLINE",
        "MachineType": "CVM",
        "MachineIp": "",
        "ProVersionOpenDate": "2018-07-30 12:34:22"

    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.
    ResourceNotFound Resource does not exist.