com.tencentcloudapi.pts.v20210728

Class PtsClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.pts.v20210728.PtsClient

public class PtsClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
PtsClient(Credential credential, String region)
PtsClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
AbortCronJobsResponse	AbortCronJobs(AbortCronJobsRequest req) This API is used to stop cron jobs.
AbortJobResponse	AbortJob(AbortJobRequest req) This API is used to stop test job.
AdjustJobSpeedResponse	AdjustJobSpeed(AdjustJobSpeedRequest req) This API is used to adjust the target RPS of a job.
CopyScenarioResponse	CopyScenario(CopyScenarioRequest req) This API is used to copy a scenario.
CreateAlertChannelResponse	CreateAlertChannel(CreateAlertChannelRequest req) This API is used to create an alert recipient group.
CreateCronJobResponse	CreateCronJob(CreateCronJobRequest req) This API is used to create a cron job.
CreateEnvironmentResponse	CreateEnvironment(CreateEnvironmentRequest req) This API is used to create an environment.
CreateFileResponse	CreateFile(CreateFileRequest req) This API is used to create a file.
CreateProjectResponse	CreateProject(CreateProjectRequest req) This API is used to create a project.
CreateScenarioResponse	CreateScenario(CreateScenarioRequest req) This API is used to create a scenario.
DeleteAlertChannelResponse	DeleteAlertChannel(DeleteAlertChannelRequest req) This API is used to delete an alert recipient group.
DeleteCronJobsResponse	DeleteCronJobs(DeleteCronJobsRequest req) This API is used to delete cron jobs.
DeleteEnvironmentsResponse	DeleteEnvironments(DeleteEnvironmentsRequest req) This API is used to delete environments.
DeleteFilesResponse	DeleteFiles(DeleteFilesRequest req) This API is used to delete files.
DeleteJobsResponse	DeleteJobs(DeleteJobsRequest req) This API is used to delete jobs.
DeleteProjectsResponse	DeleteProjects(DeleteProjectsRequest req) This API is used to delete projects.
DeleteScenariosResponse	DeleteScenarios(DeleteScenariosRequest req) This API is used to delete scenarios.
DescribeAlertChannelsResponse	DescribeAlertChannels(DescribeAlertChannelsRequest req) This API is used to query alert recipient groups.
DescribeAlertRecordsResponse	DescribeAlertRecords(DescribeAlertRecordsRequest req) This API is used to query alert records.
DescribeAvailableMetricsResponse	DescribeAvailableMetrics(DescribeAvailableMetricsRequest req) This API is used to query all supported metrics.
DescribeCheckSummaryResponse	DescribeCheckSummary(DescribeCheckSummaryRequest req) This API is used to query checkpoint summary information.
DescribeCronJobsResponse	DescribeCronJobs(DescribeCronJobsRequest req) This API is used to list cron jobs, selecting all by default if a non-mandatory array parameter is empty.
DescribeEnvironmentsResponse	DescribeEnvironments(DescribeEnvironmentsRequest req) This API is used to query the environment list.
DescribeErrorSummaryResponse	DescribeErrorSummary(DescribeErrorSummaryRequest req) This API is used to query error summary information.
DescribeFilesResponse	DescribeFiles(DescribeFilesRequest req) This API is used to query file list.
DescribeJobsResponse	DescribeJobs(DescribeJobsRequest req) This API is used to query job list.
DescribeLabelValuesResponse	DescribeLabelValues(DescribeLabelValuesRequest req) This API is used to query label values.
DescribeMetricLabelWithValuesResponse	DescribeMetricLabelWithValues(DescribeMetricLabelWithValuesRequest req) This API is used to query all labels and values of metrics
DescribeNormalLogsResponse	DescribeNormalLogs(DescribeNormalLogsRequest req) This API is used to query logs in performance testing, including engine logs and console logs.
DescribeProjectsResponse	DescribeProjects(DescribeProjectsRequest req) The API is used to query project list.
DescribeRegionsResponse	DescribeRegions(DescribeRegionsRequest req) This API is used to query region list.
DescribeRequestSummaryResponse	DescribeRequestSummary(DescribeRequestSummaryRequest req) This API is used to query request summary information.
DescribeSampleBatchQueryResponse	DescribeSampleBatchQuery(DescribeSampleBatchQueryRequest req) This API is used to query metrics in batch and return metric content at a specific time point.
DescribeSampleLogsResponse	DescribeSampleLogs(DescribeSampleLogsRequest req) This API is used to query sampled request logs.
DescribeSampleMatrixBatchQueryResponse	DescribeSampleMatrixBatchQuery(DescribeSampleMatrixBatchQueryRequest req) This API is used to batch query metric matrices.
DescribeSampleMatrixQueryResponse	DescribeSampleMatrixQuery(DescribeSampleMatrixQueryRequest req) This API is used to query metric matrix.
DescribeSampleQueryResponse	DescribeSampleQuery(DescribeSampleQueryRequest req) This API is used to query metrics and return metric content at a specific time point.
DescribeScenariosResponse	DescribeScenarios(DescribeScenariosRequest req) This API is used to query scenario list.
DescribeScenarioWithJobsResponse	DescribeScenarioWithJobs(DescribeScenarioWithJobsRequest req) This API is used to query scenarios with executed jobs.
GenerateTmpKeyResponse	GenerateTmpKey(GenerateTmpKeyRequest req) This API is used to generate temporary COS credentials.
RestartCronJobsResponse	RestartCronJobs(RestartCronJobsRequest req) This API is used to restart cron jobs that have been aborted.
StartJobResponse	StartJob(StartJobRequest req) This API is used to create and start test job.
UpdateCronJobResponse	UpdateCronJob(UpdateCronJobRequest req) This API is used to update a cron job.
UpdateEnvironmentResponse	UpdateEnvironment(UpdateEnvironmentRequest req) This API is used to update environments.
UpdateFileScenarioRelationResponse	UpdateFileScenarioRelation(UpdateFileScenarioRelationRequest req) This API is used to update relation between files and scenarios.
UpdateJobResponse	UpdateJob(UpdateJobRequest req) This API is used to update a job.
UpdateProjectResponse	UpdateProject(UpdateProjectRequest req) This API is used to update a project.
UpdateScenarioResponse	UpdateScenario(UpdateScenarioRequest req) This API is used to update a scenario.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PtsClient

public PtsClient(Credential credential,
                 String region)

PtsClient

public PtsClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

AbortCronJobs

public AbortCronJobsResponse AbortCronJobs(AbortCronJobsRequest req)
                                    throws TencentCloudSDKException

This API is used to stop cron jobs.

Parameters:

req - AbortCronJobsRequest

Returns:

AbortCronJobsResponse

Throws:

TencentCloudSDKException

AbortJob

public AbortJobResponse AbortJob(AbortJobRequest req)
                          throws TencentCloudSDKException

This API is used to stop test job.

Parameters:

req - AbortJobRequest

Returns:

AbortJobResponse

Throws:

TencentCloudSDKException

AdjustJobSpeed

public AdjustJobSpeedResponse AdjustJobSpeed(AdjustJobSpeedRequest req)
                                      throws TencentCloudSDKException

This API is used to adjust the target RPS of a job.

Parameters:

req - AdjustJobSpeedRequest

Returns:

AdjustJobSpeedResponse

Throws:

TencentCloudSDKException

CopyScenario

public CopyScenarioResponse CopyScenario(CopyScenarioRequest req)
                                  throws TencentCloudSDKException

This API is used to copy a scenario.

Parameters:

req - CopyScenarioRequest

Returns:

CopyScenarioResponse

Throws:

TencentCloudSDKException

CreateAlertChannel

public CreateAlertChannelResponse CreateAlertChannel(CreateAlertChannelRequest req)
                                              throws TencentCloudSDKException

This API is used to create an alert recipient group.

Parameters:

req - CreateAlertChannelRequest

Returns:

CreateAlertChannelResponse

Throws:

TencentCloudSDKException

CreateCronJob

public CreateCronJobResponse CreateCronJob(CreateCronJobRequest req)
                                    throws TencentCloudSDKException

This API is used to create a cron job.

Parameters:

req - CreateCronJobRequest

Returns:

CreateCronJobResponse

Throws:

TencentCloudSDKException

CreateEnvironment

public CreateEnvironmentResponse CreateEnvironment(CreateEnvironmentRequest req)
                                            throws TencentCloudSDKException

This API is used to create an environment.

Parameters:

req - CreateEnvironmentRequest

Returns:

CreateEnvironmentResponse

Throws:

TencentCloudSDKException

CreateFile

public CreateFileResponse CreateFile(CreateFileRequest req)
                              throws TencentCloudSDKException

This API is used to create a file.

Parameters:

req - CreateFileRequest

Returns:

CreateFileResponse

Throws:

TencentCloudSDKException

CreateProject

public CreateProjectResponse CreateProject(CreateProjectRequest req)
                                    throws TencentCloudSDKException

This API is used to create a project.

Parameters:

req - CreateProjectRequest

Returns:

CreateProjectResponse

Throws:

TencentCloudSDKException

CreateScenario

public CreateScenarioResponse CreateScenario(CreateScenarioRequest req)
                                      throws TencentCloudSDKException

This API is used to create a scenario.

Parameters:

req - CreateScenarioRequest

Returns:

CreateScenarioResponse

Throws:

TencentCloudSDKException

DeleteAlertChannel

public DeleteAlertChannelResponse DeleteAlertChannel(DeleteAlertChannelRequest req)
                                              throws TencentCloudSDKException

This API is used to delete an alert recipient group.

Parameters:

req - DeleteAlertChannelRequest

Returns:

DeleteAlertChannelResponse

Throws:

TencentCloudSDKException

DeleteCronJobs

public DeleteCronJobsResponse DeleteCronJobs(DeleteCronJobsRequest req)
                                      throws TencentCloudSDKException

This API is used to delete cron jobs.

Parameters:

req - DeleteCronJobsRequest

Returns:

DeleteCronJobsResponse

Throws:

TencentCloudSDKException

DeleteEnvironments

public DeleteEnvironmentsResponse DeleteEnvironments(DeleteEnvironmentsRequest req)
                                              throws TencentCloudSDKException

This API is used to delete environments.

Parameters:

req - DeleteEnvironmentsRequest

Returns:

DeleteEnvironmentsResponse

Throws:

TencentCloudSDKException

DeleteFiles

public DeleteFilesResponse DeleteFiles(DeleteFilesRequest req)
                                throws TencentCloudSDKException

This API is used to delete files.

Parameters:

req - DeleteFilesRequest

Returns:

DeleteFilesResponse

Throws:

TencentCloudSDKException

DeleteJobs

public DeleteJobsResponse DeleteJobs(DeleteJobsRequest req)
                              throws TencentCloudSDKException

This API is used to delete jobs.

Parameters:

req - DeleteJobsRequest

Returns:

DeleteJobsResponse

Throws:

TencentCloudSDKException

DeleteProjects

public DeleteProjectsResponse DeleteProjects(DeleteProjectsRequest req)
                                      throws TencentCloudSDKException

This API is used to delete projects.

Parameters:

req - DeleteProjectsRequest

Returns:

DeleteProjectsResponse

Throws:

TencentCloudSDKException

DeleteScenarios

public DeleteScenariosResponse DeleteScenarios(DeleteScenariosRequest req)
                                        throws TencentCloudSDKException

This API is used to delete scenarios.

Parameters:

req - DeleteScenariosRequest

Returns:

DeleteScenariosResponse

Throws:

TencentCloudSDKException

DescribeAlertChannels

public DescribeAlertChannelsResponse DescribeAlertChannels(DescribeAlertChannelsRequest req)
                                                    throws TencentCloudSDKException

This API is used to query alert recipient groups.

Parameters:

req - DescribeAlertChannelsRequest

Returns:

DescribeAlertChannelsResponse

Throws:

TencentCloudSDKException

DescribeAlertRecords

public DescribeAlertRecordsResponse DescribeAlertRecords(DescribeAlertRecordsRequest req)
                                                  throws TencentCloudSDKException

This API is used to query alert records.

Parameters:

req - DescribeAlertRecordsRequest

Returns:

DescribeAlertRecordsResponse

Throws:

TencentCloudSDKException

DescribeAvailableMetrics

public DescribeAvailableMetricsResponse DescribeAvailableMetrics(DescribeAvailableMetricsRequest req)
                                                          throws TencentCloudSDKException

This API is used to query all supported metrics.

Parameters:

req - DescribeAvailableMetricsRequest

Returns:

DescribeAvailableMetricsResponse

Throws:

TencentCloudSDKException

DescribeCheckSummary

public DescribeCheckSummaryResponse DescribeCheckSummary(DescribeCheckSummaryRequest req)
                                                  throws TencentCloudSDKException

This API is used to query checkpoint summary information.

Parameters:

req - DescribeCheckSummaryRequest

Returns:

DescribeCheckSummaryResponse

Throws:

TencentCloudSDKException

DescribeCronJobs

public DescribeCronJobsResponse DescribeCronJobs(DescribeCronJobsRequest req)
                                          throws TencentCloudSDKException

This API is used to list cron jobs, selecting all by default if a non-mandatory array parameter is empty.

Parameters:

req - DescribeCronJobsRequest

Returns:

DescribeCronJobsResponse

Throws:

TencentCloudSDKException

DescribeEnvironments

public DescribeEnvironmentsResponse DescribeEnvironments(DescribeEnvironmentsRequest req)
                                                  throws TencentCloudSDKException

This API is used to query the environment list.

Parameters:

req - DescribeEnvironmentsRequest

Returns:

DescribeEnvironmentsResponse

Throws:

TencentCloudSDKException

DescribeErrorSummary

public DescribeErrorSummaryResponse DescribeErrorSummary(DescribeErrorSummaryRequest req)
                                                  throws TencentCloudSDKException

This API is used to query error summary information.

Parameters:

req - DescribeErrorSummaryRequest

Returns:

DescribeErrorSummaryResponse

Throws:

TencentCloudSDKException

DescribeFiles

public DescribeFilesResponse DescribeFiles(DescribeFilesRequest req)
                                    throws TencentCloudSDKException

This API is used to query file list.

Parameters:

req - DescribeFilesRequest

Returns:

DescribeFilesResponse

Throws:

TencentCloudSDKException

DescribeJobs

public DescribeJobsResponse DescribeJobs(DescribeJobsRequest req)
                                  throws TencentCloudSDKException

This API is used to query job list.

Parameters:

req - DescribeJobsRequest

Returns:

DescribeJobsResponse

Throws:

TencentCloudSDKException

DescribeLabelValues

public DescribeLabelValuesResponse DescribeLabelValues(DescribeLabelValuesRequest req)
                                                throws TencentCloudSDKException

This API is used to query label values.

Parameters:

req - DescribeLabelValuesRequest

Returns:

DescribeLabelValuesResponse

Throws:

TencentCloudSDKException

DescribeMetricLabelWithValues

public DescribeMetricLabelWithValuesResponse DescribeMetricLabelWithValues(DescribeMetricLabelWithValuesRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query all labels and values of metrics

Parameters:

req - DescribeMetricLabelWithValuesRequest

Returns:

DescribeMetricLabelWithValuesResponse

Throws:

TencentCloudSDKException

DescribeNormalLogs

public DescribeNormalLogsResponse DescribeNormalLogs(DescribeNormalLogsRequest req)
                                              throws TencentCloudSDKException

This API is used to query logs in performance testing, including engine logs and console logs.

Parameters:

req - DescribeNormalLogsRequest

Returns:

DescribeNormalLogsResponse

Throws:

TencentCloudSDKException

DescribeProjects

public DescribeProjectsResponse DescribeProjects(DescribeProjectsRequest req)
                                          throws TencentCloudSDKException

The API is used to query project list.

Parameters:

req - DescribeProjectsRequest

Returns:

DescribeProjectsResponse

Throws:

TencentCloudSDKException

DescribeRegions

public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException

This API is used to query region list.

Parameters:

req - DescribeRegionsRequest

Returns:

DescribeRegionsResponse

Throws:

TencentCloudSDKException

DescribeRequestSummary

public DescribeRequestSummaryResponse DescribeRequestSummary(DescribeRequestSummaryRequest req)
                                                      throws TencentCloudSDKException

This API is used to query request summary information.

Parameters:

req - DescribeRequestSummaryRequest

Returns:

DescribeRequestSummaryResponse

Throws:

TencentCloudSDKException

DescribeSampleBatchQuery

public DescribeSampleBatchQueryResponse DescribeSampleBatchQuery(DescribeSampleBatchQueryRequest req)
                                                          throws TencentCloudSDKException

This API is used to query metrics in batch and return metric content at a specific time point.

Parameters:

req - DescribeSampleBatchQueryRequest

Returns:

DescribeSampleBatchQueryResponse

Throws:

TencentCloudSDKException

DescribeSampleLogs

public DescribeSampleLogsResponse DescribeSampleLogs(DescribeSampleLogsRequest req)
                                              throws TencentCloudSDKException

This API is used to query sampled request logs.

Parameters:

req - DescribeSampleLogsRequest

Returns:

DescribeSampleLogsResponse

Throws:

TencentCloudSDKException

DescribeSampleMatrixBatchQuery

public DescribeSampleMatrixBatchQueryResponse DescribeSampleMatrixBatchQuery(DescribeSampleMatrixBatchQueryRequest req)
                                                                      throws TencentCloudSDKException

This API is used to batch query metric matrices.

Parameters:

req - DescribeSampleMatrixBatchQueryRequest

Returns:

DescribeSampleMatrixBatchQueryResponse

Throws:

TencentCloudSDKException

DescribeSampleMatrixQuery

public DescribeSampleMatrixQueryResponse DescribeSampleMatrixQuery(DescribeSampleMatrixQueryRequest req)
                                                            throws TencentCloudSDKException

This API is used to query metric matrix.

Parameters:

req - DescribeSampleMatrixQueryRequest

Returns:

DescribeSampleMatrixQueryResponse

Throws:

TencentCloudSDKException

DescribeSampleQuery

public DescribeSampleQueryResponse DescribeSampleQuery(DescribeSampleQueryRequest req)
                                                throws TencentCloudSDKException

This API is used to query metrics and return metric content at a specific time point.

Parameters:

req - DescribeSampleQueryRequest

Returns:

DescribeSampleQueryResponse

Throws:

TencentCloudSDKException

DescribeScenarioWithJobs

public DescribeScenarioWithJobsResponse DescribeScenarioWithJobs(DescribeScenarioWithJobsRequest req)
                                                          throws TencentCloudSDKException

This API is used to query scenarios with executed jobs.

Parameters:

req - DescribeScenarioWithJobsRequest

Returns:

DescribeScenarioWithJobsResponse

Throws:

TencentCloudSDKException

DescribeScenarios

public DescribeScenariosResponse DescribeScenarios(DescribeScenariosRequest req)
                                            throws TencentCloudSDKException

This API is used to query scenario list.

Parameters:

req - DescribeScenariosRequest

Returns:

DescribeScenariosResponse

Throws:

TencentCloudSDKException

GenerateTmpKey

public GenerateTmpKeyResponse GenerateTmpKey(GenerateTmpKeyRequest req)
                                      throws TencentCloudSDKException

This API is used to generate temporary COS credentials.

Parameters:

req - GenerateTmpKeyRequest

Returns:

GenerateTmpKeyResponse

Throws:

TencentCloudSDKException

RestartCronJobs

public RestartCronJobsResponse RestartCronJobs(RestartCronJobsRequest req)
                                        throws TencentCloudSDKException

This API is used to restart cron jobs that have been aborted.

Parameters:

req - RestartCronJobsRequest

Returns:

RestartCronJobsResponse

Throws:

TencentCloudSDKException

StartJob

public StartJobResponse StartJob(StartJobRequest req)
                          throws TencentCloudSDKException

This API is used to create and start test job.

Parameters:

req - StartJobRequest

Returns:

StartJobResponse

Throws:

TencentCloudSDKException

UpdateCronJob

public UpdateCronJobResponse UpdateCronJob(UpdateCronJobRequest req)
                                    throws TencentCloudSDKException

This API is used to update a cron job.

Parameters:

req - UpdateCronJobRequest

Returns:

UpdateCronJobResponse

Throws:

TencentCloudSDKException

UpdateEnvironment

public UpdateEnvironmentResponse UpdateEnvironment(UpdateEnvironmentRequest req)
                                            throws TencentCloudSDKException

This API is used to update environments.

Parameters:

req - UpdateEnvironmentRequest

Returns:

UpdateEnvironmentResponse

Throws:

TencentCloudSDKException

UpdateFileScenarioRelation

public UpdateFileScenarioRelationResponse UpdateFileScenarioRelation(UpdateFileScenarioRelationRequest req)
                                                              throws TencentCloudSDKException

This API is used to update relation between files and scenarios.

Parameters:

req - UpdateFileScenarioRelationRequest

Returns:

UpdateFileScenarioRelationResponse

Throws:

TencentCloudSDKException

UpdateJob

public UpdateJobResponse UpdateJob(UpdateJobRequest req)
                            throws TencentCloudSDKException

This API is used to update a job.

Parameters:

req - UpdateJobRequest

Returns:

UpdateJobResponse

Throws:

TencentCloudSDKException

UpdateProject

public UpdateProjectResponse UpdateProject(UpdateProjectRequest req)
                                    throws TencentCloudSDKException

This API is used to update a project.

Parameters:

req - UpdateProjectRequest

Returns:

UpdateProjectResponse

Throws:

TencentCloudSDKException

UpdateScenario

public UpdateScenarioResponse UpdateScenario(UpdateScenarioRequest req)
                                      throws TencentCloudSDKException

This API is used to update a scenario.

Parameters:

req - UpdateScenarioRequest

Returns:

UpdateScenarioResponse

Throws:

TencentCloudSDKException