- Release Notes and Announcements
- User Tutorial
- Product Introduction
- Purchase Guide
- Getting Started
- Event Source
- Event
- Event Bus
- Event Rule
- Event Target
- Practical Tutorial
- API Documentation
- FAQs
- Contact Us
- EB Policy
- Release Notes and Announcements
- User Tutorial
- Product Introduction
- Purchase Guide
- Getting Started
- Event Source
- Event
- Event Bus
- Event Rule
- Event Target
- Practical Tutorial
- API Documentation
- FAQs
- Contact Us
- EB Policy
1. API Description
Domain name for API request: eb.tencentcloudapi.com.
This API is used to query logs.
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: SearchLog. |
| Version | Yes | String | Common Params. The value used for this API: 2021-04-16. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| StartTime | Yes | Integer | Query start time (UNIX in ms) |
| EndTime | Yes | Integer | Query end time (UNIX in ms) |
| EventBusId | Yes | String | Event bus ID |
| Page | Yes | Integer | Page number |
| Limit | Yes | Integer | Logs returned per page |
| Filter.N | No | Array of LogFilter | Filter conditions |
| OrderFields.N | No | Array of String | Sorting array |
| OrderBy | No | String | Sorting order. Values: asc (earliest first); desc (latest first) |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total number of logs Note: This field may return·null, indicating that no valid values can be obtained. |
| Limit | Integer | Number of entries per page. Note: This field may return·null, indicating that no valid values can be obtained. |
| Page | Integer | Page number Note: This field may return·null, indicating that no valid values can be obtained. |
| Results | Array of SearchLogResult | Log searching results Note: This field may return·null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Searching for logs
This example shows you how to search for logs.
Input Example
{
"StartTime": 1673233483024,
"EndTime": 1673838283024,
"EventBusId": "eb-xxxxx",
"Page": 1,
"Limit": 1000
}
Output Example
{
"Response": {
"RequestId": "584caa6b-26d8-4ba5-858d-df1182730075",
"Results": [
{
"Timestamp": "xxx",
"Message": "xxx-1",
"Source": "xxx",
"Type": "xzz",
"RuleIds": "xxx",
"Subject": "xxx",
"Region": "xxx",
"Status": "xxx"
}
],
"Total": 1000,
"Limit": 500,
"Page": 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.
- 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. |
| InvalidParameterValue.Action | The Action value is invalid. |
| ResourceNotFound | The resource does not exist. |
Yes
No
Was this page helpful?