DescribeAssetMachineList

Download PDF

DescribeAssetMachineList

Last updated: 2024-12-06 15:42:05

Download PDF

1. API Description

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

This API is used to obtain the resource monitoring list of the asset fingerprint page.

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: DescribeAssetMachineList.
Version	Yes	String	Common Params. The value used for this API: 2018-02-28.
Region	No	String	Common Params. This parameter is not required.
Filters.N	No	Array of Filter	Filter criteria MachineName Host name InstanceID Instance ID IP Private or public IP address OsType - String - required: no - Windows or Linux CpuLoad - Int - required: no - 0: unknown; 1: low load; 2: medium load; 3: high load DiskLoad - Int - required: no - 0: 0% or unknown; 1: 0%-20%; 2: 20%～50% 3: 50%～80% 4: 80%～100% MemLoad - Int - required: no - 0: 0% or unknown; 1: 0%-20%; 2: 20%～50% 3: 50%～80% 4: 80%～100% Quuid: Host QUUID Os - String required: no - operating system (value of DescribeMachineOsList)
Limit	No	Integer	Number of results to be returned. Default value: 10. Maximum value: 100.
Offset	No	Integer	Offset. Default value: 0.
Order	No	String	Sorting method: asc for ascending order or desc for descending order
By	No	String	Optional sorting method [FirstTime\|PartitionCount]

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	Total number
Machines	Array of AssetMachineBaseInfo	Record list Note: This field may return null, indicating that no valid values can be obtained.
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 Resource Monitoring List

This example shows you how to obtain the resource monitoring list.

Input Example

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

{}

Output Example

{
    "Response": {
        "Total": 1,
        "Machines": [
            {
                "Quuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                "Uuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                "MachineIp": "10.0.0.11",
                "MachineName": "test-name",
                "OsInfo": "CentOs Bit64",
                "Cpu": "Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz",
                "MemSize": 1,
                "MemLoad": "49",
                "DiskSize": 1,
                "DiskLoad": "41",
                "PartitionCount": 1,
                "MachineWanIp": "110.84.0.11",
                "ProjectId": 1,
                "CpuSize": 1,
                "CpuLoad": "Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz",
                "Tag": [
                    {
                        "Rid": 0,
                        "Name": "test-name",
                        "TagId": 1
                    }
                ],
                "UpdateTime": "2024-10-11 12:23:34",
                "IsNew": 0,
                "FirstTime": "2024-10-11 12:23:34",
                "MachineExtraInfo": {
                    "WanIP": "110.84.0.11",
                    "PrivateIP": "10.0.0.11",
                    "NetworkType": 0,
                    "NetworkName": "vpc-12341234",
                    "InstanceID": "ins-aj28fjz",
                    "HostName": "test-name"
                }
            }
        ],
        "RequestId": "37b6df34-68f1-4ab8-a3d8-7b89de604c82"
    }
}

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
InternalError	Internal error
InvalidParameter	Incorrect parameter.
InvalidParameter.MissingParameter	Missing parameter.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Missing parameter error.

tencent cloud

Recent Pages

DescribeAssetMachineList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Obtaining Resource Monitoring List

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeAssetMachineList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Obtaining Resource Monitoring List

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?