com.tencentcloudapi.tat.v20201028

Class TatClient

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

Modifier and Type	Method and Description
CancelInvocationResponse	CancelInvocation(CancelInvocationRequest req) This API is used to cancel the command executed on one or more CVM instances.
CreateCommandResponse	CreateCommand(CreateCommandRequest req) This API is used to create a command.
CreateInvokerResponse	CreateInvoker(CreateInvokerRequest req) This API is used to create an invoker.
DeleteCommandResponse	DeleteCommand(DeleteCommandRequest req) This API is used to delete a command.
DeleteInvokerResponse	DeleteInvoker(DeleteInvokerRequest req) This API is used to delete an invoker.
DescribeAutomationAgentStatusResponse	DescribeAutomationAgentStatus(DescribeAutomationAgentStatusRequest req) This API is used to query the status of the TAT agent.
DescribeCommandsResponse	DescribeCommands(DescribeCommandsRequest req) This API is used to query command details.
DescribeInvocationsResponse	DescribeInvocations(DescribeInvocationsRequest req) This API is used to query execution activity details.
DescribeInvocationTasksResponse	DescribeInvocationTasks(DescribeInvocationTasksRequest req) This API is used to query execution task details.
DescribeInvokerRecordsResponse	DescribeInvokerRecords(DescribeInvokerRecordsRequest req) This API is used to query the execution history of an invoker.
DescribeInvokersResponse	DescribeInvokers(DescribeInvokersRequest req) This API is used to query invoker details.
DescribeRegionsResponse	DescribeRegions(DescribeRegionsRequest req) This API is used to query the list of regions that supports TAT.
DisableInvokerResponse	DisableInvoker(DisableInvokerRequest req) This API is used to disable an invoker.
EnableInvokerResponse	EnableInvoker(EnableInvokerRequest req) This API is used to enable an invoker.
InvokeCommandResponse	InvokeCommand(InvokeCommandRequest req) This API is used to trigger a command on the specified instance and returns the execution activity ID (inv-xxxxxxxx) on success.
ModifyCommandResponse	ModifyCommand(ModifyCommandRequest req) This API is used to modify a command.
ModifyInvokerResponse	ModifyInvoker(ModifyInvokerRequest req) This API is used to modify an invoker.
PreviewReplacedCommandContentResponse	PreviewReplacedCommandContent(PreviewReplacedCommandContentRequest req) This API is used to preview the command with custom parameters.
RunCommandResponse	RunCommand(RunCommandRequest req) This API is used to execute a command and returns the execution activity ID (inv-xxxxxxxx) on success.

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

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

This API is used to cancel the command executed on one or more CVM instances. If the command has not been delivered to the TAT agent, the task status is `PENDING`, `DELIVERING`, or `DELIVER_DELAYED`, and will be `CANCELLED` after the command is canceled. If the command has been delivered to the TAT agent, the task status is `RUNNING`, and will be `TERMINATED` after the command is canceled.

Parameters:

req - CancelInvocationRequest

Returns:

CancelInvocationResponse

Throws:

TencentCloudSDKException

CreateCommand

public CreateCommandResponse CreateCommand(CreateCommandRequest req)
                                    throws TencentCloudSDKException

This API is used to create a command.

Parameters:

req - CreateCommandRequest

Returns:

CreateCommandResponse

Throws:

TencentCloudSDKException

CreateInvoker

public CreateInvokerResponse CreateInvoker(CreateInvokerRequest req)
                                    throws TencentCloudSDKException

This API is used to create an invoker.

Parameters:

req - CreateInvokerRequest

Returns:

CreateInvokerResponse

Throws:

TencentCloudSDKException

DeleteCommand

public DeleteCommandResponse DeleteCommand(DeleteCommandRequest req)
                                    throws TencentCloudSDKException

This API is used to delete a command. Commands bound to an invoker cannot be deleted.

Parameters:

req - DeleteCommandRequest

Returns:

DeleteCommandResponse

Throws:

TencentCloudSDKException

DeleteInvoker

public DeleteInvokerResponse DeleteInvoker(DeleteInvokerRequest req)
                                    throws TencentCloudSDKException

This API is used to delete an invoker.

Parameters:

req - DeleteInvokerRequest

Returns:

DeleteInvokerResponse

Throws:

TencentCloudSDKException

DescribeAutomationAgentStatus

public DescribeAutomationAgentStatusResponse DescribeAutomationAgentStatus(DescribeAutomationAgentStatusRequest req)
                                                                    throws TencentCloudSDKException

This API is used to query the status of the TAT agent.

Parameters:

req - DescribeAutomationAgentStatusRequest

Returns:

DescribeAutomationAgentStatusResponse

Throws:

TencentCloudSDKException

DescribeCommands

public DescribeCommandsResponse DescribeCommands(DescribeCommandsRequest req)
                                          throws TencentCloudSDKException

This API is used to query command details.

Parameters:

req - DescribeCommandsRequest

Returns:

DescribeCommandsResponse

Throws:

TencentCloudSDKException

DescribeInvocationTasks

public DescribeInvocationTasksResponse DescribeInvocationTasks(DescribeInvocationTasksRequest req)
                                                        throws TencentCloudSDKException

This API is used to query execution task details.

Parameters:

req - DescribeInvocationTasksRequest

Returns:

DescribeInvocationTasksResponse

Throws:

TencentCloudSDKException

DescribeInvocations

public DescribeInvocationsResponse DescribeInvocations(DescribeInvocationsRequest req)
                                                throws TencentCloudSDKException

This API is used to query execution activity details.

Parameters:

req - DescribeInvocationsRequest

Returns:

DescribeInvocationsResponse

Throws:

TencentCloudSDKException

DescribeInvokerRecords

public DescribeInvokerRecordsResponse DescribeInvokerRecords(DescribeInvokerRecordsRequest req)
                                                      throws TencentCloudSDKException

This API is used to query the execution history of an invoker.

Parameters:

req - DescribeInvokerRecordsRequest

Returns:

DescribeInvokerRecordsResponse

Throws:

TencentCloudSDKException

DescribeInvokers

public DescribeInvokersResponse DescribeInvokers(DescribeInvokersRequest req)
                                          throws TencentCloudSDKException

This API is used to query invoker details.

Parameters:

req - DescribeInvokersRequest

Returns:

DescribeInvokersResponse

Throws:

TencentCloudSDKException

DescribeRegions

public DescribeRegionsResponse DescribeRegions(DescribeRegionsRequest req)
                                        throws TencentCloudSDKException

This API is used to query the list of regions that supports TAT. If the `RegionState` is `AVAILABLE`, it means that TAT is available in the region. If no value is returned, TAT is not available in the region.

Parameters:

req - DescribeRegionsRequest

Returns:

DescribeRegionsResponse

Throws:

TencentCloudSDKException

DisableInvoker

public DisableInvokerResponse DisableInvoker(DisableInvokerRequest req)
                                      throws TencentCloudSDKException

This API is used to disable an invoker.

Parameters:

req - DisableInvokerRequest

Returns:

DisableInvokerResponse

Throws:

TencentCloudSDKException

EnableInvoker

public EnableInvokerResponse EnableInvoker(EnableInvokerRequest req)
                                    throws TencentCloudSDKException

This API is used to enable an invoker.

Parameters:

req - EnableInvokerRequest

Returns:

EnableInvokerResponse

Throws:

TencentCloudSDKException

InvokeCommand

public InvokeCommandResponse InvokeCommand(InvokeCommandRequest req)
                                    throws TencentCloudSDKException

This API is used to trigger a command on the specified instance and returns the execution activity ID (inv-xxxxxxxx) on success. Each execution activity has one or more execution tasks (invt-xxxxxxxx) and each execution task indicates an execution record on a CVM or Lighthouse instance. If the agent is not installed on the instance or is offline, an error is returned. If the command type is not supported by the agent runtime environment, an error is returned. The specified instance needs to be in a VPC network. The specified instance needs to be in the RUNNING status. Only one type of instances (CVM or Lighthouse) can be specified in a single request.

Parameters:

req - InvokeCommandRequest

Returns:

InvokeCommandResponse

Throws:

TencentCloudSDKException

ModifyCommand

public ModifyCommandResponse ModifyCommand(ModifyCommandRequest req)
                                    throws TencentCloudSDKException

This API is used to modify a command.

Parameters:

req - ModifyCommandRequest

Returns:

ModifyCommandResponse

Throws:

TencentCloudSDKException

ModifyInvoker

public ModifyInvokerResponse ModifyInvoker(ModifyInvokerRequest req)
                                    throws TencentCloudSDKException

This API is used to modify an invoker.

Parameters:

req - ModifyInvokerRequest

Returns:

ModifyInvokerResponse

Throws:

TencentCloudSDKException

PreviewReplacedCommandContent

public PreviewReplacedCommandContentResponse PreviewReplacedCommandContent(PreviewReplacedCommandContentRequest req)
                                                                    throws TencentCloudSDKException

This API is used to preview the command with custom parameters. The command is not executed.

Parameters:

req - PreviewReplacedCommandContentRequest

Returns:

PreviewReplacedCommandContentResponse

Throws:

TencentCloudSDKException

RunCommand

public RunCommandResponse RunCommand(RunCommandRequest req)
                              throws TencentCloudSDKException

This API is used to execute a command and returns the execution activity ID (inv-xxxxxxxx) on success. Each execution has one or more execution tasks (invt-xxxxxxxx) and each execution task indicates an execution record on a CVM or Lighthouse instance. If the agent is not installed on the instance or is offline, an error is returned. If the command type is not supported by the agent runtime environment, an error is returned. The specified instance needs to be in a VPC network. The specified instance needs to be in the `RUNNING` status. Only one type of instances (CVM or Lighthouse) can be specified in a single request.

Parameters:

req - RunCommandRequest

Returns:

RunCommandResponse

Throws:

TencentCloudSDKException