DescribeUnusualEvent
1. API Description
Domain name for API request: trtc.tencentcloudapi.com.
This API (the old DescribeAbnormalEvent) is used to query up to 20 random abnormal user experiences of an application (SDKAppID) in the last 14 days. The start and end time can be on two different days, but they cannot be more than one hour apart.
For details about the error events, see https://intl.cloud.tencent.com/document/product/647/44916?from_cn_redirect=1
Note:
- You can use this API to query historical data or for reconciliation purposes, but we do not recommend you use it for crucial business logic.
- If you need to call this API, please upgrade the monitoring dashboard version to "Standard". For more details, please refer to: https://www.tencentcloud.com/document/product/647/54481.
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: DescribeUnusualEvent. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-guangzhou, ap-mumbai, ap-singapore, na-toronto. |
| SdkAppId | Yes | Integer | The application ID, such as 1400xxxxxx. |
| StartTime | Yes | Integer | The start time, which is a Unix timestamp (seconds) in local time, such as 1590065777.Note: Only data in the last 14 days can be queried. |
| EndTime | Yes | Integer | The end time, which is a Unix timestamp (seconds) in local time, such as 1590065877. The end time and start time cannot be more than one hour apart. |
| RoomId | No | String | The room ID. Up to 20 random abnormal user experiences of the specified room will be returned. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | The number of records returned. Value range: 0-20. |
| AbnormalExperienceList | Array of AbnormalExperience | The information of the abnormal user experiences. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying abnormal user experiences
Input Example
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUnusualEvent
<Common request parameters>
{
"StartTime": 1590065777,
"SdkAppId": 1400188366,
"EndTime": 1590065877,
"RoomId": "461"
}
Output Example
{
"Response": {
"AbnormalExperienceList": [
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448600,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2011,
"PeerId": ""
},
{
"AbnormalEventId": 2012,
"PeerId": ""
}
]
},
{
"UserId": "itachili1",
"RoomId": "461",
"EventTime": 1592448600,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2011,
"PeerId": ""
},
{
"AbnormalEventId": 2012,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448660,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2011,
"PeerId": ""
},
{
"AbnormalEventId": 2012,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448720,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2011,
"PeerId": ""
},
{
"AbnormalEventId": 2012,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448780,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2011,
"PeerId": ""
},
{
"AbnormalEventId": 2012,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448600,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2014,
"PeerId": ""
},
{
"AbnormalEventId": 2021,
"PeerId": ""
},
{
"AbnormalEventId": 2022,
"PeerId": ""
},
{
"AbnormalEventId": 2011,
"PeerId": "itachili1"
},
{
"AbnormalEventId": 2012,
"PeerId": "itachili1"
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448600,
"ExperienceId": 5,
"AbnormalEventList": [
{
"AbnormalEventId": 2014,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448660,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2014,
"PeerId": ""
},
{
"AbnormalEventId": 2021,
"PeerId": ""
},
{
"AbnormalEventId": 2022,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448660,
"ExperienceId": 5,
"AbnormalEventList": [
{
"AbnormalEventId": 2014,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448720,
"ExperienceId": 4,
"AbnormalEventList": [
{
"AbnormalEventId": 2014,
"PeerId": ""
},
{
"AbnormalEventId": 2021,
"PeerId": ""
},
{
"AbnormalEventId": 2022,
"PeerId": ""
}
]
},
{
"UserId": "itachi3",
"RoomId": "461",
"EventTime": 1592448720,
"ExperienceId": 5,
"AbnormalEventList": [
{
"AbnormalEventId": 2014,
"PeerId": ""
}
]
}
],
"Total": 11,
"RequestId": "75a3a17f-ca35-4cc8-b42f-2ebb8903b6a7"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| InternalError.DBError | An error occurred while querying the database. |
| InternalError.EsQueryError | An error occurred during an ES query. |
| InternalError.HttpParaseFalied | Failed to parse the HTTP request. |
| InternalError.InterfaceErr | API error. |
| InternalError.MethodErr | Unsupported method. |
| InvalidParameter | Parameter error. |
| InvalidParameter.BodyParamsError | Failed to parse body parameters. |
| InvalidParameter.EncodeParams | Invalid EncodeParams. |
| InvalidParameter.QueryScaleOversize | The query period exceeds the limit. |
| InvalidParameter.SdkAppId | SdkAppId is incorrect. |
| InvalidParameter.SdkAppid | Inoperable SdkAppid. |
| InvalidParameter.StartTimeExpire | The start time for query exceeded the limit. |
| InvalidParameter.StartTs | Invalid StartTs. |
| InvalidParameter.StartTsOversize | The start time for query exceeded the limit. |
| MissingParameter | Missing parameter. |
| MissingParameter.EndTs | endTS_s is missing. |
| MissingParameter.SdkAppId | SdkAppId is missing. |
| MissingParameter.StartTs | startTS_s is missing. |