CatClient (tencentcloud-sdk-java 3.1.14 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.cat.v20180409.CatClient

public class CatClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`CatClient(Credential credential, String region)`
`CatClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BindAlarmPolicyResponse`	`BindAlarmPolicy(BindAlarmPolicyRequest req)` 绑定拨测任务和告警策略组
`CreateAgentGroupResponse`	`CreateAgentGroup(CreateAgentGroupRequest req)` 添加拨测分组
`CreateTaskExResponse`	`CreateTaskEx(CreateTaskExRequest req)` 创建拨测任务(扩充)
`DeleteAgentGroupResponse`	`DeleteAgentGroup(DeleteAgentGroupRequest req)` 删除拨测分组
`DeleteTasksResponse`	`DeleteTasks(DeleteTasksRequest req)` 删除多个拨测任务
`DescribeAgentGroupsResponse`	`DescribeAgentGroups(DescribeAgentGroupsRequest req)` 查询拨测分组列表
`DescribeAgentsResponse`	`DescribeAgents(DescribeAgentsRequest req)` 查询本用户可选的拨测点列表
`DescribeAlarmsResponse`	`DescribeAlarms(DescribeAlarmsRequest req)` 查询拨测告警列表
`DescribeAlarmsByTaskResponse`	`DescribeAlarmsByTask(DescribeAlarmsByTaskRequest req)` 按任务查询拨测告警列表
`DescribeAlarmTopicResponse`	`DescribeAlarmTopic(DescribeAlarmTopicRequest req)` 查询用户的告警主题列表
`DescribeCatLogsResponse`	`DescribeCatLogs(DescribeCatLogsRequest req)` 查询拨测流水
`DescribeTaskDetailResponse`	`DescribeTaskDetail(DescribeTaskDetailRequest req)` 查询拨测任务信息
`DescribeTasksByTypeResponse`	`DescribeTasksByType(DescribeTasksByTypeRequest req)` 按类型查询拨测任务列表
`DescribeUserLimitResponse`	`DescribeUserLimit(DescribeUserLimitRequest req)` 获取用户可用资源限制
`GetAvailRatioHistoryResponse`	`GetAvailRatioHistory(GetAvailRatioHistoryRequest req)` 获取指定时刻的可用率地图信息
`GetDailyAvailRatioResponse`	`GetDailyAvailRatio(GetDailyAvailRatioRequest req)` 获取一天的整体可用率信息
`GetRealAvailRatioResponse`	`GetRealAvailRatio(GetRealAvailRatioRequest req)` 获取实时可用率信息
`GetRespTimeTrendExResponse`	`GetRespTimeTrendEx(GetRespTimeTrendExRequest req)` 查询拨测任务的走势数据
`GetResultSummaryResponse`	`GetResultSummary(GetResultSummaryRequest req)` 获取任务列表的实时数据
`GetReturnCodeHistoryResponse`	`GetReturnCodeHistory(GetReturnCodeHistoryRequest req)` 查询拨测任务的历史返回码信息
`GetReturnCodeInfoResponse`	`GetReturnCodeInfo(GetReturnCodeInfoRequest req)` 查询拨测任务的返回码统计信息
`GetTaskTotalNumberResponse`	`GetTaskTotalNumber(GetTaskTotalNumberRequest req)` 获取AppId下的拨测任务总数
`ModifyAgentGroupResponse`	`ModifyAgentGroup(ModifyAgentGroupRequest req)` 修改拨测分组
`ModifyTaskExResponse`	`ModifyTaskEx(ModifyTaskExRequest req)` 修改拨测任务(扩展)
`PauseTaskResponse`	`PauseTask(PauseTaskRequest req)` 暂停拨测任务
`RunTaskResponse`	`RunTask(RunTaskRequest req)` 运行拨测任务
`VerifyResultResponse`	`VerifyResult(VerifyResultRequest req)` 验证拨测任务，结果验证查询（验证成功的，才建议创建拨测任务）

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CatClient

public CatClient(Credential credential,
                 String region)

CatClient

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

Method Detail

BindAlarmPolicy

public BindAlarmPolicyResponse BindAlarmPolicy(BindAlarmPolicyRequest req)
                                        throws TencentCloudSDKException

绑定拨测任务和告警策略组

Parameters:: req - BindAlarmPolicyRequest
Returns:: BindAlarmPolicyResponse
Throws:: TencentCloudSDKException

CreateAgentGroup

public CreateAgentGroupResponse CreateAgentGroup(CreateAgentGroupRequest req)
                                          throws TencentCloudSDKException

添加拨测分组

Parameters:: req - CreateAgentGroupRequest
Returns:: CreateAgentGroupResponse
Throws:: TencentCloudSDKException

CreateTaskEx

public CreateTaskExResponse CreateTaskEx(CreateTaskExRequest req)
                                  throws TencentCloudSDKException

创建拨测任务(扩充)

Parameters:: req - CreateTaskExRequest
Returns:: CreateTaskExResponse
Throws:: TencentCloudSDKException

DeleteAgentGroup

public DeleteAgentGroupResponse DeleteAgentGroup(DeleteAgentGroupRequest req)
                                          throws TencentCloudSDKException

删除拨测分组

Parameters:: req - DeleteAgentGroupRequest
Returns:: DeleteAgentGroupResponse
Throws:: TencentCloudSDKException

DeleteTasks

public DeleteTasksResponse DeleteTasks(DeleteTasksRequest req)
                                throws TencentCloudSDKException

删除多个拨测任务

Parameters:: req - DeleteTasksRequest
Returns:: DeleteTasksResponse
Throws:: TencentCloudSDKException

DescribeAgentGroups

public DescribeAgentGroupsResponse DescribeAgentGroups(DescribeAgentGroupsRequest req)
                                                throws TencentCloudSDKException

查询拨测分组列表

Parameters:: req - DescribeAgentGroupsRequest
Returns:: DescribeAgentGroupsResponse
Throws:: TencentCloudSDKException

DescribeAgents

public DescribeAgentsResponse DescribeAgents(DescribeAgentsRequest req)
                                      throws TencentCloudSDKException

查询本用户可选的拨测点列表

Parameters:: req - DescribeAgentsRequest
Returns:: DescribeAgentsResponse
Throws:: TencentCloudSDKException

DescribeAlarmTopic

public DescribeAlarmTopicResponse DescribeAlarmTopic(DescribeAlarmTopicRequest req)
                                              throws TencentCloudSDKException

查询用户的告警主题列表

Parameters:: req - DescribeAlarmTopicRequest
Returns:: DescribeAlarmTopicResponse
Throws:: TencentCloudSDKException

DescribeAlarms

public DescribeAlarmsResponse DescribeAlarms(DescribeAlarmsRequest req)
                                      throws TencentCloudSDKException

查询拨测告警列表

Parameters:: req - DescribeAlarmsRequest
Returns:: DescribeAlarmsResponse
Throws:: TencentCloudSDKException

DescribeAlarmsByTask

public DescribeAlarmsByTaskResponse DescribeAlarmsByTask(DescribeAlarmsByTaskRequest req)
                                                  throws TencentCloudSDKException

按任务查询拨测告警列表

Parameters:: req - DescribeAlarmsByTaskRequest
Returns:: DescribeAlarmsByTaskResponse
Throws:: TencentCloudSDKException

DescribeCatLogs

public DescribeCatLogsResponse DescribeCatLogs(DescribeCatLogsRequest req)
                                        throws TencentCloudSDKException

查询拨测流水

Parameters:: req - DescribeCatLogsRequest
Returns:: DescribeCatLogsResponse
Throws:: TencentCloudSDKException

DescribeTaskDetail

public DescribeTaskDetailResponse DescribeTaskDetail(DescribeTaskDetailRequest req)
                                              throws TencentCloudSDKException

查询拨测任务信息

Parameters:: req - DescribeTaskDetailRequest
Returns:: DescribeTaskDetailResponse
Throws:: TencentCloudSDKException

DescribeTasksByType

public DescribeTasksByTypeResponse DescribeTasksByType(DescribeTasksByTypeRequest req)
                                                throws TencentCloudSDKException

按类型查询拨测任务列表

Parameters:: req - DescribeTasksByTypeRequest
Returns:: DescribeTasksByTypeResponse
Throws:: TencentCloudSDKException

DescribeUserLimit

public DescribeUserLimitResponse DescribeUserLimit(DescribeUserLimitRequest req)
                                            throws TencentCloudSDKException

获取用户可用资源限制

Parameters:: req - DescribeUserLimitRequest
Returns:: DescribeUserLimitResponse
Throws:: TencentCloudSDKException

GetAvailRatioHistory

public GetAvailRatioHistoryResponse GetAvailRatioHistory(GetAvailRatioHistoryRequest req)
                                                  throws TencentCloudSDKException

获取指定时刻的可用率地图信息

Parameters:: req - GetAvailRatioHistoryRequest
Returns:: GetAvailRatioHistoryResponse
Throws:: TencentCloudSDKException

GetDailyAvailRatio

public GetDailyAvailRatioResponse GetDailyAvailRatio(GetDailyAvailRatioRequest req)
                                              throws TencentCloudSDKException

获取一天的整体可用率信息

Parameters:: req - GetDailyAvailRatioRequest
Returns:: GetDailyAvailRatioResponse
Throws:: TencentCloudSDKException

GetRealAvailRatio

public GetRealAvailRatioResponse GetRealAvailRatio(GetRealAvailRatioRequest req)
                                            throws TencentCloudSDKException

获取实时可用率信息

Parameters:: req - GetRealAvailRatioRequest
Returns:: GetRealAvailRatioResponse
Throws:: TencentCloudSDKException

GetRespTimeTrendEx

public GetRespTimeTrendExResponse GetRespTimeTrendEx(GetRespTimeTrendExRequest req)
                                              throws TencentCloudSDKException

查询拨测任务的走势数据

Parameters:: req - GetRespTimeTrendExRequest
Returns:: GetRespTimeTrendExResponse
Throws:: TencentCloudSDKException

GetResultSummary

public GetResultSummaryResponse GetResultSummary(GetResultSummaryRequest req)
                                          throws TencentCloudSDKException

获取任务列表的实时数据

Parameters:: req - GetResultSummaryRequest
Returns:: GetResultSummaryResponse
Throws:: TencentCloudSDKException

GetReturnCodeHistory

public GetReturnCodeHistoryResponse GetReturnCodeHistory(GetReturnCodeHistoryRequest req)
                                                  throws TencentCloudSDKException

查询拨测任务的历史返回码信息

Parameters:: req - GetReturnCodeHistoryRequest
Returns:: GetReturnCodeHistoryResponse
Throws:: TencentCloudSDKException

GetReturnCodeInfo

public GetReturnCodeInfoResponse GetReturnCodeInfo(GetReturnCodeInfoRequest req)
                                            throws TencentCloudSDKException

查询拨测任务的返回码统计信息

Parameters:: req - GetReturnCodeInfoRequest
Returns:: GetReturnCodeInfoResponse
Throws:: TencentCloudSDKException

GetTaskTotalNumber

public GetTaskTotalNumberResponse GetTaskTotalNumber(GetTaskTotalNumberRequest req)
                                              throws TencentCloudSDKException

获取AppId下的拨测任务总数

Parameters:: req - GetTaskTotalNumberRequest
Returns:: GetTaskTotalNumberResponse
Throws:: TencentCloudSDKException

ModifyAgentGroup

public ModifyAgentGroupResponse ModifyAgentGroup(ModifyAgentGroupRequest req)
                                          throws TencentCloudSDKException

修改拨测分组

Parameters:: req - ModifyAgentGroupRequest
Returns:: ModifyAgentGroupResponse
Throws:: TencentCloudSDKException

ModifyTaskEx

public ModifyTaskExResponse ModifyTaskEx(ModifyTaskExRequest req)
                                  throws TencentCloudSDKException

修改拨测任务(扩展)

Parameters:: req - ModifyTaskExRequest
Returns:: ModifyTaskExResponse
Throws:: TencentCloudSDKException

PauseTask

public PauseTaskResponse PauseTask(PauseTaskRequest req)
                            throws TencentCloudSDKException

暂停拨测任务

Parameters:: req - PauseTaskRequest
Returns:: PauseTaskResponse
Throws:: TencentCloudSDKException

RunTask

public RunTaskResponse RunTask(RunTaskRequest req)
                        throws TencentCloudSDKException

运行拨测任务

Parameters:: req - RunTaskRequest
Returns:: RunTaskResponse
Throws:: TencentCloudSDKException

VerifyResult
```
public VerifyResultResponse VerifyResult(VerifyResultRequest req)
                                  throws TencentCloudSDKException
```
验证拨测任务，结果验证查询（验证成功的，才建议创建拨测任务）

Parameters:

req - VerifyResultRequest

Returns:

VerifyResultResponse

Throws:

TencentCloudSDKException

Class CatClient

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

CatClient

CatClient

Method Detail

BindAlarmPolicy

CreateAgentGroup

CreateTaskEx

DeleteAgentGroup

DeleteTasks

DescribeAgentGroups

DescribeAgents

DescribeAlarmTopic

DescribeAlarms

DescribeAlarmsByTask

DescribeCatLogs

DescribeTaskDetail

DescribeTasksByType

DescribeUserLimit

GetAvailRatioHistory

GetDailyAvailRatio

GetRealAvailRatio

GetRespTimeTrendEx

GetResultSummary

GetReturnCodeHistory

GetReturnCodeInfo

GetTaskTotalNumber

ModifyAgentGroup

ModifyTaskEx

PauseTask

RunTask

VerifyResult