tencent cloud

All product documents
APIs
DocumentationAPIsPerformance Testing ServicePTS-related APIsStartJob
StartJob
Last updated: 2025-03-17 11:03:15
StartJob
Last updated: 2025-03-17 11:03:15

1. API Description

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

This API is used to create and start test job.

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: StartJob.
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.
ScenarioId Yes String Scenario ID.
JobOwner Yes String Job initiator.
ProjectId Yes String Project ID.
Debug No Boolean If is debug mode.
Note No String Note.

3. Output Parameters

Parameter Name Type Description
JobId String Job ID.
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 Create and start task

Create and start task

Input Example

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

{
    "ProjectId": "project-xx",
    "JobOwner": "xiaohong",
    "ScenarioId": "scenario-xx"
}

Output Example

{
    "Response": {
        "RequestId": "req-xx",
        "JobId": "job-xx"
    }
}

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.DbRecordCreateFailed Failed to create database record.
FailedOperation.DbRecordUpdateFailed Failed to update database record.
FailedOperation.NoTasksInJob No task in the job.
FailedOperation.NotSupportedInEnv The current environment does not support.
FailedOperation.ResourceNotFound The resource does not exist.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit is exceeded.
ResourceInsufficient Insufficient resources.
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