tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeMachineClearHistory

Last updated: 2024-12-06 15:41:49

1. API Description

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

This API is used to query the clearing history records of a machine.

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: DescribeMachineClearHistory.
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 Filters Filtering criteria
Return entries that match both Keywords and TimeBetween when multiple filtering criteria are used
  • Keywords: instance name, private IP address, public IP address
  • TimeBetween: time interval
    		•
    Limit No Integer Limit Entries, 10 by default, up to 100.
    Offset No Integer Offset. Default value: 0.
    Order No String Ascending order, ASC, Descending order DESC, ASC by default.
    By No String AgentLastOfflineTime: last offline time of client
    AutoClearTime: clearing time

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of entries
    List Array of MachineClearHistory List data
    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 Example

    This example shows you how to query the clearing history of a machine.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "RequestId": "962b0273-cc65-4d20-beac-7510a4dd4737",
        "TotalCount": 2,
        "List": [
            {
                "AgentLastOfflineTime": "2022-08-18 10:25:11",
                "CreateTime": "2022-12-06 18:31:59",
                "Id": 2,
                "InstanceId": "ins-df13****",
                "InstanceName": "new",
                "PrivateIp": "10.0.0.1",
                "PublicIp": "1.1.1.1"
            },
            {
                "AgentLastOfflineTime": "2022-08-29 16:08:03",
                "CreateTime": "2022-12-06 18:32:18",
                "Id": 3,
                "InstanceId": "ins-fmr1m***",
                "InstanceName": "vul-test-123",
                "PrivateIp": "10.0.0.2",
                "PublicIp": "1.1.1.1"
            }
        ]
    }
}

    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
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy