tencent cloud

All product documents
APIs
DocumentationAPIsPerformance Testing ServicePTS-related APIsDescribeScenarioWithJobs
DescribeScenarioWithJobs
Last updated: 2025-03-17 11:03:20
DescribeScenarioWithJobs
Last updated: 2025-03-17 11:03:20

1. API Description

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

This API is used to query scenarios with executed jobs.

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: DescribeScenarioWithJobs.
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.
Offset No Integer Offset. Default value is 0.
Limit No Integer Number of returns. Default value is 20, maximum is 100.
ProjectIds.N No Array of String Array of Project ID.
ScenarioIds.N No Array of String Array of Scenario ID.
ScenarioName No String Scenario Name.
ScenarioStatus No Integer Array of Scenario status.
OrderBy No String Column for sorting.
Ascend No Boolean Whether in ascending order.
ScenarioRelatedJobsParams No ScenarioRelatedJobsParams Parameters related to job.
IgnoreScript No Boolean Whether to return the test script content of the scenario.
IgnoreDataset No Boolean Whether to return test data file information of the scenario.
ScenarioType No String Scenario type, such as pts-http, pts-js, pts-jmeter.
Owner No String Creator.

3. Output Parameters

Parameter Name Type Description
ScenarioWithJobsSet Array of ScenarioWithJobs Scenario configuration with related jobs.

Note: This field may return null, indicating that no valid value is found.
Total Integer Total Scenarios.
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 Scenarios and Job Content

This example shows you how to query scenarios and jobs.

Input Example

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

{
    "ScenarioIds": [
        "scenario-44dlxys2"
    ],
    "ScenarioRelatedJobsParams": {
        "OrderBy": "StartTime",
        "Limit": 10,
        "Ascend": true
    }
}

Output Example

{
    "Response": {
        "RequestId": "xx",
        "ScenarioWithJobsSet": [
            {
                "Scenario": {
                    "AppId": 251201585,
                    "Uin": "700000153395",
                    "SubAccountUin": "700000153395",
                    "CreatedAt": "2021-09-27T10:46:26+08:00",
                    "UpdatedAt": "2021-09-27T10:46:26+08:00",
                    "ScenarioId": "scenario-44dlxys2",
                    "Name": "hello",
                    "Type": "pts-js",
                    "Load": {
                        "LoadSpec": {
                            "Concurrency": {
                                "Stages": [
                                    {
                                        "DurationSeconds": 60,
                                        "TargetVirtualUsers": 10
                                    }
                                ],
                                "IterationCount": 5,
                                "MaxRequestsPerSecond": 1000
                            }
                        },
                        "VpcLoadDistribution": {
                            "Region": "ap-guangzhou",
                            "RegionId": 1,
                            "VpcId": "1",
                            "SubnetIds": null
                        },
                        "GeoRegionsLoadDistribution": [
                            {
                                "Region": "1",
                                "RegionId": 1,
                                "Percentage": 1
                            }
                        ]
                    },
                    "EncodedScripts": "",
                    "Description": "this is a test",
                    "Status": 2,
                    "Configs": [
                        "a.prop"
                    ],
                    "Datasets": [
                        {
                            "Name": "a.csv",
                            "UpdatedAt": null,
                            "Size": 0,
                            "LineCount": 5,
                            "HeaderInFile": true,
                            "Split": true,
                            "HeaderColumns": null
                        }
                    ],
                    "Extensions": [
                        "a.jar"
                    ],
                    "ProjectId": "1",
                    "SLAId": "",
                    "CronId": ""
                },
                "Jobs": [
                    {
                        "ErrorRate": 0,
                        "RequestTotal": 0,
                        "ResponseTimeAverage": 0,
                        "ResponseTimeP99": 0,
                        "ResponseTimeP95": 0,
                        "ResponseTimeP90": 0,
                        "JobId": "job-j4j0t76k",
                        "ScenarioId": "scenario-44dlxys2",
                        "Type": "pts-js",
                        "Load": {
                            "LoadSpec": {
                                "Concurrency": {
                                    "Stages": [
                                        {
                                            "DurationSeconds": 60,
                                            "TargetVirtualUsers": 10
                                        }
                                    ],
                                    "IterationCount": 5,
                                    "MaxRequestsPerSecond": 1000
                                }
                            },
                            "VpcLoadDistribution": {
                                "Region": "ap-guangzhou",
                                "RegionId": 1,
                                "VpcId": "1",
                                "SubnetIds": null
                            },
                            "GeoRegionsLoadDistribution": [
                                {
                                    "Region": "1",
                                    "RegionId": 1,
                                    "Percentage": 1
                                }
                            ]
                        },
                        "Scripts": [
                            "a.js"
                        ],
                        "Configs": [
                            "a.prop"
                        ],
                        "Datasets": [
                            {
                                "Name": "a.csv",
                                "UpdatedAt": null,
                                "Size": 0,
                                "LineCount": 5,
                                "HeaderInFile": true,
                                "Split": true,
                                "HeaderColumns": null
                            }
                        ],
                        "Extensions": [
                            "a.jar"
                        ],
                        "StartTime": "2021-09-27T13:50:52+08:00",
                        "EndTime": "2021-09-28T14:00:52+08:00",
                        "Note": "",
                        "JobOwner": "lucas",
                        "Status": 5,
                        "Duration": 60,
                        "MaxVirtualUserCount": 10,
                        "MaxRequestsPerSecond": 1000,
                        "LoadSources": null
                    }
                ]
            }
        ],
        "Total": 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.

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.DbQueryFailed Failed to query database.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
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