DescribeMachineList

Download

Focus Mode

Font Size

Last updated: 2026-10-09 16:11:26

1. API Description

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

This API is used to get the regional host list for web tamper protection.

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: DescribeMachineList.
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	CVM type. CVM: Represent a virtual host BM: Represent a physical machine ECM: indicates Edge Computing Server LH: indicates Tencent Cloud Lighthouse Other: Indicates Hybrid cloud machines.
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 AssetFilters	Filter criteria. Keywords - String - required: no - query by keywords Status - String - required: no - client online status (OFFLINE: offline \| ONLINE: online \| UNINSTALLED: not installed) Version - String - required: no - current protection version (PRO_VERSION: Professional edition \| BASIC_VERSION: Basic edition) Only one value is allowed for each filter criterion. Multiple values with the OR relationship are not supported for queries.

3. Output Parameters

Parameter Name	Type	Description
Machines	Array of Machine	List of hosts
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 get the regional host list by the API (DescribeMachines).

Input Example

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

{
    "MachineType": "CVM",
    "MachineRegion": "ap-guangzhou"
}

Output Example

{
    "Response": {
        "Machines": [
            {
                "MachineName": "stone",
                "MachineOs": "Windows",
                "MachineStatus": "ONLINE",
                "Uuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76",
                "Quuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76",
                "VulNum": 0,
                "MachineIp": "172.16.20.1",
                "IsProVersion": true,
                "MachineWanIp": "1.2.2.3",
                "PayMode": "PREPAY",
                "MalwareNum": 0,
                "Tag": [
                    {
                        "Rid": 0,
                        "Name": "tag1",
                        "TagId": 1
                    }
                ],
                "BaselineNum": 0,
                "CyberAttackNum": 0,
                "SecurityStatus": "SAFE",
                "InvasionNum": 0,
                "RegionInfo": {
                    "RegionCode": "gz",
                    "Region": "ap-guangzhuo",
                    "RegionId": 1,
                    "RegionName": "Guangzhou",
                    "RegionNameEn": "chine guangzhou"
                },
                "InstanceState": "TERMINATED_PRO_VERSION",
                "LicenseStatus": 1,
                "ProjectId": 0,
                "HasAssetScan": 1,
                "MachineType": "CVM",
                "KernelVersion": "6.4",
                "ProtectType": "BASIC_VERSION",
                "CloudTags": [
                    {
                        "TagKey": "tag1",
                        "TagValue": "tag2"
                    }
                ],
                "IsAddedOnTheFifteen": 1,
                "IpList": "1.2.3.4",
                "VpcId": "vpc-intc",
                "MachineExtraInfo": {
                    "WanIP": "49.233.15.7",
                    "PrivateIP": "172.18.16.41",
                    "NetworkType": 0,
                    "NetworkName": "vpc-9m7rhl6w",
                    "InstanceID": "ins-7m0suost",
                    "HostName": "txy-app-pre-node1"
                },
                "InstanceId": "vpc-intc",
                "Remark": "remark"
            }
        ],
        "TotalCount": 1,
        "RequestId": "fbd6ea2c-1894-47b0-bf3e-095c78138f76"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.APIServerFail
InternalError	Internal error
InvalidParameter
InvalidParameter.InvalidFormat
InvalidParameter.MissingParameter
InvalidParameter.ParsingError
InvalidParameterValue
MissingParameter

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Workload Protection Platform