tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeMachinesSimple

Last updated: 2024-08-27 11:43:51

1. API Description

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

This API is used to obtain the list of hosts.

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 Params. The value used for this API: DescribeMachinesSimple.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
MachineType Yes String Type of the machine's zone
CVM: Cloud Virtual Machine
BM: BM
ECM: Edge Computing Machine
LH: Lighthouse
Other: Hybrid Cloud Zone
MachineRegion Yes String Machine region. For example, ap-guangzhou and ap-shanghai.
Limit No Integer Number of entries to be returned. Default value: 10. Maximum value: 100.
Offset No Integer Offset. Default value: 0.
Filters.N No Array of Filter Filtering criteria
  • Keywords - String - required: no - keywords for querying
  • Version - String required: no - current protection edition ( PRO_VERSION: Pro Edition | BASIC_VERSION: Basic Edition | Flagship: Ultimate Edition | ProtectedMachines: Pro + Ultimate Editions | UnFlagship: Non-Ultimate Edition | PRO_POST_PAY: Pro Edition in pay-as-you-go mode | PRO_PRE_PAY: Pro Edition in monthly subscription mode)
  • TagId - String - required: no - tag ID
    • ProjectIds.N No Array of Integer ID list of businesses to which machines belong

    3. Output Parameters

    Parameter Name Type Description
    Machines Array of MachineSimple Host list
    TotalCount Integer Number of Hosts
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining the List of Hosts in a Specific Region

    This example shows you how to obtain the list of hosts in a specific region.

    Input Example

    POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMachinesSimple
<Common request parameters>

{
    "Limit": "10",
    "MachineRegion": "ap-shanghai",
    "MachineType": "CVM",
    "Filters": [
        {
            "Values": [
                "10.0.1.1"
            ],
            "Name": "Keywords"
        }
    ],
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "Machines": [
            {
                "KernelVersion": "xx",
                "IsProVersion": false,
                "MachineOs": "xx",
                "Uuid": "xx",
                "MachineName": "xx",
                "MachineIp": "xx",
                "PayMode": "xx",
                "RegionInfo": {
                    "RegionCode": "xx",
                    "Region": "xx",
                    "RegionId": 1,
                    "RegionNameEn": "xx",
                    "RegionName": "xx"
                },
                "Tag": [
                    {
                        "TagId": 1,
                        "Rid": 0,
                        "Name": "xx"
                    }
                ],
                "Quuid": "xx",
                "ProtectType": "xx",
                "ProjectId": 1,
                "MachineWanIp": "xx",
                "InstanceState": "xx",
                "MachineType": "xx",
                "LicenseOrder": null,
                "CloudTags": []
            }
        ]
    }
}

    5. Developer Resources

    SDK

    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 Incorrect parameter.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy