TatClient (tencentcloud-sdk-java 3.1.464 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tat.v20201028.TatClient

public class TatClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CancelInvocationResponse`	`CancelInvocation(CancelInvocationRequest req)` 取消一台或多台CVM实例执行的命令如果命令还未下发到agent，任务状态处于处于PENDING、DELIVERING、DELIVER_DELAYED，取消后任务状态是CANCELLED 如果命令已下发到agent，任务状态处于RUNNING，取消后任务状态是TERMINATED
`CreateCommandResponse`	`CreateCommand(CreateCommandRequest req)` 此接口用于创建命令。
`CreateInvokerResponse`	`CreateInvoker(CreateInvokerRequest req)` 此接口用于创建执行器。
`DeleteCommandResponse`	`DeleteCommand(DeleteCommandRequest req)` 此接口用于删除命令。如果命令与执行器关联，则无法被删除。
`DeleteInvokerResponse`	`DeleteInvoker(DeleteInvokerRequest req)` 此接口用于删除执行器。
`DescribeAutomationAgentStatusResponse`	`DescribeAutomationAgentStatus(DescribeAutomationAgentStatusRequest req)` 此接口用于查询自动化助手客户端的状态。
`DescribeCommandsResponse`	`DescribeCommands(DescribeCommandsRequest req)` 此接口用于查询命令详情。
`DescribeInvocationsResponse`	`DescribeInvocations(DescribeInvocationsRequest req)` 此接口用于查询执行活动详情。
`DescribeInvocationTasksResponse`	`DescribeInvocationTasks(DescribeInvocationTasksRequest req)` 此接口用于查询执行任务详情。
`DescribeInvokerRecordsResponse`	`DescribeInvokerRecords(DescribeInvokerRecordsRequest req)` 此接口用于查询执行器的执行记录。
`DescribeInvokersResponse`	`DescribeInvokers(DescribeInvokersRequest req)` 此接口用于查询执行器信息。
`DescribeRegionsResponse`	`DescribeRegions(DescribeRegionsRequest req)` 此接口用于查询 TAT 产品后台地域列表。 RegionState 为 AVAILABLE，代表该地域的 TAT 后台服务已经可用；未返回，代表该地域的 TAT 后台服务尚不可用。
`DisableInvokerResponse`	`DisableInvoker(DisableInvokerRequest req)` 此接口用于停止执行器。
`EnableInvokerResponse`	`EnableInvoker(EnableInvokerRequest req)` 此接口用于启用执行器。
`InvokeCommandResponse`	`InvokeCommand(InvokeCommandRequest req)` 在指定的实例上触发命令，调用成功返回执行活动ID（inv-xxxxxxxx），每个执行活动内部有一个或多个执行任务（invt-xxxxxxxx），每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。如果指定实例未安装 agent，或 agent 不在线，返回失败如果命令类型与 agent 运行环境不符，返回失败指定的实例需要处于 VPC 网络指定的实例需要处于 RUNNING 状态不可同时指定 CVM 和 Lighthouse
`ModifyCommandResponse`	`ModifyCommand(ModifyCommandRequest req)` 此接口用于修改命令。
`ModifyInvokerResponse`	`ModifyInvoker(ModifyInvokerRequest req)` 此接口用于修改执行器。
`PreviewReplacedCommandContentResponse`	`PreviewReplacedCommandContent(PreviewReplacedCommandContentRequest req)` 此接口用于预览自定义参数替换后的命令内容。不会触发真实执行。
`RunCommandResponse`	`RunCommand(RunCommandRequest req)` 执行命令，调用成功返回执行活动ID（inv-xxxxxxxx），每个执行活动内部有一个或多个执行任务（invt-xxxxxxxx），每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。如果指定实例未安装 agent，或 agent 不在线，返回失败如果命令类型与 agent 运行环境不符，返回失败指定的实例需要处于 VPC 网络指定的实例需要处于 `RUNNING` 状态不可同时指定 CVM 和 Lighthouse

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

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

- Constructor Detail
  - TatClient
```
public TatClient(Credential credential,
                 String region)
```
  - TatClient
```
public TatClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - CancelInvocation
```
public CancelInvocationResponse CancelInvocation(CancelInvocationRequest req)
                                          throws TencentCloudSDKException
```
    取消一台或多台CVM实例执行的命令如果命令还未下发到agent，任务状态处于处于PENDING、DELIVERING、DELIVER_DELAYED，取消后任务状态是CANCELLED 如果命令已下发到agent，任务状态处于RUNNING，取消后任务状态是TERMINATED
    
    Parameters:
    
    req - CancelInvocationRequest
    
    Returns:
    
    CancelInvocationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCommand
```
public CreateCommandResponse CreateCommand(CreateCommandRequest req)
                                    throws TencentCloudSDKException
```
    此接口用于创建命令。
    
    Parameters:
    
    req - CreateCommandRequest
    
    Returns:
    
    CreateCommandResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateInvoker
```
public CreateInvokerResponse CreateInvoker(CreateInvokerRequest req)
                                    throws TencentCloudSDKException
```
    此接口用于创建执行器。
    
    Parameters:
    
    req - CreateInvokerRequest
    
    Returns:
    
    CreateInvokerResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteCommand
```
public DeleteCommandResponse DeleteCommand(DeleteCommandRequest req)
                                    throws TencentCloudSDKException
```
    此接口用于删除命令。如果命令与执行器关联，则无法被删除。
    
    Parameters:
    
    req - DeleteCommandRequest
    
    Returns:
    
    DeleteCommandResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteInvoker
```
public DeleteInvokerResponse DeleteInvoker(DeleteInvokerRequest req)
                                    throws TencentCloudSDKException
```
    此接口用于删除执行器。
    
    Parameters:
    
    req - DeleteInvokerRequest
    
    Returns:
    
    DeleteInvokerResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAutomationAgentStatus
```
public DescribeAutomationAgentStatusResponse DescribeAutomationAgentStatus(DescribeAutomationAgentStatusRequest req)
                                                                    throws TencentCloudSDKException
```
    此接口用于查询自动化助手客户端的状态。
    
    Parameters:
    
    req - DescribeAutomationAgentStatusRequest
    
    Returns:
    
    DescribeAutomationAgentStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCommands
```
public DescribeCommandsResponse DescribeCommands(DescribeCommandsRequest req)
                                          throws TencentCloudSDKException
```
    此接口用于查询命令详情。
    
    Parameters:
    
    req - DescribeCommandsRequest
    
    Returns:
    
    DescribeCommandsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInvocationTasks
```
public DescribeInvocationTasksResponse DescribeInvocationTasks(DescribeInvocationTasksRequest req)
                                                        throws TencentCloudSDKException
```
    此接口用于查询执行任务详情。
    
    Parameters:
    
    req - DescribeInvocationTasksRequest
    
    Returns:
    
    DescribeInvocationTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInvocations
```
public DescribeInvocationsResponse DescribeInvocations(DescribeInvocationsRequest req)
                                                throws TencentCloudSDKException
```
    此接口用于查询执行活动详情。
    
    Parameters:
    
    req - DescribeInvocationsRequest
    
    Returns:
    
    DescribeInvocationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInvokerRecords
```
public DescribeInvokerRecordsResponse DescribeInvokerRecords(DescribeInvokerRecordsRequest req)
                                                      throws TencentCloudSDKException
```
    此接口用于查询执行器的执行记录。
    
    Parameters:
    
    req - DescribeInvokerRecordsRequest
    
    Returns:
    
    DescribeInvokerRecordsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInvokers
```
public DescribeInvokersResponse DescribeInvokers(DescribeInvokersRequest req)
                                          throws TencentCloudSDKException
```
    此接口用于查询执行器信息。
    
    Parameters:
    
    req - DescribeInvokersRequest
    
    Returns:
    
    DescribeInvokersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRegions
```
public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException
```
    此接口用于查询 TAT 产品后台地域列表。 RegionState 为 AVAILABLE，代表该地域的 TAT 后台服务已经可用；未返回，代表该地域的 TAT 后台服务尚不可用。
    
    Parameters:
    
    req - DescribeRegionsRequest
    
    Returns:
    
    DescribeRegionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableInvoker
```
public DisableInvokerResponse DisableInvoker(DisableInvokerRequest req)
                                      throws TencentCloudSDKException
```
    此接口用于停止执行器。
    
    Parameters:
    
    req - DisableInvokerRequest
    
    Returns:
    
    DisableInvokerResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableInvoker
```
public EnableInvokerResponse EnableInvoker(EnableInvokerRequest req)
                                    throws TencentCloudSDKException
```
    此接口用于启用执行器。
    
    Parameters:
    
    req - EnableInvokerRequest
    
    Returns:
    
    EnableInvokerResponse
    
    Throws:
    
    TencentCloudSDKException
  - InvokeCommand
```
public InvokeCommandResponse InvokeCommand(InvokeCommandRequest req)
                                    throws TencentCloudSDKException
```
    在指定的实例上触发命令，调用成功返回执行活动ID（inv-xxxxxxxx），每个执行活动内部有一个或多个执行任务（invt-xxxxxxxx），每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。如果指定实例未安装 agent，或 agent 不在线，返回失败如果命令类型与 agent 运行环境不符，返回失败指定的实例需要处于 VPC 网络指定的实例需要处于 RUNNING 状态不可同时指定 CVM 和 Lighthouse
    
    Parameters:
    
    req - InvokeCommandRequest
    
    Returns:
    
    InvokeCommandResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyCommand
```
public ModifyCommandResponse ModifyCommand(ModifyCommandRequest req)
                                    throws TencentCloudSDKException
```
    此接口用于修改命令。
    
    Parameters:
    
    req - ModifyCommandRequest
    
    Returns:
    
    ModifyCommandResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyInvoker
```
public ModifyInvokerResponse ModifyInvoker(ModifyInvokerRequest req)
                                    throws TencentCloudSDKException
```
    此接口用于修改执行器。
    
    Parameters:
    
    req - ModifyInvokerRequest
    
    Returns:
    
    ModifyInvokerResponse
    
    Throws:
    
    TencentCloudSDKException
  - PreviewReplacedCommandContent
```
public PreviewReplacedCommandContentResponse PreviewReplacedCommandContent(PreviewReplacedCommandContentRequest req)
                                                                    throws TencentCloudSDKException
```
    此接口用于预览自定义参数替换后的命令内容。不会触发真实执行。
    
    Parameters:
    
    req - PreviewReplacedCommandContentRequest
    
    Returns:
    
    PreviewReplacedCommandContentResponse
    
    Throws:
    
    TencentCloudSDKException
  - RunCommand
```
public RunCommandResponse RunCommand(RunCommandRequest req)
                              throws TencentCloudSDKException
```
    执行命令，调用成功返回执行活动ID（inv-xxxxxxxx），每个执行活动内部有一个或多个执行任务（invt-xxxxxxxx），每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。如果指定实例未安装 agent，或 agent 不在线，返回失败如果命令类型与 agent 运行环境不符，返回失败指定的实例需要处于 VPC 网络指定的实例需要处于 `RUNNING` 状态不可同时指定 CVM 和 Lighthouse
    
    Parameters:
    
    req - RunCommandRequest
    
    Returns:
    
    RunCommandResponse
    
    Throws:
    
    TencentCloudSDKException

Class TatClient

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

TatClient

TatClient

Method Detail

CancelInvocation

CreateCommand

CreateInvoker

DeleteCommand

DeleteInvoker

DescribeAutomationAgentStatus

DescribeCommands

DescribeInvocationTasks

DescribeInvocations

DescribeInvokerRecords

DescribeInvokers

DescribeRegions

DisableInvoker

EnableInvoker

InvokeCommand

ModifyCommand

ModifyInvoker

PreviewReplacedCommandContent

RunCommand