PtsClient (tencentcloud-sdk-java 3.1.1164 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbortCronJobsResponse`	`AbortCronJobs(AbortCronJobsRequest req)` 停止定时任务
`AbortJobResponse`	`AbortJob(AbortJobRequest req)` 停止任务
`AdjustJobSpeedResponse`	`AdjustJobSpeed(AdjustJobSpeedRequest req)` 调整任务的目标RPS
`CopyScenarioResponse`	`CopyScenario(CopyScenarioRequest req)` 复制场景
`CreateAlertChannelResponse`	`CreateAlertChannel(CreateAlertChannelRequest req)` 创建告警通知接收组
`CreateCronJobResponse`	`CreateCronJob(CreateCronJobRequest req)` 创建定时任务
`CreateEnvironmentResponse`	`CreateEnvironment(CreateEnvironmentRequest req)` 创建环境
`CreateFileResponse`	`CreateFile(CreateFileRequest req)` 创建文件
`CreateProjectResponse`	`CreateProject(CreateProjectRequest req)` 创建项目
`CreateScenarioResponse`	`CreateScenario(CreateScenarioRequest req)` 创建场景
`DeleteAlertChannelResponse`	`DeleteAlertChannel(DeleteAlertChannelRequest req)` 删除告警通知接收组
`DeleteCronJobsResponse`	`DeleteCronJobs(DeleteCronJobsRequest req)` 删除定时任务
`DeleteEnvironmentsResponse`	`DeleteEnvironments(DeleteEnvironmentsRequest req)` 删除环境
`DeleteFilesResponse`	`DeleteFiles(DeleteFilesRequest req)` 删除文件
`DeleteJobsResponse`	`DeleteJobs(DeleteJobsRequest req)` 删除任务
`DeleteProjectsResponse`	`DeleteProjects(DeleteProjectsRequest req)` 删除项目
`DeleteScenariosResponse`	`DeleteScenarios(DeleteScenariosRequest req)` 删除场景
`DescribeAlertChannelsResponse`	`DescribeAlertChannels(DescribeAlertChannelsRequest req)` 查询告警通知接收组
`DescribeAlertRecordsResponse`	`DescribeAlertRecords(DescribeAlertRecordsRequest req)` 返回告警历史项的列表
`DescribeAvailableMetricsResponse`	`DescribeAvailableMetrics(DescribeAvailableMetricsRequest req)` 查询系统支持的指标
`DescribeCheckSummaryResponse`	`DescribeCheckSummary(DescribeCheckSummaryRequest req)` 查询检查点汇总信息
`DescribeCronJobsResponse`	`DescribeCronJobs(DescribeCronJobsRequest req)` 列出定时任务，非必填数组为空就默认全选
`DescribeEnvironmentsResponse`	`DescribeEnvironments(DescribeEnvironmentsRequest req)` 查看环境列表
`DescribeErrorSummaryResponse`	`DescribeErrorSummary(DescribeErrorSummaryRequest req)` 查询错误详情汇总信息
`DescribeFilesResponse`	`DescribeFiles(DescribeFilesRequest req)` 查询文件列表
`DescribeJobsResponse`	`DescribeJobs(DescribeJobsRequest req)` 查询任务列表
`DescribeLabelValuesResponse`	`DescribeLabelValues(DescribeLabelValuesRequest req)` 查询标签内容
`DescribeMetricLabelWithValuesResponse`	`DescribeMetricLabelWithValues(DescribeMetricLabelWithValuesRequest req)` 查询指标所有的label及values值
`DescribeNormalLogsResponse`	`DescribeNormalLogs(DescribeNormalLogsRequest req)` 压测过程日志包括引擎输出日志及用户输出日志
`DescribeProjectsResponse`	`DescribeProjects(DescribeProjectsRequest req)` 查询项目列表
`DescribeRegionsResponse`	`DescribeRegions(DescribeRegionsRequest req)` 查询地域列表
`DescribeRequestSummaryResponse`	`DescribeRequestSummary(DescribeRequestSummaryRequest req)` 查询请求汇总信息
`DescribeSampleBatchQueryResponse`	`DescribeSampleBatchQuery(DescribeSampleBatchQueryRequest req)` 批量查询指标，返回固定时间点指标内容
`DescribeSampleLogsResponse`	`DescribeSampleLogs(DescribeSampleLogsRequest req)` 查询采样日志
`DescribeSampleMatrixBatchQueryResponse`	`DescribeSampleMatrixBatchQuery(DescribeSampleMatrixBatchQueryRequest req)` 批量查询指标矩阵
`DescribeSampleMatrixQueryResponse`	`DescribeSampleMatrixQuery(DescribeSampleMatrixQueryRequest req)` 查询指标矩阵
`DescribeSampleQueryResponse`	`DescribeSampleQuery(DescribeSampleQueryRequest req)` 查询指标，返回固定时间点指标内容
`DescribeScenariosResponse`	`DescribeScenarios(DescribeScenariosRequest req)` 查询场景列表
`DescribeScenarioWithJobsResponse`	`DescribeScenarioWithJobs(DescribeScenarioWithJobsRequest req)` 查询场景配置并附带已经执行的任务内容
`GenerateTmpKeyResponse`	`GenerateTmpKey(GenerateTmpKeyRequest req)` 生成临时COS凭证
`RestartCronJobsResponse`	`RestartCronJobs(RestartCronJobsRequest req)` 重启状态为已中止的定时任务
`StartJobResponse`	`StartJob(StartJobRequest req)` 创建并启动任务
`UpdateCronJobResponse`	`UpdateCronJob(UpdateCronJobRequest req)` 更新定时任务
`UpdateEnvironmentResponse`	`UpdateEnvironment(UpdateEnvironmentRequest req)` 更新环境
`UpdateFileScenarioRelationResponse`	`UpdateFileScenarioRelation(UpdateFileScenarioRelationRequest req)` 更新关联文件场景
`UpdateJobResponse`	`UpdateJob(UpdateJobRequest req)` 更新任务
`UpdateProjectResponse`	`UpdateProject(UpdateProjectRequest req)` 更新项目
`UpdateScenarioResponse`	`UpdateScenario(UpdateScenarioRequest req)` 更新场景

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

停止定时任务

Parameters:: req - AbortCronJobsRequest
Returns:: AbortCronJobsResponse
Throws:: TencentCloudSDKException

AbortJob

public AbortJobResponse AbortJob(AbortJobRequest req)
                          throws TencentCloudSDKException

停止任务

Parameters:: req - AbortJobRequest
Returns:: AbortJobResponse
Throws:: TencentCloudSDKException

AdjustJobSpeed

public AdjustJobSpeedResponse AdjustJobSpeed(AdjustJobSpeedRequest req)
                                      throws TencentCloudSDKException

调整任务的目标RPS

Parameters:: req - AdjustJobSpeedRequest
Returns:: AdjustJobSpeedResponse
Throws:: TencentCloudSDKException

CopyScenario

public CopyScenarioResponse CopyScenario(CopyScenarioRequest req)
                                  throws TencentCloudSDKException

复制场景

Parameters:: req - CopyScenarioRequest
Returns:: CopyScenarioResponse
Throws:: TencentCloudSDKException

CreateAlertChannel

public CreateAlertChannelResponse CreateAlertChannel(CreateAlertChannelRequest req)
                                              throws TencentCloudSDKException

创建告警通知接收组

Parameters:: req - CreateAlertChannelRequest
Returns:: CreateAlertChannelResponse
Throws:: TencentCloudSDKException

CreateCronJob

public CreateCronJobResponse CreateCronJob(CreateCronJobRequest req)
                                    throws TencentCloudSDKException

创建定时任务

Parameters:: req - CreateCronJobRequest
Returns:: CreateCronJobResponse
Throws:: TencentCloudSDKException

CreateEnvironment

public CreateEnvironmentResponse CreateEnvironment(CreateEnvironmentRequest req)
                                            throws TencentCloudSDKException

创建环境

Parameters:: req - CreateEnvironmentRequest
Returns:: CreateEnvironmentResponse
Throws:: TencentCloudSDKException

CreateFile

public CreateFileResponse CreateFile(CreateFileRequest req)
                              throws TencentCloudSDKException

创建文件

Parameters:: req - CreateFileRequest
Returns:: CreateFileResponse
Throws:: TencentCloudSDKException

CreateProject

public CreateProjectResponse CreateProject(CreateProjectRequest req)
                                    throws TencentCloudSDKException

创建项目

Parameters:: req - CreateProjectRequest
Returns:: CreateProjectResponse
Throws:: TencentCloudSDKException

CreateScenario

public CreateScenarioResponse CreateScenario(CreateScenarioRequest req)
                                      throws TencentCloudSDKException

创建场景

Parameters:: req - CreateScenarioRequest
Returns:: CreateScenarioResponse
Throws:: TencentCloudSDKException

DeleteAlertChannel

public DeleteAlertChannelResponse DeleteAlertChannel(DeleteAlertChannelRequest req)
                                              throws TencentCloudSDKException

删除告警通知接收组

Parameters:: req - DeleteAlertChannelRequest
Returns:: DeleteAlertChannelResponse
Throws:: TencentCloudSDKException

DeleteCronJobs

public DeleteCronJobsResponse DeleteCronJobs(DeleteCronJobsRequest req)
                                      throws TencentCloudSDKException

删除定时任务

Parameters:: req - DeleteCronJobsRequest
Returns:: DeleteCronJobsResponse
Throws:: TencentCloudSDKException

DeleteEnvironments

public DeleteEnvironmentsResponse DeleteEnvironments(DeleteEnvironmentsRequest req)
                                              throws TencentCloudSDKException

删除环境

Parameters:: req - DeleteEnvironmentsRequest
Returns:: DeleteEnvironmentsResponse
Throws:: TencentCloudSDKException

DeleteFiles

public DeleteFilesResponse DeleteFiles(DeleteFilesRequest req)
                                throws TencentCloudSDKException

删除文件

Parameters:: req - DeleteFilesRequest
Returns:: DeleteFilesResponse
Throws:: TencentCloudSDKException

DeleteJobs

public DeleteJobsResponse DeleteJobs(DeleteJobsRequest req)
                              throws TencentCloudSDKException

删除任务

Parameters:: req - DeleteJobsRequest
Returns:: DeleteJobsResponse
Throws:: TencentCloudSDKException

DeleteProjects

public DeleteProjectsResponse DeleteProjects(DeleteProjectsRequest req)
                                      throws TencentCloudSDKException

删除项目

Parameters:: req - DeleteProjectsRequest
Returns:: DeleteProjectsResponse
Throws:: TencentCloudSDKException

DeleteScenarios

public DeleteScenariosResponse DeleteScenarios(DeleteScenariosRequest req)
                                        throws TencentCloudSDKException

删除场景

Parameters:: req - DeleteScenariosRequest
Returns:: DeleteScenariosResponse
Throws:: TencentCloudSDKException

DescribeAlertChannels

public DescribeAlertChannelsResponse DescribeAlertChannels(DescribeAlertChannelsRequest req)
                                                    throws TencentCloudSDKException

查询告警通知接收组

Parameters:: req - DescribeAlertChannelsRequest
Returns:: DescribeAlertChannelsResponse
Throws:: TencentCloudSDKException

DescribeAlertRecords

public DescribeAlertRecordsResponse DescribeAlertRecords(DescribeAlertRecordsRequest req)
                                                  throws TencentCloudSDKException

返回告警历史项的列表

Parameters:: req - DescribeAlertRecordsRequest
Returns:: DescribeAlertRecordsResponse
Throws:: TencentCloudSDKException

DescribeAvailableMetrics

public DescribeAvailableMetricsResponse DescribeAvailableMetrics(DescribeAvailableMetricsRequest req)
                                                          throws TencentCloudSDKException

查询系统支持的指标

Parameters:: req - DescribeAvailableMetricsRequest
Returns:: DescribeAvailableMetricsResponse
Throws:: TencentCloudSDKException

DescribeCheckSummary

public DescribeCheckSummaryResponse DescribeCheckSummary(DescribeCheckSummaryRequest req)
                                                  throws TencentCloudSDKException

查询检查点汇总信息

Parameters:: req - DescribeCheckSummaryRequest
Returns:: DescribeCheckSummaryResponse
Throws:: TencentCloudSDKException

DescribeCronJobs
```
public DescribeCronJobsResponse DescribeCronJobs(DescribeCronJobsRequest req)
                                          throws TencentCloudSDKException
```
列出定时任务，非必填数组为空就默认全选

Parameters:

req - DescribeCronJobsRequest

Returns:

DescribeCronJobsResponse

Throws:

TencentCloudSDKException

DescribeEnvironments

public DescribeEnvironmentsResponse DescribeEnvironments(DescribeEnvironmentsRequest req)
                                                  throws TencentCloudSDKException

查看环境列表

Parameters:: req - DescribeEnvironmentsRequest
Returns:: DescribeEnvironmentsResponse
Throws:: TencentCloudSDKException

DescribeErrorSummary

public DescribeErrorSummaryResponse DescribeErrorSummary(DescribeErrorSummaryRequest req)
                                                  throws TencentCloudSDKException

查询错误详情汇总信息

Parameters:: req - DescribeErrorSummaryRequest
Returns:: DescribeErrorSummaryResponse
Throws:: TencentCloudSDKException

DescribeFiles

public DescribeFilesResponse DescribeFiles(DescribeFilesRequest req)
                                    throws TencentCloudSDKException

查询文件列表

Parameters:: req - DescribeFilesRequest
Returns:: DescribeFilesResponse
Throws:: TencentCloudSDKException

DescribeJobs

public DescribeJobsResponse DescribeJobs(DescribeJobsRequest req)
                                  throws TencentCloudSDKException

查询任务列表

Parameters:: req - DescribeJobsRequest
Returns:: DescribeJobsResponse
Throws:: TencentCloudSDKException

DescribeLabelValues

public DescribeLabelValuesResponse DescribeLabelValues(DescribeLabelValuesRequest req)
                                                throws TencentCloudSDKException

查询标签内容

Parameters:: req - DescribeLabelValuesRequest
Returns:: DescribeLabelValuesResponse
Throws:: TencentCloudSDKException

DescribeMetricLabelWithValues

public DescribeMetricLabelWithValuesResponse DescribeMetricLabelWithValues(DescribeMetricLabelWithValuesRequest req)
                                                                    throws TencentCloudSDKException

查询指标所有的label及values值

Parameters:: req - DescribeMetricLabelWithValuesRequest
Returns:: DescribeMetricLabelWithValuesResponse
Throws:: TencentCloudSDKException

DescribeNormalLogs
```
public DescribeNormalLogsResponse DescribeNormalLogs(DescribeNormalLogsRequest req)
                                              throws TencentCloudSDKException
```
压测过程日志包括引擎输出日志及用户输出日志

Parameters:

req - DescribeNormalLogsRequest

Returns:

DescribeNormalLogsResponse

Throws:

TencentCloudSDKException

DescribeProjects

public DescribeProjectsResponse DescribeProjects(DescribeProjectsRequest req)
                                          throws TencentCloudSDKException

查询项目列表

Parameters:: req - DescribeProjectsRequest
Returns:: DescribeProjectsResponse
Throws:: TencentCloudSDKException

DescribeRegions

public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException

查询地域列表

Parameters:: req - DescribeRegionsRequest
Returns:: DescribeRegionsResponse
Throws:: TencentCloudSDKException

DescribeRequestSummary

public DescribeRequestSummaryResponse DescribeRequestSummary(DescribeRequestSummaryRequest req)
                                                      throws TencentCloudSDKException

查询请求汇总信息

Parameters:: req - DescribeRequestSummaryRequest
Returns:: DescribeRequestSummaryResponse
Throws:: TencentCloudSDKException

DescribeSampleBatchQuery

public DescribeSampleBatchQueryResponse DescribeSampleBatchQuery(DescribeSampleBatchQueryRequest req)
                                                          throws TencentCloudSDKException

批量查询指标，返回固定时间点指标内容

Parameters:: req - DescribeSampleBatchQueryRequest
Returns:: DescribeSampleBatchQueryResponse
Throws:: TencentCloudSDKException

DescribeSampleLogs

public DescribeSampleLogsResponse DescribeSampleLogs(DescribeSampleLogsRequest req)
                                              throws TencentCloudSDKException

查询采样日志

Parameters:: req - DescribeSampleLogsRequest
Returns:: DescribeSampleLogsResponse
Throws:: TencentCloudSDKException

DescribeSampleMatrixBatchQuery

public DescribeSampleMatrixBatchQueryResponse DescribeSampleMatrixBatchQuery(DescribeSampleMatrixBatchQueryRequest req)
                                                                      throws TencentCloudSDKException

批量查询指标矩阵

Parameters:: req - DescribeSampleMatrixBatchQueryRequest
Returns:: DescribeSampleMatrixBatchQueryResponse
Throws:: TencentCloudSDKException

DescribeSampleMatrixQuery

public DescribeSampleMatrixQueryResponse DescribeSampleMatrixQuery(DescribeSampleMatrixQueryRequest req)
                                                            throws TencentCloudSDKException

查询指标矩阵

Parameters:: req - DescribeSampleMatrixQueryRequest
Returns:: DescribeSampleMatrixQueryResponse
Throws:: TencentCloudSDKException

DescribeSampleQuery

public DescribeSampleQueryResponse DescribeSampleQuery(DescribeSampleQueryRequest req)
                                                throws TencentCloudSDKException

查询指标，返回固定时间点指标内容

Parameters:: req - DescribeSampleQueryRequest
Returns:: DescribeSampleQueryResponse
Throws:: TencentCloudSDKException

DescribeScenarioWithJobs

public DescribeScenarioWithJobsResponse DescribeScenarioWithJobs(DescribeScenarioWithJobsRequest req)
                                                          throws TencentCloudSDKException

查询场景配置并附带已经执行的任务内容

Parameters:: req - DescribeScenarioWithJobsRequest
Returns:: DescribeScenarioWithJobsResponse
Throws:: TencentCloudSDKException

DescribeScenarios

public DescribeScenariosResponse DescribeScenarios(DescribeScenariosRequest req)
                                            throws TencentCloudSDKException

查询场景列表

Parameters:: req - DescribeScenariosRequest
Returns:: DescribeScenariosResponse
Throws:: TencentCloudSDKException

GenerateTmpKey

public GenerateTmpKeyResponse GenerateTmpKey(GenerateTmpKeyRequest req)
                                      throws TencentCloudSDKException

生成临时COS凭证

Parameters:: req - GenerateTmpKeyRequest
Returns:: GenerateTmpKeyResponse
Throws:: TencentCloudSDKException

RestartCronJobs

public RestartCronJobsResponse RestartCronJobs(RestartCronJobsRequest req)
                                        throws TencentCloudSDKException

重启状态为已中止的定时任务

Parameters:: req - RestartCronJobsRequest
Returns:: RestartCronJobsResponse
Throws:: TencentCloudSDKException

StartJob

public StartJobResponse StartJob(StartJobRequest req)
                          throws TencentCloudSDKException

创建并启动任务

Parameters:: req - StartJobRequest
Returns:: StartJobResponse
Throws:: TencentCloudSDKException

UpdateCronJob

public UpdateCronJobResponse UpdateCronJob(UpdateCronJobRequest req)
                                    throws TencentCloudSDKException

更新定时任务

Parameters:: req - UpdateCronJobRequest
Returns:: UpdateCronJobResponse
Throws:: TencentCloudSDKException

UpdateEnvironment

public UpdateEnvironmentResponse UpdateEnvironment(UpdateEnvironmentRequest req)
                                            throws TencentCloudSDKException

更新环境

Parameters:: req - UpdateEnvironmentRequest
Returns:: UpdateEnvironmentResponse
Throws:: TencentCloudSDKException

UpdateFileScenarioRelation

public UpdateFileScenarioRelationResponse UpdateFileScenarioRelation(UpdateFileScenarioRelationRequest req)
                                                              throws TencentCloudSDKException

更新关联文件场景

Parameters:: req - UpdateFileScenarioRelationRequest
Returns:: UpdateFileScenarioRelationResponse
Throws:: TencentCloudSDKException

UpdateJob

public UpdateJobResponse UpdateJob(UpdateJobRequest req)
                            throws TencentCloudSDKException

更新任务

Parameters:: req - UpdateJobRequest
Returns:: UpdateJobResponse
Throws:: TencentCloudSDKException

UpdateProject

public UpdateProjectResponse UpdateProject(UpdateProjectRequest req)
                                    throws TencentCloudSDKException

更新项目

Parameters:: req - UpdateProjectRequest
Returns:: UpdateProjectResponse
Throws:: TencentCloudSDKException

UpdateScenario

public UpdateScenarioResponse UpdateScenario(UpdateScenarioRequest req)
                                      throws TencentCloudSDKException

更新场景

Parameters:: req - UpdateScenarioRequest
Returns:: UpdateScenarioResponse
Throws:: TencentCloudSDKException

Class PtsClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

PtsClient

PtsClient

Method Detail

AbortCronJobs

AbortJob

AdjustJobSpeed

CopyScenario

CreateAlertChannel

CreateCronJob

CreateEnvironment

CreateFile

CreateProject

CreateScenario

DeleteAlertChannel

DeleteCronJobs

DeleteEnvironments

DeleteFiles

DeleteJobs

DeleteProjects

DeleteScenarios

DescribeAlertChannels

DescribeAlertRecords

DescribeAvailableMetrics

DescribeCheckSummary

DescribeCronJobs

DescribeEnvironments

DescribeErrorSummary

DescribeFiles

DescribeJobs

DescribeLabelValues

DescribeMetricLabelWithValues

DescribeNormalLogs

DescribeProjects

DescribeRegions

DescribeRequestSummary

DescribeSampleBatchQuery

DescribeSampleLogs

DescribeSampleMatrixBatchQuery

DescribeSampleMatrixQuery

DescribeSampleQuery

DescribeScenarioWithJobs

DescribeScenarios

GenerateTmpKey

RestartCronJobs

StartJob

UpdateCronJob

UpdateEnvironment

UpdateFileScenarioRelation

UpdateJob

UpdateProject

UpdateScenario