1. API Description
Domain name for API request: pts.intl.tencentcloudapi.com.
This API is used to query logs in performance testing, including engine logs and console 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.
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: DescribeNormalLogs. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2021-07-28. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| ProjectId |
Yes |
String |
Project ID. |
| ScenarioId |
Yes |
String |
Scenario ID. |
| JobId |
Yes |
String |
Job ID. |
| Context |
No |
String |
Context is used when loading more logs. Pass through the Context value returned last time to retrieve subsequent log content. The expiration time is 1 hour. |
| From |
No |
Timestamp ISO8601 |
Log start time. |
| To |
No |
Timestamp ISO8601 |
Log end time. |
| SeverityText |
No |
String |
Log level, valid values are debug, info, error. |
| Instance |
No |
String |
IP of pressure engine instance. |
| InstanceRegion |
No |
String |
Region of pressure engine instance, such as ap-shanghai, ap-guangzhou. |
| LogType |
No |
String |
Type of log, in which 'console' represents user output, 'engine' represents engine output. |
| Limit |
No |
Integer |
Number of returned logs, maximum 100. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Context |
String |
Log context, used when loading more logs. Pass through the Context value returned last time to retrieve subsequent log content. The expiration time is 1 hour.
Note: This field may return null, indicating that no valid value is found. |
| NormalLogs |
Array of NormalLog |
Array of logs.
Note: This field may return null, indicating that no valid value is found. |
| 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
Query logs in performance testing
POST / HTTP/1.1
Host: pts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNormalLogs
<Common request parameters>
{
"ProjectId": "project-fjs583kq",
"ScenarioId": "scenario-q63bkqsa",
"JobId": "job-657v4tmi",
"LogType": "console"
}
Output Example
{
"Response": {
"Context": "123-456-789",
"NormalLogs": [],
"RequestId": "nes5mdwkfrbfhbpjrs4ox6ck41xjn9jp"
}
}
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 |
| AuthFailure |
CAM signature/authentication error. |
| FailedOperation |
Operation failed. |
| FailedOperation.ResourceNotFound |
The resource does not exist. |
| InternalError |
Internal error. |
| InvalidParameter |
Invalid parameter. |
| ResourceNotFound |
The resource does not exist. |