Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

DescribeClientException

Last updated: 2024-12-06 15:40:39

Download PDF

1. API Description

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

This API is used to obtain client exception events.

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: DescribeClientException.
Version	Yes	String	Common Params. The value used for this API: 2018-02-28.
Region	No	String	Common Params. This parameter is not required.
ExceptionType	Yes	Integer	Client Exception Type 1: Client Offline, 2: Client Uninstallation
Offset	Yes	Integer	Pagination offset
Limit	Yes	Integer	Limit per Page, not 0, up to 100
StartTime	No	String	Start time in the format of `2006-01-02 15:04:05`
EndTime	No	String	End time in the format of `2006-01-02 15:04:05`

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of events
Records	Array of RecordInfo	Event details
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 1

Input Example

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

{
    "EndTime": "",
    "Limit": "10",
    "ExceptionType": "1",
    "StartTime": "",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "Records": [
            {
                "HostIP": "172.23.16.2",
                "InstanceID": "ins-kz85kljw",
                "Uuid": "2e6353e4-0498-450a-9be5-77e2537247f6",
                "OfflineTime": "2022-04-24T17:52:37+08:00",
                "UninstallTime": "2020-11-21 15:16:00",
                "UninstallCmd": "sh ******"
            }
        ],
        "RequestId": "1248a7df-c3fe-4930-b3ff-2af956cf8d66",
        "TotalCount": 944
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

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

tencent cloud

Recent Pages

DescribeClientException

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Example 1

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

DescribeClientException

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Example 1

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?