tencent cloud



Last updated: 2020-07-31 11:18:41

1. API Description

Domain name for API request: yunjing.tencentcloudapi.com.

This API is used to get server details.

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: DescribeMachineInfo.
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.
Uuid No String CWP agent Uuid.

3. Output Parameters

Parameter Name Type Description
MachineIp String Server IP.
ProtectDays Integer Days under protection by CWP
MachineOs String OS.
MachineName String Server name.
MachineStatus String Status.
  • ONLINE: online
  • OFFLINE: offline
  • InstanceId String Unique ID of CVM or BM instance.
    MachineWanIp String Public IP of server.
    Quuid String CVM or BM instance Uuid.
    Uuid String CWP agent Uuid.
    IsProVersion Boolean Whether CWP Pro is activated.
  • true: yes
  • false: no
  • ProVersionOpenDate String CWP Pro activation time.
    MachineType String Server type.
  • CVM: CVM
  • BM: BM
  • MachineRegion String Server region, such as ap-guangzhou or ap-shanghai
    PayMode String Server status.
  • POSTPAY: post-paid, i.e., pay-as-you-go
  • FreeMalwaresLeft Integer Number of trojans left for free scan.
    FreeVulsLeft Integer Number of vulnerability left for free scan.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting server details

    This example shows you how to get server details.

    Input Example

    &<Common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

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


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. 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 The resource does not exist.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support