v20201028

package
v3.0.426+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 28, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error.
	AUTHFAILURE = "AuthFailure"

	// Failed to access the CVM.
	FAILEDOPERATION_CVMERROR = "FailedOperation.CVMError"

	// Failed to access the Lighthouse instance.
	FAILEDOPERATION_LIGHTHOUSEERROR = "FailedOperation.LighthouseError"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Conflicting parameters.
	INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"

	// Invalid username.
	INVALIDPARAMETER_INVALIDUSERNAME = "InvalidParameter.InvalidUsername"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// TAT Agent does not support this command type.
	INVALIDPARAMETERVALUE_AGENTUNSUPPORTEDCOMMANDTYPE = "InvalidParameterValue.AgentUnsupportedCommandType"

	// Invalid command content.
	INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"

	// Duplicate command name.
	INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"

	// Inconsistent instance type.
	INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"

	// The instance with this ID has no such execution activity.
	INVALIDPARAMETERVALUE_INSTANCEISNOTRELATEDTOINVOCATION = "InvalidParameterValue.InstanceIsNotRelatedToInvocation"

	// Invalid CommandId.
	INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"

	// Invalid command name.
	INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"

	// Invalid command.
	INVALIDPARAMETERVALUE_INVALIDCONTENT = "InvalidParameterValue.InvalidContent"

	// Invalid crontab expression.
	INVALIDPARAMETERVALUE_INVALIDCRONEXPRESSION = "InvalidParameterValue.InvalidCronExpression"

	// Invalid filter.
	INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"

	// Invalid instance ID.
	INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"

	// Invalid execution activity ID.
	INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"

	// Invalid execution task ID.
	INVALIDPARAMETERVALUE_INVALIDINVOCATIONTASKID = "InvalidParameterValue.InvalidInvocationTaskId"

	// Invalid InvokerId.
	INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"

	// Invalid OutputCOSBucketUrl.
	INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"

	// Invalid OutputCOSKeyPrefix.
	INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"

	// Invalid command execution path.
	INVALIDPARAMETERVALUE_INVALIDWORKINGDIRECTORY = "InvalidParameterValue.InvalidWorkingDirectory"

	// The custom parameter feature is enabled, but custom parameters are missing.
	INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"

	// Parameters not provided.
	INVALIDPARAMETERVALUE_LACKOFPARAMETERS = "InvalidParameterValue.LackOfParameters"

	// Parameter limit exceeded.
	INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"

	// The custom parameter feature is not enabled.
	INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"

	// The parameter is not a valid JSON string.
	INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"

	// The parameter key contains invalid characters.
	INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"

	// Duplicate parameter keys.
	INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"

	// The parameter key is too long.
	INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"

	// Too many parameters.
	INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"

	// The parameter value is not a string.
	INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"

	// The parameter value is not in the valid range.
	INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"

	// The custom parameter feature is not enabled.
	INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"

	// Length limit exceeded.
	INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"

	// Reached the quota limit.
	LIMITEXCEEDED = "LimitExceeded"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// The command does not exist.
	RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"

	// The instance does not exist.
	RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"

	// No execution activity found.
	RESOURCENOTFOUND_INVOCATIONNOTFOUND = "ResourceNotFound.InvocationNotFound"

	// TAT Agent is not installed.
	RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"

	// TAT Agent is offline.
	RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"

	// The command is being executed.
	RESOURCEUNAVAILABLE_COMMANDINEXECUTING = "ResourceUnavailable.CommandInExecuting"

	// The command has been bound to an invoker.
	RESOURCEUNAVAILABLE_COMMANDININVOKER = "ResourceUnavailable.CommandInInvoker"

	// The instance is not running.
	RESOURCEUNAVAILABLE_INSTANCESTATENOTRUNNING = "ResourceUnavailable.InstanceStateNotRunning"

	// CAM authentication failed.
	UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"

	// Invalid token.
	UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"

	// The Multi-factor authentication (MFA) code expired.
	UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"

	// Multi-factor authentication (MFA) does not exist.
	UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"
)
View Source 
const APIVersion = "2020-10-28"

Variables

This section is empty.

Functions

This section is empty.

Types

type AutomationAgentInfo 

type AutomationAgentInfo struct {

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Agent version.
	Version *string `json:"Version,omitempty" name:"Version"`

	// Last heartbeat time
	LastHeartbeatTime *string `json:"LastHeartbeatTime,omitempty" name:"LastHeartbeatTime"`

	// Agent status. Valid values:
	// <li> `Online`
	// <li> `Offline`
	AgentStatus *string `json:"AgentStatus,omitempty" name:"AgentStatus"`

	// Agent runtime environment. Valid values:
	// <li> `Linux`: Linux instance
	// <li> `Windows`: Windows instance
	Environment *string `json:"Environment,omitempty" name:"Environment"`
}

type CancelInvocationRequest 

type CancelInvocationRequest struct {
	*tchttp.BaseRequest

	// Execution activity ID
	InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

	// Instance ID list. A maximum of 100 IDs are allowed. Supported instance types:
	// <li> `CVM`
	// <li> `LIGHTHOUSE`
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`
}

func NewCancelInvocationRequest 

func NewCancelInvocationRequest() (request *CancelInvocationRequest)

func (*CancelInvocationRequest) FromJsonString 

func (r *CancelInvocationRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelInvocationRequest) ToJsonString 

func (r *CancelInvocationRequest) ToJsonString() string

type CancelInvocationResponse 

type CancelInvocationResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCancelInvocationResponse 

func NewCancelInvocationResponse() (response *CancelInvocationResponse)

func (*CancelInvocationResponse) FromJsonString 

func (r *CancelInvocationResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelInvocationResponse) ToJsonString 

func (r *CancelInvocationResponse) ToJsonString() string

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CancelInvocation 

func (c *Client) CancelInvocation(request *CancelInvocationRequest) (response *CancelInvocationResponse, err error)

CancelInvocation 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCEISNOTRELATEDTOINVOCATION = "InvalidParameterValue.InstanceIsNotRelatedToInvocation"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INVOCATIONNOTFOUND = "ResourceNotFound.InvocationNotFound"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) CancelInvocationWithContext 

func (c *Client) CancelInvocationWithContext(ctx context.Context, request *CancelInvocationRequest) (response *CancelInvocationResponse, err error)

CancelInvocation 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCEISNOTRELATEDTOINVOCATION = "InvalidParameterValue.InstanceIsNotRelatedToInvocation"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INVOCATIONNOTFOUND = "ResourceNotFound.InvocationNotFound"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"
UNKNOWNPARAMETER = "UnknownParameter"

func (*Client) CreateCommand 

func (c *Client) CreateCommand(request *CreateCommandRequest) (response *CreateCommandResponse, err error)

CreateCommand This API is used to create a command.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"
INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"
INVALIDPARAMETERVALUE_INVALIDCONTENT = "InvalidParameterValue.InvalidContent"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_INVALIDWORKINGDIRECTORY = "InvalidParameterValue.InvalidWorkingDirectory"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) CreateCommandWithContext 

func (c *Client) CreateCommandWithContext(ctx context.Context, request *CreateCommandRequest) (response *CreateCommandResponse, err error)

CreateCommand This API is used to create a command.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"
INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"
INVALIDPARAMETERVALUE_INVALIDCONTENT = "InvalidParameterValue.InvalidContent"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_INVALIDWORKINGDIRECTORY = "InvalidParameterValue.InvalidWorkingDirectory"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
MISSINGPARAMETER = "MissingParameter"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) CreateInvoker 

func (c *Client) CreateInvoker(request *CreateInvokerRequest) (response *CreateInvokerResponse, err error)

CreateInvoker This API is used to create an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDCRONEXPRESSION = "InvalidParameterValue.InvalidCronExpression"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"

func (*Client) CreateInvokerWithContext 

func (c *Client) CreateInvokerWithContext(ctx context.Context, request *CreateInvokerRequest) (response *CreateInvokerResponse, err error)

CreateInvoker This API is used to create an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDCRONEXPRESSION = "InvalidParameterValue.InvalidCronExpression"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"

func (*Client) DeleteCommand 

func (c *Client) DeleteCommand(request *DeleteCommandRequest) (response *DeleteCommandResponse, err error)

DeleteCommand This API is used to delete a command.

Commands bound to an invoker cannot be deleted.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCEUNAVAILABLE_COMMANDINEXECUTING = "ResourceUnavailable.CommandInExecuting"
RESOURCEUNAVAILABLE_COMMANDININVOKER = "ResourceUnavailable.CommandInInvoker"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DeleteCommandWithContext 

func (c *Client) DeleteCommandWithContext(ctx context.Context, request *DeleteCommandRequest) (response *DeleteCommandResponse, err error)

DeleteCommand This API is used to delete a command.

Commands bound to an invoker cannot be deleted.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCEUNAVAILABLE_COMMANDINEXECUTING = "ResourceUnavailable.CommandInExecuting"
RESOURCEUNAVAILABLE_COMMANDININVOKER = "ResourceUnavailable.CommandInInvoker"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DeleteInvoker 

func (c *Client) DeleteInvoker(request *DeleteInvokerRequest) (response *DeleteInvokerResponse, err error)

DeleteInvoker This API is used to delete an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DeleteInvokerWithContext 

func (c *Client) DeleteInvokerWithContext(ctx context.Context, request *DeleteInvokerRequest) (response *DeleteInvokerResponse, err error)

DeleteInvoker This API is used to delete an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeAutomationAgentStatus 

func (c *Client) DescribeAutomationAgentStatus(request *DescribeAutomationAgentStatusRequest) (response *DescribeAutomationAgentStatusResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeAutomationAgentStatusWithContext 

func (c *Client) DescribeAutomationAgentStatusWithContext(ctx context.Context, request *DescribeAutomationAgentStatusRequest) (response *DescribeAutomationAgentStatusResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeCommands 

func (c *Client) DescribeCommands(request *DescribeCommandsRequest) (response *DescribeCommandsResponse, err error)

DescribeCommands This API is used to query command details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeCommandsWithContext 

func (c *Client) DescribeCommandsWithContext(ctx context.Context, request *DescribeCommandsRequest) (response *DescribeCommandsResponse, err error)

DescribeCommands This API is used to query command details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeInvocationTasks 

func (c *Client) DescribeInvocationTasks(request *DescribeInvocationTasksRequest) (response *DescribeInvocationTasksResponse, err error)

DescribeInvocationTasks This API is used to query execution task details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONTASKID = "InvalidParameterValue.InvalidInvocationTaskId"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeInvocationTasksWithContext 

func (c *Client) DescribeInvocationTasksWithContext(ctx context.Context, request *DescribeInvocationTasksRequest) (response *DescribeInvocationTasksResponse, err error)

DescribeInvocationTasks This API is used to query execution task details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONTASKID = "InvalidParameterValue.InvalidInvocationTaskId"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeInvocations 

func (c *Client) DescribeInvocations(request *DescribeInvocationsRequest) (response *DescribeInvocationsResponse, err error)

DescribeInvocations This API is used to query execution activity details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeInvocationsWithContext 

func (c *Client) DescribeInvocationsWithContext(ctx context.Context, request *DescribeInvocationsRequest) (response *DescribeInvocationsResponse, err error)

DescribeInvocations This API is used to query execution activity details.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeInvokerRecords 

func (c *Client) DescribeInvokerRecords(request *DescribeInvokerRecordsRequest) (response *DescribeInvokerRecordsResponse, err error)

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

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"

func (*Client) DescribeInvokerRecordsWithContext 

func (c *Client) DescribeInvokerRecordsWithContext(ctx context.Context, request *DescribeInvokerRecordsRequest) (response *DescribeInvokerRecordsResponse, err error)

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

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"

func (*Client) DescribeInvokers 

func (c *Client) DescribeInvokers(request *DescribeInvokersRequest) (response *DescribeInvokersResponse, err error)

DescribeInvokers This API is used to query invoker details.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"

func (*Client) DescribeInvokersWithContext 

func (c *Client) DescribeInvokersWithContext(ctx context.Context, request *DescribeInvokersRequest) (response *DescribeInvokersResponse, err error)

DescribeInvokers This API is used to query invoker details.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"

func (*Client) DescribeRegions 

func (c *Client) DescribeRegions(request *DescribeRegionsRequest) (response *DescribeRegionsResponse, err error)

DescribeRegions 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DescribeRegionsWithContext 

func (c *Client) DescribeRegionsWithContext(ctx context.Context, request *DescribeRegionsRequest) (response *DescribeRegionsResponse, err error)

DescribeRegions 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) DisableInvoker 

func (c *Client) DisableInvoker(request *DisableInvokerRequest) (response *DisableInvokerResponse, err error)

DisableInvoker This API is used to disable an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DisableInvokerWithContext 

func (c *Client) DisableInvokerWithContext(ctx context.Context, request *DisableInvokerRequest) (response *DisableInvokerResponse, err error)

DisableInvoker This API is used to disable an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) EnableInvoker 

func (c *Client) EnableInvoker(request *EnableInvokerRequest) (response *EnableInvokerResponse, err error)

EnableInvoker This API is used to enable an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) EnableInvokerWithContext 

func (c *Client) EnableInvokerWithContext(ctx context.Context, request *EnableInvokerRequest) (response *EnableInvokerResponse, err error)

EnableInvoker This API is used to enable an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) InvokeCommand 

func (c *Client) InvokeCommand(request *InvokeCommandRequest) (response *InvokeCommandResponse, err error)

InvokeCommand 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.

error code that may be returned: 

FAILEDOPERATION_CVMERROR = "FailedOperation.CVMError"
FAILEDOPERATION_LIGHTHOUSEERROR = "FailedOperation.LighthouseError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INVALIDUSERNAME = "InvalidParameter.InvalidUsername"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_AGENTUNSUPPORTEDCOMMANDTYPE = "InvalidParameterValue.AgentUnsupportedCommandType"
INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"
RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"
RESOURCEUNAVAILABLE_INSTANCESTATENOTRUNNING = "ResourceUnavailable.InstanceStateNotRunning"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) InvokeCommandWithContext 

func (c *Client) InvokeCommandWithContext(ctx context.Context, request *InvokeCommandRequest) (response *InvokeCommandResponse, err error)

InvokeCommand 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.

error code that may be returned: 

FAILEDOPERATION_CVMERROR = "FailedOperation.CVMError"
FAILEDOPERATION_LIGHTHOUSEERROR = "FailedOperation.LighthouseError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INVALIDUSERNAME = "InvalidParameter.InvalidUsername"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_AGENTUNSUPPORTEDCOMMANDTYPE = "InvalidParameterValue.AgentUnsupportedCommandType"
INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"
RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"
RESOURCEUNAVAILABLE_INSTANCESTATENOTRUNNING = "ResourceUnavailable.InstanceStateNotRunning"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) ModifyCommand 

func (c *Client) ModifyCommand(request *ModifyCommandRequest) (response *ModifyCommandResponse, err error)

ModifyCommand This API is used to modify a command.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) ModifyCommandWithContext 

func (c *Client) ModifyCommandWithContext(ctx context.Context, request *ModifyCommandRequest) (response *ModifyCommandResponse, err error)

ModifyCommand This API is used to modify a command.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) ModifyInvoker 

func (c *Client) ModifyInvoker(request *ModifyInvokerRequest) (response *ModifyInvokerResponse, err error)

ModifyInvoker This API is used to modify an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"

func (*Client) ModifyInvokerWithContext 

func (c *Client) ModifyInvokerWithContext(ctx context.Context, request *ModifyInvokerRequest) (response *ModifyInvokerResponse, err error)

ModifyInvoker This API is used to modify an invoker.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"

func (*Client) PreviewReplacedCommandContent 

func (c *Client) PreviewReplacedCommandContent(request *PreviewReplacedCommandContentRequest) (response *PreviewReplacedCommandContentResponse, err error)

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

error code that may be returned: 

INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"
INVALIDPARAMETERVALUE_LACKOFPARAMETERS = "InvalidParameterValue.LackOfParameters"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) PreviewReplacedCommandContentWithContext 

func (c *Client) PreviewReplacedCommandContentWithContext(ctx context.Context, request *PreviewReplacedCommandContentRequest) (response *PreviewReplacedCommandContentResponse, err error)

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

error code that may be returned: 

INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"
INVALIDPARAMETERVALUE_LACKOFPARAMETERS = "InvalidParameterValue.LackOfParameters"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) RunCommand 

func (c *Client) RunCommand(request *RunCommandRequest) (response *RunCommandResponse, err error)

RunCommand 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.

error code that may be returned: 

FAILEDOPERATION_CVMERROR = "FailedOperation.CVMError"
FAILEDOPERATION_LIGHTHOUSEERROR = "FailedOperation.LighthouseError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INVALIDUSERNAME = "InvalidParameter.InvalidUsername"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_AGENTUNSUPPORTEDCOMMANDTYPE = "InvalidParameterValue.AgentUnsupportedCommandType"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"
INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"
INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"
INVALIDPARAMETERVALUE_INVALIDCONTENT = "InvalidParameterValue.InvalidContent"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_INVALIDWORKINGDIRECTORY = "InvalidParameterValue.InvalidWorkingDirectory"
INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"
RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"
RESOURCEUNAVAILABLE_INSTANCESTATENOTRUNNING = "ResourceUnavailable.InstanceStateNotRunning"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

func (*Client) RunCommandWithContext 

func (c *Client) RunCommandWithContext(ctx context.Context, request *RunCommandRequest) (response *RunCommandResponse, err error)

RunCommand 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.

error code that may be returned: 

FAILEDOPERATION_CVMERROR = "FailedOperation.CVMError"
FAILEDOPERATION_LIGHTHOUSEERROR = "FailedOperation.LighthouseError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INVALIDUSERNAME = "InvalidParameter.InvalidUsername"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_AGENTUNSUPPORTEDCOMMANDTYPE = "InvalidParameterValue.AgentUnsupportedCommandType"
INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"
INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"
INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"
INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"
INVALIDPARAMETERVALUE_INVALIDCONTENT = "InvalidParameterValue.InvalidContent"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"
INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"
INVALIDPARAMETERVALUE_INVALIDWORKINGDIRECTORY = "InvalidParameterValue.InvalidWorkingDirectory"
INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"
INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"
INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"
INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"
INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"
INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"
RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"
RESOURCEUNAVAILABLE_INSTANCESTATENOTRUNNING = "ResourceUnavailable.InstanceStateNotRunning"
UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"
UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"
UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"
UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

type Command 

type Command struct {

	// Command ID.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// Command name.
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// Command description.
	Description *string `json:"Description,omitempty" name:"Description"`

	// Base64-encoded command.
	Content *string `json:"Content,omitempty" name:"Content"`

	// Command type.
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// Command execution path.
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// Command timeout period.
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// Command creation time.
	CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`

	// Command update time.
	UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`

	// Whether to enable the custom parameter feature.
	EnableParameter *bool `json:"EnableParameter,omitempty" name:"EnableParameter"`

	// Default custom parameter value.
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`

	// Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands.
	FormattedDescription *string `json:"FormattedDescription,omitempty" name:"FormattedDescription"`

	// Command creator. `TAT` indicates a public command and `USER` indicates a personal command.
	CreatedBy *string `json:"CreatedBy,omitempty" name:"CreatedBy"`

	// The list of tags bound to the command.
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`

	// The user who executes the command on the instance.
	Username *string `json:"Username,omitempty" name:"Username"`

	// The COS bucket URL for uploading logs.
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitempty" name:"OutputCOSBucketUrl"`

	// The COS bucket directory where the logs are saved.
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitempty" name:"OutputCOSKeyPrefix"`
}

type CommandDocument 

type CommandDocument struct {

	// Base64-encoded command.
	Content *string `json:"Content,omitempty" name:"Content"`

	// Command type.
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// Timeout period.
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// Execution path.
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// The user who executes the command.
	Username *string `json:"Username,omitempty" name:"Username"`
}

type CreateCommandRequest 

type CreateCommandRequest struct {
	*tchttp.BaseRequest

	// Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// Base64-encoded command. The maximum length is 64 KB.
	Content *string `json:"Content,omitempty" name:"Content"`

	// Command description. The maximum length is 120 characters.
	Description *string `json:"Description,omitempty" name:"Description"`

	// Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// Whether to enable the custom parameter feature.
	// This cannot be modified once created.
	// Default value: `false`.
	EnableParameter *bool `json:"EnableParameter,omitempty" name:"EnableParameter"`

	// The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
	// `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
	// If no parameter value is provided in the `InvokeCommand` API, the default value is used.
	// Up to 20 custom parameters are supported.
	// The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`

	// Tags bound to the command. At most 10 tags are allowed.
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`

	// The username used to execute the command on the CVM or Lighthouse instance.
	// The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
	Username *string `json:"Username,omitempty" name:"Username"`

	// The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitempty" name:"OutputCOSBucketUrl"`

	// The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
	// 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
	// 2. Use a slash (/) to create a subdirectory.
	// 3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewCreateCommandRequest 

func NewCreateCommandRequest() (request *CreateCommandRequest)

func (*CreateCommandRequest) FromJsonString 

func (r *CreateCommandRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateCommandRequest) ToJsonString 

func (r *CreateCommandRequest) ToJsonString() string

type CreateCommandResponse 

type CreateCommandResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Command ID.
		CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateCommandResponse 

func NewCreateCommandResponse() (response *CreateCommandResponse)

func (*CreateCommandResponse) FromJsonString 

func (r *CreateCommandResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateCommandResponse) ToJsonString 

func (r *CreateCommandResponse) ToJsonString() string

type CreateInvokerRequest 

type CreateInvokerRequest struct {
	*tchttp.BaseRequest

	// Invoker name.
	Name *string `json:"Name,omitempty" name:"Name"`

	// Invoker type. It can only be `SCHEDULE` (recurring invokers).
	Type *string `json:"Type,omitempty" name:"Type"`

	// Remote command ID.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// ID of the instance bound to the trigger. Up to 100 IDs are allowed.
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// The user who executes the command.
	Username *string `json:"Username,omitempty" name:"Username"`

	// Custom parameters of the command.
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// Settings required for a recurring invoker.
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitempty" name:"ScheduleSettings"`
}

func NewCreateInvokerRequest 

func NewCreateInvokerRequest() (request *CreateInvokerRequest)

func (*CreateInvokerRequest) FromJsonString 

func (r *CreateInvokerRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateInvokerRequest) ToJsonString 

func (r *CreateInvokerRequest) ToJsonString() string

type CreateInvokerResponse 

type CreateInvokerResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Invoker ID.
		InvokerId *string `json:"InvokerId,omitempty" name:"InvokerId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateInvokerResponse 

func NewCreateInvokerResponse() (response *CreateInvokerResponse)

func (*CreateInvokerResponse) FromJsonString 

func (r *CreateInvokerResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateInvokerResponse) ToJsonString 

func (r *CreateInvokerResponse) ToJsonString() string

type DeleteCommandRequest 

type DeleteCommandRequest struct {
	*tchttp.BaseRequest

	// ID of the command to be deleted.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`
}

func NewDeleteCommandRequest 

func NewDeleteCommandRequest() (request *DeleteCommandRequest)

func (*DeleteCommandRequest) FromJsonString 

func (r *DeleteCommandRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteCommandRequest) ToJsonString 

func (r *DeleteCommandRequest) ToJsonString() string

type DeleteCommandResponse 

type DeleteCommandResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteCommandResponse 

func NewDeleteCommandResponse() (response *DeleteCommandResponse)

func (*DeleteCommandResponse) FromJsonString 

func (r *DeleteCommandResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteCommandResponse) ToJsonString 

func (r *DeleteCommandResponse) ToJsonString() string

type DeleteInvokerRequest 

type DeleteInvokerRequest struct {
	*tchttp.BaseRequest

	// ID of the invoker to be deleted.
	InvokerId *string `json:"InvokerId,omitempty" name:"InvokerId"`
}

func NewDeleteInvokerRequest 

func NewDeleteInvokerRequest() (request *DeleteInvokerRequest)

func (*DeleteInvokerRequest) FromJsonString 

func (r *DeleteInvokerRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteInvokerRequest) ToJsonString 

func (r *DeleteInvokerRequest) ToJsonString() string

type DeleteInvokerResponse 

type DeleteInvokerResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteInvokerResponse 

func NewDeleteInvokerResponse() (response *DeleteInvokerResponse)

func (*DeleteInvokerResponse) FromJsonString 

func (r *DeleteInvokerResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteInvokerResponse) ToJsonString 

func (r *DeleteInvokerResponse) ToJsonString() string

type DescribeAutomationAgentStatusRequest 

type DescribeAutomationAgentStatusRequest struct {
	*tchttp.BaseRequest

	// List of instance IDs for the query.
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// Filter conditions.<br> <li>`agent-status` - String - Required: No - (Filter condition) Filter by agent status. Valid values: `Online`, `Offline`.<br> <li> `environment` - String - Required: No - (Filter condition) Filter by the agent environment. Valid value: `Linux`.<br> <li> `instance-id` - String - Required: No - (Filter condition) Filter by the instance ID. <br>Up to 10 `Filters` allowed in one request. For each filter, five `Filter.Values` can be specified. `InstanceIds` and `Filters` cannot be specified at the same time.
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`

	// Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeAutomationAgentStatusRequest 

func NewDescribeAutomationAgentStatusRequest() (request *DescribeAutomationAgentStatusRequest)

func (*DescribeAutomationAgentStatusRequest) FromJsonString 

func (r *DescribeAutomationAgentStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAutomationAgentStatusRequest) ToJsonString 

func (r *DescribeAutomationAgentStatusRequest) ToJsonString() string

type DescribeAutomationAgentStatusResponse 

type DescribeAutomationAgentStatusResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Agent information list.
		AutomationAgentSet []*AutomationAgentInfo `json:"AutomationAgentSet,omitempty" name:"AutomationAgentSet"`

		// Total number of matching agents.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeAutomationAgentStatusResponse 

func NewDescribeAutomationAgentStatusResponse() (response *DescribeAutomationAgentStatusResponse)

func (*DescribeAutomationAgentStatusResponse) FromJsonString 

func (r *DescribeAutomationAgentStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAutomationAgentStatusResponse) ToJsonString 

func (r *DescribeAutomationAgentStatusResponse) ToJsonString() string

type DescribeCommandsRequest 

type DescribeCommandsRequest struct {
	*tchttp.BaseRequest

	// List of command IDs. Up to 100 IDs are allowed for each request. `CommandIds` and `Filters` cannot be specified at the same time.
	CommandIds []*string `json:"CommandIds,omitempty" name:"CommandIds"`

	// Filter conditions.
	// <li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID.
	// <li> `command-name` - String - Required: No - (Filter condition) Filter by the command name.
	// <li> `command-type` - String - Required: No - (Filter condition) Filter by the command type. Valid values: `SHELL` or `POWERSHELL`.
	// <li> `created-by` - String - Required: No - (Filter condition) Filter by the creator. Valid values: `TAT` (public commands) or `USER` (custom commands).
	// <li> `tag-key` - String - Required: No - (Filter condition) Filter by the tag key.</li>
	// <li> `tag-value` - String - Required: No - (Filter condition) Filter by the tag value.</li>
	// <li> `tag:tag-key` - String - Required: No - (Filter) Filter by the tag key-value pair. The tag-key should be replaced with a specified tag key. For detailed usage, see sample 4.</li>
	//
	// Up to 10 `Filters` are allowed in one request. Each filter can have up to 5 `Filter.Values`. `CommandIds` and `Filters` cannot be specified at the same time.
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`

	// Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeCommandsRequest 

func NewDescribeCommandsRequest() (request *DescribeCommandsRequest)

func (*DescribeCommandsRequest) FromJsonString 

func (r *DescribeCommandsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCommandsRequest) ToJsonString 

func (r *DescribeCommandsRequest) ToJsonString() string

type DescribeCommandsResponse 

type DescribeCommandsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of matching commands.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// List of command details.
		CommandSet []*Command `json:"CommandSet,omitempty" name:"CommandSet"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeCommandsResponse 

func NewDescribeCommandsResponse() (response *DescribeCommandsResponse)

func (*DescribeCommandsResponse) FromJsonString 

func (r *DescribeCommandsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCommandsResponse) ToJsonString 

func (r *DescribeCommandsResponse) ToJsonString() string

type DescribeInvocationTasksRequest 

type DescribeInvocationTasksRequest struct {
	*tchttp.BaseRequest

	// List of execution task IDs. Up to 100 IDs are allowed for each request. `InvocationTaskIds` and `Filters` cannot be specified at the same time.
	InvocationTaskIds []*string `json:"InvocationTaskIds,omitempty" name:"InvocationTaskIds"`

	// Filter conditions.<br> <li> `invocation-id` - String - Required: No - (Filter condition) Filter by the execution activity ID.<br> <li> `invocation-task-id` - String - Required: No - (Filter condition) Filter by the execution task ID.<br> <li> `instance-id` - String - Required: No - (Filter condition) Filter by the instance ID. <br> <li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID. <br>Up to 10 `Filters` are allowed for each request. Each filter can have up to five `Filter.Values`. `InvocationTaskIds` and `Filters` cannot be specified at the same time.
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`

	// Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Whether to hide the output. Valid values:<br><li>`True` (default): Hide the output <br><li>`False`: Show the output <br>
	HideOutput *bool `json:"HideOutput,omitempty" name:"HideOutput"`
}

func NewDescribeInvocationTasksRequest 

func NewDescribeInvocationTasksRequest() (request *DescribeInvocationTasksRequest)

func (*DescribeInvocationTasksRequest) FromJsonString 

func (r *DescribeInvocationTasksRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvocationTasksRequest) ToJsonString 

func (r *DescribeInvocationTasksRequest) ToJsonString() string

type DescribeInvocationTasksResponse 

type DescribeInvocationTasksResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of matching execution tasks.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// List of execution tasks.
		InvocationTaskSet []*InvocationTask `json:"InvocationTaskSet,omitempty" name:"InvocationTaskSet"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInvocationTasksResponse 

func NewDescribeInvocationTasksResponse() (response *DescribeInvocationTasksResponse)

func (*DescribeInvocationTasksResponse) FromJsonString 

func (r *DescribeInvocationTasksResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvocationTasksResponse) ToJsonString 

func (r *DescribeInvocationTasksResponse) ToJsonString() string

type DescribeInvocationsRequest 

type DescribeInvocationsRequest struct {
	*tchttp.BaseRequest

	// List of execution activity IDs. Up to 100 IDs are allowed for each request. `InvocationIds` and `Filters` cannot be specified at the same time.
	InvocationIds []*string `json:"InvocationIds,omitempty" name:"InvocationIds"`

	// Filter conditions.<br> <li> `invocation-id` - String - Required: No - (Filter condition) Filter by the execution activity ID.<br>
	// <li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID.
	// <li> `command-created-by` - String - Required: No - (Filter condition) Filter by the command type. Valid values: `TAT` (public commands) or `USER` (custom commands).
	// <li> `instance-kind` - String - Required: No - (Filter condition) Filter by the instance type. Valid values: `CVM` or `LIGHTHOUSE`.
	// <br>Up to 10 `Filters` are allowed for each request. Each filter can have up to five `Filter.Values`. `InvocationIds` and `Filters` cannot be specified at the same time.
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`

	// Number of returned results. It defaults to `20`. The maximum is 100. For more information on `Limit`, see the relevant section in the API [Overview](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API [Introduction](https://intl.cloud.tencent.com/document/api/213/15688?from_cn_redirect=1).
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeInvocationsRequest 

func NewDescribeInvocationsRequest() (request *DescribeInvocationsRequest)

func (*DescribeInvocationsRequest) FromJsonString 

func (r *DescribeInvocationsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvocationsRequest) ToJsonString 

func (r *DescribeInvocationsRequest) ToJsonString() string

type DescribeInvocationsResponse 

type DescribeInvocationsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of matching execution activities.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// List of execution activities.
		InvocationSet []*Invocation `json:"InvocationSet,omitempty" name:"InvocationSet"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInvocationsResponse 

func NewDescribeInvocationsResponse() (response *DescribeInvocationsResponse)

func (*DescribeInvocationsResponse) FromJsonString 

func (r *DescribeInvocationsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvocationsResponse) ToJsonString 

func (r *DescribeInvocationsResponse) ToJsonString() string

type DescribeInvokerRecordsRequest 

type DescribeInvokerRecordsRequest struct {
	*tchttp.BaseRequest

	// List of invoker IDs. Up to 100 IDs are allowed.
	InvokerIds []*string `json:"InvokerIds,omitempty" name:"InvokerIds"`

	// Number of returned results. Default value: 20. Maximum value: 100.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. Default value: 0.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeInvokerRecordsRequest 

func NewDescribeInvokerRecordsRequest() (request *DescribeInvokerRecordsRequest)

func (*DescribeInvokerRecordsRequest) FromJsonString 

func (r *DescribeInvokerRecordsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvokerRecordsRequest) ToJsonString 

func (r *DescribeInvokerRecordsRequest) ToJsonString() string

type DescribeInvokerRecordsResponse 

type DescribeInvokerRecordsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Number of matching records.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// Execution history of an invoker.
		InvokerRecordSet []*InvokerRecord `json:"InvokerRecordSet,omitempty" name:"InvokerRecordSet"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInvokerRecordsResponse 

func NewDescribeInvokerRecordsResponse() (response *DescribeInvokerRecordsResponse)

func (*DescribeInvokerRecordsResponse) FromJsonString 

func (r *DescribeInvokerRecordsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvokerRecordsResponse) ToJsonString 

func (r *DescribeInvokerRecordsResponse) ToJsonString() string

type DescribeInvokersRequest 

type DescribeInvokersRequest struct {
	*tchttp.BaseRequest

	// List of invoker IDs.
	InvokerIds []*string `json:"InvokerIds,omitempty" name:"InvokerIds"`

	// Filter conditions:
	//
	// <li> `invoker-id` - String - Required: No - (Filter condition) Filter by the invoker ID.
	// <li> `command-id` - String - Required: No - (Filter condition) Filter by the command ID.
	// <li> `type` - String - Required: No - (Filter condition) Filter by the invoker type.
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`

	// Number of returned results. Default value: 20. Maximum value: 100.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. Default value: 0.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeInvokersRequest 

func NewDescribeInvokersRequest() (request *DescribeInvokersRequest)

func (*DescribeInvokersRequest) FromJsonString 

func (r *DescribeInvokersRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvokersRequest) ToJsonString 

func (r *DescribeInvokersRequest) ToJsonString() string

type DescribeInvokersResponse 

type DescribeInvokersResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Number of matching invokers.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// Invoker information.
		InvokerSet []*Invoker `json:"InvokerSet,omitempty" name:"InvokerSet"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInvokersResponse 

func NewDescribeInvokersResponse() (response *DescribeInvokersResponse)

func (*DescribeInvokersResponse) FromJsonString 

func (r *DescribeInvokersResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInvokersResponse) ToJsonString 

func (r *DescribeInvokersResponse) ToJsonString() string

type DescribeRegionsRequest 

type DescribeRegionsRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeRegionsRequest 

func NewDescribeRegionsRequest() (request *DescribeRegionsRequest)

func (*DescribeRegionsRequest) FromJsonString 

func (r *DescribeRegionsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRegionsRequest) ToJsonString 

func (r *DescribeRegionsRequest) ToJsonString() string

type DescribeRegionsResponse 

type DescribeRegionsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Number of regions
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// Region information list
		RegionSet []*RegionInfo `json:"RegionSet,omitempty" name:"RegionSet"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRegionsResponse 

func NewDescribeRegionsResponse() (response *DescribeRegionsResponse)

func (*DescribeRegionsResponse) FromJsonString 

func (r *DescribeRegionsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRegionsResponse) ToJsonString 

func (r *DescribeRegionsResponse) ToJsonString() string

type DisableInvokerRequest 

type DisableInvokerRequest struct {
	*tchttp.BaseRequest

	// ID of the invoker to be disabled.
	InvokerId *string `json:"InvokerId,omitempty" name:"InvokerId"`
}

func NewDisableInvokerRequest 

func NewDisableInvokerRequest() (request *DisableInvokerRequest)

func (*DisableInvokerRequest) FromJsonString 

func (r *DisableInvokerRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableInvokerRequest) ToJsonString 

func (r *DisableInvokerRequest) ToJsonString() string

type DisableInvokerResponse 

type DisableInvokerResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDisableInvokerResponse 

func NewDisableInvokerResponse() (response *DisableInvokerResponse)

func (*DisableInvokerResponse) FromJsonString 

func (r *DisableInvokerResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableInvokerResponse) ToJsonString 

func (r *DisableInvokerResponse) ToJsonString() string

type EnableInvokerRequest 

type EnableInvokerRequest struct {
	*tchttp.BaseRequest

	// ID of the invoker to be enabled.
	InvokerId *string `json:"InvokerId,omitempty" name:"InvokerId"`
}

func NewEnableInvokerRequest 

func NewEnableInvokerRequest() (request *EnableInvokerRequest)

func (*EnableInvokerRequest) FromJsonString 

func (r *EnableInvokerRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableInvokerRequest) ToJsonString 

func (r *EnableInvokerRequest) ToJsonString() string

type EnableInvokerResponse 

type EnableInvokerResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewEnableInvokerResponse 

func NewEnableInvokerResponse() (response *EnableInvokerResponse)

func (*EnableInvokerResponse) FromJsonString 

func (r *EnableInvokerResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableInvokerResponse) ToJsonString 

func (r *EnableInvokerResponse) ToJsonString() string

type Filter 

type Filter struct {

	// Field to be filtered.
	Name *string `json:"Name,omitempty" name:"Name"`

	// Filter values of the field.
	Values []*string `json:"Values,omitempty" name:"Values"`
}

type Invocation 

type Invocation struct {

	// Execution activity ID.
	InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

	// Command ID.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// Execution task status. Valid values:
	// <li> PENDING: Pending
	// <li> RUNNING: Running
	// <li> SUCCESS: Success
	// <li> FAILED: Failed
	// <li> TIMEOUT: Command timed out
	// <li> PARTIAL_FAILED: Partial failure
	InvocationStatus *string `json:"InvocationStatus,omitempty" name:"InvocationStatus"`

	// Execution task information list.
	InvocationTaskBasicInfoSet []*InvocationTaskBasicInfo `json:"InvocationTaskBasicInfoSet,omitempty" name:"InvocationTaskBasicInfoSet"`

	// Execution activity description.
	Description *string `json:"Description,omitempty" name:"Description"`

	// Start time of the execution activity.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// End time of the execution activity.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Time when the execution activity is created.
	CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`

	// Time when the execution activity is updated.
	UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`

	// Values of custom parameters.
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// Default custom parameter value.
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`

	// Type of the instance executing the command. Valid values: `CVM`, `LIGHTHOUSE`.
	InstanceKind *string `json:"InstanceKind,omitempty" name:"InstanceKind"`

	// The user who executes the command on the instance.
	Username *string `json:"Username,omitempty" name:"Username"`

	// Invocation source.
	InvocationSource *string `json:"InvocationSource,omitempty" name:"InvocationSource"`

	// Base64-encoded command
	CommandContent *string `json:"CommandContent,omitempty" name:"CommandContent"`

	// Command type
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// Command timeout period, in seconds.
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// Working directory for executing the command.
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// The COS bucket URL for uploading logs.
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitempty" name:"OutputCOSBucketUrl"`

	// The COS bucket directory where the logs are saved.
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitempty" name:"OutputCOSKeyPrefix"`
}

type InvocationTask 

type InvocationTask struct {

	// Execution activity ID.
	InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

	// Execution task ID.
	InvocationTaskId *string `json:"InvocationTaskId,omitempty" name:"InvocationTaskId"`

	// Command ID.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// Execution task status. Valid values:
	// <li> PENDING: Pending
	// <li> DELIVERING: Delivering
	// <li> DELIVER_DELAYED: Delivery delayed
	// <li> DELIVER_FAILED: Delivery failed
	// <li> START_FAILED: Failed to start the command
	// <li> RUNNING: Running
	// <li> SUCCESS: Success
	// <li> FAILED: Failed to execute the command. The exit code is not 0 after execution.
	// <li> TIMEOUT: Command timed out
	// <li> TASK_TIMEOUT: Task timed out
	// <li> CANCELLING: Canceling
	// <li> CANCELLED: Canceled (canceled before execution)
	// <li> TERMINATED: Terminated (canceled during execution)
	TaskStatus *string `json:"TaskStatus,omitempty" name:"TaskStatus"`

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Execution result.
	TaskResult *TaskResult `json:"TaskResult,omitempty" name:"TaskResult"`

	// Start time of the execution task.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// End time of the execution task.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Creation time.
	CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`

	// Update time.
	UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`

	// Command details of the execution task.
	CommandDocument *CommandDocument `json:"CommandDocument,omitempty" name:"CommandDocument"`

	// Error message displayed when the execution task fails.
	ErrorInfo *string `json:"ErrorInfo,omitempty" name:"ErrorInfo"`

	// Invocation source.
	InvocationSource *string `json:"InvocationSource,omitempty" name:"InvocationSource"`
}

type InvocationTaskBasicInfo 

type InvocationTaskBasicInfo struct {

	// Execution task ID.
	InvocationTaskId *string `json:"InvocationTaskId,omitempty" name:"InvocationTaskId"`

	// Execution task status. Valid values:
	// <li> PENDING: Pending
	// <li> DELIVERING: Delivering
	// <li> DELIVER_DELAYED: Delivery delayed
	// <li> DELIVER_FAILED: Delivery failed
	// <li> START_FAILED: Failed to start the command
	// <li> RUNNING: Running
	// <li> SUCCESS: Success
	// <li> FAILED: Failed to execute the command. The exit code is not 0 after execution.
	// <li> TIMEOUT: Command timed out
	// <li> TASK_TIMEOUT: Task timed out
	// <li> CANCELLING: Canceling
	// <li> CANCELLED: Canceled (canceled before execution)
	// <li> TERMINATED: Terminated (canceled during execution)
	TaskStatus *string `json:"TaskStatus,omitempty" name:"TaskStatus"`

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

type InvokeCommandRequest 

type InvokeCommandRequest struct {
	*tchttp.BaseRequest

	// ID of the command to be triggered.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// IDs of instances about to execute commands. At most 100 IDs are allowed.
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// Custom parameters of the command. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
	// `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
	// If no parameter value is provided, the DefaultParameters of the command is used.
	// Up to 20 custom parameters are supported.
	// The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// The username used to execute the command on the CVM or Lighthouse instance.
	// The principle of the least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. If this is not specified, the Username of the command is used by default.
	Username *string `json:"Username,omitempty" name:"Username"`

	// Execution path of the command. The WorkingDirectory of the command is used by default.
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// Command timeout period. Value range: [1, 86400]. The Timeout of the command is used by default.
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitempty" name:"OutputCOSBucketUrl"`

	// The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
	// 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
	// 2. Use a slash (/) to create a subdirectory.
	// 3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewInvokeCommandRequest 

func NewInvokeCommandRequest() (request *InvokeCommandRequest)

func (*InvokeCommandRequest) FromJsonString 

func (r *InvokeCommandRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*InvokeCommandRequest) ToJsonString 

func (r *InvokeCommandRequest) ToJsonString() string

type InvokeCommandResponse 

type InvokeCommandResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Execution activity ID.
		InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewInvokeCommandResponse 

func NewInvokeCommandResponse() (response *InvokeCommandResponse)

func (*InvokeCommandResponse) FromJsonString 

func (r *InvokeCommandResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*InvokeCommandResponse) ToJsonString 

func (r *InvokeCommandResponse) ToJsonString() string

type Invoker 

type Invoker struct {

	// Invoker ID.
	InvokerId *string `json:"InvokerId,omitempty" name:"InvokerId"`

	// Invoker name.
	Name *string `json:"Name,omitempty" name:"Name"`

	// Invoker type.
	Type *string `json:"Type,omitempty" name:"Type"`

	// Command ID.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// Username.
	Username *string `json:"Username,omitempty" name:"Username"`

	// Custom parameters.
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// Instance ID list.
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// Whether to enable the invoker.
	Enable *bool `json:"Enable,omitempty" name:"Enable"`

	// Execution schedule of the invoker. This field is returned for recurring invokers.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitempty" name:"ScheduleSettings"`

	// Creation time.
	CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`

	// Modification time.
	UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`
}

type InvokerRecord 

type InvokerRecord struct {

	// Invoker ID.
	InvokerId *string `json:"InvokerId,omitempty" name:"InvokerId"`

	// Execution time.
	InvokeTime *string `json:"InvokeTime,omitempty" name:"InvokeTime"`

	// Execution reason.
	Reason *string `json:"Reason,omitempty" name:"Reason"`

	// Command execution ID.
	InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

	// Trigger result.
	Result *string `json:"Result,omitempty" name:"Result"`
}

type ModifyCommandRequest 

type ModifyCommandRequest struct {
	*tchttp.BaseRequest

	// Command ID.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// Command description. The maximum length is 120 characters.
	Description *string `json:"Description,omitempty" name:"Description"`

	// Base64-encoded command. The maximum length is 64 KB.
	Content *string `json:"Content,omitempty" name:"Content"`

	// Command type. `SHELL` and `POWERSHELL` are supported.
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// Command execution path.
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// Command timeout period. Value range: [1, 86400].
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
	// All parameters are overwritten. All default values are required for modification.
	// Modification is only allowed when `EnableParameter` is `true`.
	// `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
	// Up to 20 custom parameters are supported.
	// The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`

	// The username used to execute the command on the CVM or Lighthouse instance.
	// The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user.
	Username *string `json:"Username,omitempty" name:"Username"`

	// The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitempty" name:"OutputCOSBucketUrl"`

	// The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
	// 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
	// 2. Use a slash (/) to create a subdirectory.
	// 3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewModifyCommandRequest 

func NewModifyCommandRequest() (request *ModifyCommandRequest)

func (*ModifyCommandRequest) FromJsonString 

func (r *ModifyCommandRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyCommandRequest) ToJsonString 

func (r *ModifyCommandRequest) ToJsonString() string

type ModifyCommandResponse 

type ModifyCommandResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyCommandResponse 

func NewModifyCommandResponse() (response *ModifyCommandResponse)

func (*ModifyCommandResponse) FromJsonString 

func (r *ModifyCommandResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyCommandResponse) ToJsonString 

func (r *ModifyCommandResponse) ToJsonString() string

type ModifyInvokerRequest 

type ModifyInvokerRequest struct {
	*tchttp.BaseRequest

	// ID of the invoker to be modified.
	InvokerId *string `json:"InvokerId,omitempty" name:"InvokerId"`

	// Name of the invoker to be modified.
	Name *string `json:"Name,omitempty" name:"Name"`

	// Invoker type. It can only be `SCHEDULE` (recurring invokers).
	Type *string `json:"Type,omitempty" name:"Type"`

	// ID of the command to be modified.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// The username to be modified.
	Username *string `json:"Username,omitempty" name:"Username"`

	// Custom parameters to be modified.
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// List of instance IDs to be modified. Up to 100 IDs are allowed.
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// Scheduled invoker settings to be modified.
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitempty" name:"ScheduleSettings"`
}

func NewModifyInvokerRequest 

func NewModifyInvokerRequest() (request *ModifyInvokerRequest)

func (*ModifyInvokerRequest) FromJsonString 

func (r *ModifyInvokerRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInvokerRequest) ToJsonString 

func (r *ModifyInvokerRequest) ToJsonString() string

type ModifyInvokerResponse 

type ModifyInvokerResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyInvokerResponse 

func NewModifyInvokerResponse() (response *ModifyInvokerResponse)

func (*ModifyInvokerResponse) FromJsonString 

func (r *ModifyInvokerResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInvokerResponse) ToJsonString 

func (r *ModifyInvokerResponse) ToJsonString() string

type PreviewReplacedCommandContentRequest 

type PreviewReplacedCommandContentRequest struct {
	*tchttp.BaseRequest

	// Custom parameters for the preview. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
	// `key` is the name of the custom parameter and "value" is its specified value. Both "key" and "value" are strings.
	// At most 20 custom parameters are supported.
	// The name of the custom parameter cannot exceed 64 characters and can only contain [a-z], [A-Z], [0-9], [-_].
	// This parameter can be left empty if DefaultParameters is set for the previewed CommandId.
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// The command to be previewed. If DefaultParameters is set, it is combined with Parameters and Parameters takes priority.
	// `CommandId` or `Content` must be specified.
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// Base64-encoded command to be previewed. The maximum length is 64 KB.
	// CommandId or Content must be specified.
	Content *string `json:"Content,omitempty" name:"Content"`
}

func NewPreviewReplacedCommandContentRequest 

func NewPreviewReplacedCommandContentRequest() (request *PreviewReplacedCommandContentRequest)

func (*PreviewReplacedCommandContentRequest) FromJsonString 

func (r *PreviewReplacedCommandContentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PreviewReplacedCommandContentRequest) ToJsonString 

func (r *PreviewReplacedCommandContentRequest) ToJsonString() string

type PreviewReplacedCommandContentResponse 

type PreviewReplacedCommandContentResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Base64-encoded command with custom parameters.
		ReplacedContent *string `json:"ReplacedContent,omitempty" name:"ReplacedContent"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewPreviewReplacedCommandContentResponse 

func NewPreviewReplacedCommandContentResponse() (response *PreviewReplacedCommandContentResponse)

func (*PreviewReplacedCommandContentResponse) FromJsonString 

func (r *PreviewReplacedCommandContentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PreviewReplacedCommandContentResponse) ToJsonString 

func (r *PreviewReplacedCommandContentResponse) ToJsonString() string

type RegionInfo 

type RegionInfo struct {

	// Region name, such as `ap-guangzhou`
	Region *string `json:"Region,omitempty" name:"Region"`

	// Region description, such as `Guangzhou`
	RegionName *string `json:"RegionName,omitempty" name:"RegionName"`

	// Region status. `AVAILABLE` indicates the region is available.
	RegionState *string `json:"RegionState,omitempty" name:"RegionState"`
}

type RunCommandRequest 

type RunCommandRequest struct {
	*tchttp.BaseRequest

	// Base64-encoded command. The maximum length is 64 KB.
	Content *string `json:"Content,omitempty" name:"Content"`

	// IDs of instances about to execute commands. Up to 100 IDs are allowed. Supported instance types:
	// <li> `CVM`
	// <li> `LIGHTHOUSE`
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// Command description. The maximum length is 120 characters.
	Description *string `json:"Description,omitempty" name:"Description"`

	// Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// Whether to save the command. Valid values:
	// <li> `True`: Save
	// <li> `False`: Do not save
	// The default value is `False`.
	SaveCommand *bool `json:"SaveCommand,omitempty" name:"SaveCommand"`

	// Whether to enable the custom parameter feature.
	// This cannot be modified once created.
	// Default value: `false`.
	EnableParameter *bool `json:"EnableParameter,omitempty" name:"EnableParameter"`

	// The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
	// `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
	// If Parameters is not provided, the default values specified here are used.
	// Up to 20 custom parameters are supported.
	// The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`

	// Custom parameters of `Command`. The field type is JSON encoded string. For example, {\"varA\": \"222\"}.
	// `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings.
	// If no parameter value is provided, the `DefaultParameters` is used.
	// Up to 20 custom parameters are supported.
	// The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// The tags of the command. It is available when `SaveCommand` is `True`. A maximum of 10 tags are allowed.
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`

	// The username used to execute the command on the CVM or Lighthouse instance.
	// The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the user `root` is used to execute commands on Linux and the user `System` is used on Windows.
	Username *string `json:"Username,omitempty" name:"Username"`

	// The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitempty" name:"OutputCOSBucketUrl"`

	// The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
	// 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
	// 2. Use a slash (/) to create a subdirectory.
	// 3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewRunCommandRequest 

func NewRunCommandRequest() (request *RunCommandRequest)

func (*RunCommandRequest) FromJsonString 

func (r *RunCommandRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RunCommandRequest) ToJsonString 

func (r *RunCommandRequest) ToJsonString() string

type RunCommandResponse 

type RunCommandResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Command ID.
		CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

		// Execution activity ID.
		InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewRunCommandResponse 

func NewRunCommandResponse() (response *RunCommandResponse)

func (*RunCommandResponse) FromJsonString 

func (r *RunCommandResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RunCommandResponse) ToJsonString 

func (r *RunCommandResponse) ToJsonString() string

type ScheduleSettings 

type ScheduleSettings struct {

	// Execution policy:
	// <br><li>`ONCE`: Execute once
	// <br><li>`RECURRENCE`: Execute repeatedly
	Policy *string `json:"Policy,omitempty" name:"Policy"`

	// Trigger the crontab expression. This field is required if `Policy` is `RECURRENCE`. The crontab expression is parsed in UTC+8.
	Recurrence *string `json:"Recurrence,omitempty" name:"Recurrence"`

	// The next execution time of the invoker. This field is required if `Policy` is `ONCE`.
	InvokeTime *string `json:"InvokeTime,omitempty" name:"InvokeTime"`
}

type Tag 

type Tag struct {

	// Tag key.
	Key *string `json:"Key,omitempty" name:"Key"`

	// Tag value.
	Value *string `json:"Value,omitempty" name:"Value"`
}

type TaskResult 

type TaskResult struct {

	// ExitCode of the execution.
	ExitCode *int64 `json:"ExitCode,omitempty" name:"ExitCode"`

	// Base64-encoded command output. The maximum length is 24 KB.
	Output *string `json:"Output,omitempty" name:"Output"`

	// Time when the execution is started.
	ExecStartTime *string `json:"ExecStartTime,omitempty" name:"ExecStartTime"`

	// Time when the execution is ended.
	ExecEndTime *string `json:"ExecEndTime,omitempty" name:"ExecEndTime"`

	// Dropped bytes of the command output.
	Dropped *uint64 `json:"Dropped,omitempty" name:"Dropped"`

	// COS URL of the logs.
	OutputUrl *string `json:"OutputUrl,omitempty" name:"OutputUrl"`

	// Error message for uploading logs to COS.
	OutputUploadCOSErrorInfo *string `json:"OutputUploadCOSErrorInfo,omitempty" name:"OutputUploadCOSErrorInfo"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.