v20201028

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"`

	// Features supported by the TAT agent.
	SupportFeatures []*string `json:"SupportFeatures,omitempty" name:"SupportFeatures"`
}

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"`
}

type CancelInvocationRequestParams struct {
	// 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"`
}

type CancelInvocationResponse struct {
	*tchttp.BaseResponse
	Response *CancelInvocationResponseParams `json:"Response"`
}

type CancelInvocationResponseParams 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"`
}

type Client struct {
	common.Client
}

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 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"`

	// URL of the COS bucket to store the output
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitempty" name:"OutputCOSBucketUrl"`

	// Prefix of the output file name
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitempty" name:"OutputCOSKeyPrefix"`
}

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"`
}

type CreateCommandRequestParams struct {
	// 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"`
}

type CreateCommandResponse struct {
	*tchttp.BaseResponse
	Response *CreateCommandResponseParams `json:"Response"`
}

type CreateCommandResponseParams 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"`
}

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"`
}

type CreateInvokerRequestParams struct {
	// 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"`
}

type CreateInvokerResponse struct {
	*tchttp.BaseResponse
	Response *CreateInvokerResponseParams `json:"Response"`
}

type CreateInvokerResponseParams 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"`
}

type DeleteCommandRequest struct {
	*tchttp.BaseRequest

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

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

type DeleteCommandResponse struct {
	*tchttp.BaseResponse
	Response *DeleteCommandResponseParams `json:"Response"`
}

type DeleteCommandResponseParams 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"`
}

type DeleteInvokerRequest struct {
	*tchttp.BaseRequest

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

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

type DeleteInvokerResponse struct {
	*tchttp.BaseResponse
	Response *DeleteInvokerResponseParams `json:"Response"`
}

type DeleteInvokerResponseParams 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"`
}

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"`
}

type DescribeAutomationAgentStatusRequestParams struct {
	// 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"`
}

type DescribeAutomationAgentStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAutomationAgentStatusResponseParams `json:"Response"`
}

type DescribeAutomationAgentStatusResponseParams 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"`
}

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"`
}

type DescribeCommandsRequestParams struct {
	// 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"`
}

type DescribeCommandsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCommandsResponseParams `json:"Response"`
}

type DescribeCommandsResponseParams 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"`
}

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"`
}

type DescribeInvocationTasksRequestParams struct {
	// 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"`
}

type DescribeInvocationTasksResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInvocationTasksResponseParams `json:"Response"`
}

type DescribeInvocationTasksResponseParams 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"`
}

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"`
}

type DescribeInvocationsRequestParams struct {
	// 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"`
}

type DescribeInvocationsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInvocationsResponseParams `json:"Response"`
}

type DescribeInvocationsResponseParams 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"`
}

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"`
}

type DescribeInvokerRecordsRequestParams struct {
	// 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"`
}

type DescribeInvokerRecordsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInvokerRecordsResponseParams `json:"Response"`
}

type DescribeInvokerRecordsResponseParams 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"`
}

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"`
}

type DescribeInvokersRequestParams struct {
	// 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"`
}

type DescribeInvokersResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInvokersResponseParams `json:"Response"`
}

type DescribeInvokersResponseParams 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"`
}

type DescribeRegionsRequest struct {
	*tchttp.BaseRequest
}

type DescribeRegionsRequestParams struct {
}

type DescribeRegionsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRegionsResponseParams `json:"Response"`
}

type DescribeRegionsResponseParams 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"`
}

type DisableInvokerRequest struct {
	*tchttp.BaseRequest

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

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

type DisableInvokerResponse struct {
	*tchttp.BaseResponse
	Response *DisableInvokerResponseParams `json:"Response"`
}

type DisableInvokerResponseParams 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"`
}

type EnableInvokerRequest struct {
	*tchttp.BaseRequest

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

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

type EnableInvokerResponse struct {
	*tchttp.BaseResponse
	Response *EnableInvokerResponseParams `json:"Response"`
}

type EnableInvokerResponseParams 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"`
}

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 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 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 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 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"`
}

type InvokeCommandRequestParams struct {
	// 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"`
}

type InvokeCommandResponse struct {
	*tchttp.BaseResponse
	Response *InvokeCommandResponseParams `json:"Response"`
}

type InvokeCommandResponseParams 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"`
}

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 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 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"`
}

type ModifyCommandRequestParams struct {
	// 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"`
}

type ModifyCommandResponse struct {
	*tchttp.BaseResponse
	Response *ModifyCommandResponseParams `json:"Response"`
}

type ModifyCommandResponseParams 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"`
}

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"`
}

type ModifyInvokerRequestParams struct {
	// 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"`
}

type ModifyInvokerResponse struct {
	*tchttp.BaseResponse
	Response *ModifyInvokerResponseParams `json:"Response"`
}

type ModifyInvokerResponseParams 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"`
}

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"`
}

type PreviewReplacedCommandContentRequestParams struct {
	// 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"`
}

type PreviewReplacedCommandContentResponse struct {
	*tchttp.BaseResponse
	Response *PreviewReplacedCommandContentResponseParams `json:"Response"`
}

type PreviewReplacedCommandContentResponseParams 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"`
}

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 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"`
}

type RunCommandRequestParams struct {
	// 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"`
}

type RunCommandResponse struct {
	*tchttp.BaseResponse
	Response *RunCommandResponseParams `json:"Response"`
}

type RunCommandResponseParams 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"`
}

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 struct {
	// Tag key.
	Key *string `json:"Key,omitempty" name:"Key"`

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

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"`
}