tencent cloud

All product documents
APIs
DocumentationAPIsPerformance Testing ServicePTS-related APIsDescribeSampleLogs
DescribeSampleLogs
Last updated: 2025-03-17 11:03:26
DescribeSampleLogs
Last updated: 2025-03-17 11:03:26

1. API Description

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

This API is used to query sampled request logs.

A maximum of 30 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: DescribeSampleLogs.
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 levels, such as debug, info, error.
InstanceRegion No String Region of pressure engine instance, such as ap-shanghai, ap-guangzhou.
Instance No String IP of pressure engine instance.
LogType No String Type of log, can be left empty. 'Request' represents sampling logs.
Limit No Integer Number of returned logs, maximum 100.
ReactionTimeRange No ReactionTimeRange Response time range of sampling logs.
Status No String Status code of sampling logs.
Result No String Result code of sampling logs.
Method No String Request method of sampling logs.
Service No String Request service of sampling logs.

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of logs.
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.
SampleLogs Array of SampleLog Array of request 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

Example1 Query sampling logs

Query sampling logs

Input Example

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

{
    "ProjectId": "project-fjs583kq",
    "ScenarioId": "scenario-q63bkqsa",
    "JobId": "job-657v4tmi",
    "LogType": "request"
}

Output Example

{
    "Response": {
        "RequestId": "85f22814-36b9-44e0-bfaa-18fad9accaf8",
        "Total": 10,
        "Context": "12353-2432423",
        "SampleLogs": []
    }
}

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon