v20201028

package
v1.2.0 Latest Latest
Warning

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

Go to latest
Published: Apr 29, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const APIVersion = "2020-10-28"

Variables

This section is empty.

Functions

This section is empty.

Types

type AutomationAgentInfo

type AutomationAgentInfo struct {

	// 实例ID。
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Agent 版本号。
	Version *string `json:"Version,omitempty" name:"Version"`

	// 上次心跳时间
	LastHeartbeatTime *string `json:"LastHeartbeatTime,omitempty" name:"LastHeartbeatTime"`

	// Agent状态,取值范围:
	// <li> Online:在线
	// <li> Offline:离线
	AgentStatus *string `json:"AgentStatus,omitempty" name:"AgentStatus"`

	// Agent运行环境
	Environment *string `json:"Environment,omitempty" name:"Environment"`
}

type Client

type Client struct {
	common.Client
}

func NewClient

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

func NewClientWithSecretId

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

Deprecated

func (*Client) CreateCommand

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

此接口用于创建命令。

func (*Client) DeleteCommand

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

此接口用于删除命令。

func (*Client) DescribeAutomationAgentStatus

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

此接口用于查询自动化助手客户端的状态。

func (*Client) DescribeCommands

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

此接口用于查询命令详情。

func (*Client) DescribeInvocationTasks

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

此接口用于查询执行任务详情。

func (*Client) DescribeInvocations

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

此接口用于查询执行活动详情。

func (*Client) DescribeRegions

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

此接口用于查询地域列表

func (*Client) InvokeCommand

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

在指定的实例上触发命令,调用成功返回执行活动ID(inv-xxxxxxxx),每个执行活动内部有一个或多个执行任务(invt-xxxxxxxx),每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。

* 如果指定实例未安装 agent,或 agent 不在线,返回失败 * 如果命令类型与 agent 运行环境不符,返回失败 * 指定的实例需要处于 VPC 网络 * 指定的实例需要处于 RUNNING 状态 * 不可同时指定 CVM 和 Lighthouse

func (*Client) ModifyCommand

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

此接口用于修改命令。

func (*Client) PreviewReplacedCommandContent

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

此接口用于预览自定义参数替换后的命令内容。不会触发真实执行。

func (*Client) RunCommand

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

执行命令,调用成功返回执行活动ID(inv-xxxxxxxx),每个执行活动内部有一个或多个执行任务(invt-xxxxxxxx),每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。

* 如果指定实例未安装 agent,或 agent 不在线,返回失败 * 如果命令类型与 agent 运行环境不符,返回失败 * 指定的实例需要处于 VPC 网络 * 指定的实例需要处于 `RUNNING` 状态 * 不可同时指定 CVM 和 Lighthouse

type Command

type Command struct {

	// 命令ID。
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// 命令名称。
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// 命令描述。
	Description *string `json:"Description,omitempty" name:"Description"`

	// Base64编码后的命令内容。
	Content *string `json:"Content,omitempty" name:"Content"`

	// 命令类型。
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// 命令执行路径。
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// 命令超时时间。
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// 命令创建时间。
	CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`

	// 命令更新时间。
	UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`

	// 是否启用自定义参数功能。
	EnableParameter *bool `json:"EnableParameter,omitempty" name:"EnableParameter"`

	// 自定义参数的默认取值。
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`

	// 命令的结构化描述。公共命令有值,用户命令为空字符串。
	FormattedDescription *string `json:"FormattedDescription,omitempty" name:"FormattedDescription"`

	// 命令创建者。TAT 代表公共命令,USER 代表个人命令。
	CreatedBy *string `json:"CreatedBy,omitempty" name:"CreatedBy"`
}

type CommandDocument

type CommandDocument struct {

	// Base64 编码后的执行命令。
	Content *string `json:"Content,omitempty" name:"Content"`

	// 命令类型。
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// 超时时间。
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// 执行路径。
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`
}

type CreateCommandRequest

type CreateCommandRequest struct {
	*tchttp.BaseRequest

	// 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// Base64编码后的命令内容,长度不可超过64KB。
	Content *string `json:"Content,omitempty" name:"Content"`

	// 命令描述。不超过120字符。
	Description *string `json:"Description,omitempty" name:"Description"`

	// 命令类型,目前仅支持取值:SHELL。默认:SHELL。
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// 命令执行路径,默认:/root。
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// 命令超时时间,默认60秒。取值范围[1, 86400]。
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// 是否启用自定义参数功能。
	// 一旦创建,此值不提供修改。
	// 默认值:false。
	EnableParameter *bool `json:"EnableParameter,omitempty" name:"EnableParameter"`

	// 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{\"varA\": \"222\"}。
	// key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
	// 如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
	// 自定义参数最多20个。
	// 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`
}

func NewCreateCommandRequest

func NewCreateCommandRequest() (request *CreateCommandRequest)

func (*CreateCommandRequest) FromJsonString

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

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 {

		// 命令ID。
		CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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 DeleteCommandRequest

type DeleteCommandRequest struct {
	*tchttp.BaseRequest

	// 待删除的命令ID。
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`
}

func NewDeleteCommandRequest

func NewDeleteCommandRequest() (request *DeleteCommandRequest)

func (*DeleteCommandRequest) FromJsonString

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

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 {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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 DescribeAutomationAgentStatusRequest

type DescribeAutomationAgentStatusRequest struct {
	*tchttp.BaseRequest

	// 待查询的实例ID列表。
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds" list`

	// 过滤条件。<br> <li> agent-status - String - 是否必填:否 -(过滤条件)按照agent状态过滤,取值:Online 在线,Offline 离线。<br> <li> environment - String - 是否必填:否 -(过滤条件)按照agent运行环境查询,取值:Linux。<br> <li> instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。 <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InstanceIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`

	// 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeAutomationAgentStatusRequest

func NewDescribeAutomationAgentStatusRequest() (request *DescribeAutomationAgentStatusRequest)

func (*DescribeAutomationAgentStatusRequest) FromJsonString

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

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 信息列表。
		AutomationAgentSet []*AutomationAgentInfo `json:"AutomationAgentSet,omitempty" name:"AutomationAgentSet" list`

		// 符合条件的 Agent 总数。
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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

func (*DescribeAutomationAgentStatusResponse) ToJsonString

type DescribeCommandsRequest

type DescribeCommandsRequest struct {
	*tchttp.BaseRequest

	// 命令ID列表,每次请求的上限为100。参数不支持同时指定 `CommandIds` 和 `Filters` 。
	CommandIds []*string `json:"CommandIds,omitempty" name:"CommandIds" list`

	// 过滤条件。<br> <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。<br> <li> command-name - String - 是否必填:否 -(过滤条件)按照命令名称过滤。<br> <li> created-by - String - 是否必填:否 -(过滤条件)按照命令创建者过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。 <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `CommandIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`

	// 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeCommandsRequest

func NewDescribeCommandsRequest() (request *DescribeCommandsRequest)

func (*DescribeCommandsRequest) FromJsonString

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

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 {

		// 符合条件的命令总数。
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 命令详情列表。
		CommandSet []*Command `json:"CommandSet,omitempty" name:"CommandSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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

	// 执行任务ID列表,每次请求的上限为100。参数不支持同时指定 `InvocationTaskIds` 和 `Filters`。
	InvocationTaskIds []*string `json:"InvocationTaskIds,omitempty" name:"InvocationTaskIds" list`

	// 过滤条件。<br> <li> invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。<br> <li> invocation-task-id - String - 是否必填:否 -(过滤条件)按照执行任务ID过滤。<br> <li> instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。 <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationTaskIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`

	// 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// 是否隐藏输出,取值范围:<br><li>True:隐藏输出 <br><li>False:不隐藏 <br>默认为 True。
	HideOutput *bool `json:"HideOutput,omitempty" name:"HideOutput"`
}

func NewDescribeInvocationTasksRequest

func NewDescribeInvocationTasksRequest() (request *DescribeInvocationTasksRequest)

func (*DescribeInvocationTasksRequest) FromJsonString

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

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 {

		// 符合条件的执行任务总数。
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 执行任务列表。
		InvocationTaskSet []*InvocationTask `json:"InvocationTaskSet,omitempty" name:"InvocationTaskSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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

	// 执行活动ID列表,每次请求的上限为100。参数不支持同时指定 `InvocationIds` 和 `Filters`。
	InvocationIds []*string `json:"InvocationIds,omitempty" name:"InvocationIds" list`

	// 过滤条件。<br> <li> invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。<br> <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。 <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`

	// 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeInvocationsRequest

func NewDescribeInvocationsRequest() (request *DescribeInvocationsRequest)

func (*DescribeInvocationsRequest) FromJsonString

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

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 {

		// 符合条件的执行活动总数。
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 执行活动列表。
		InvocationSet []*Invocation `json:"InvocationSet,omitempty" name:"InvocationSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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 DescribeRegionsRequest

type DescribeRegionsRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeRegionsRequest

func NewDescribeRegionsRequest() (request *DescribeRegionsRequest)

func (*DescribeRegionsRequest) FromJsonString

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

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 {

		// 地域数量
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 地域信息列表
		RegionSet []*RegionInfo `json:"RegionSet,omitempty" name:"RegionSet" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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 Filter

type Filter struct {

	// 需要过滤的字段。
	Name *string `json:"Name,omitempty" name:"Name"`

	// 字段的过滤值。
	Values []*string `json:"Values,omitempty" name:"Values" list`
}

type Invocation

type Invocation struct {

	// 执行活动ID。
	InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

	// 命令ID。
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// 执行任务状态。取值范围:
	// <li> PENDING:等待下发
	// <li> RUNNING:命令运行中
	// <li> SUCCESS:命令成功
	// <li> FAILED:命令失败
	// <li> TIMEOUT:命令超时
	// <li> PARTIAL_FAILED:命令部分失败
	InvocationStatus *string `json:"InvocationStatus,omitempty" name:"InvocationStatus"`

	// 执行任务信息列表。
	InvocationTaskBasicInfoSet []*InvocationTaskBasicInfo `json:"InvocationTaskBasicInfoSet,omitempty" name:"InvocationTaskBasicInfoSet" list`

	// 执行活动描述。
	Description *string `json:"Description,omitempty" name:"Description"`

	// 执行活动开始时间。
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// 执行活动结束时间。
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// 执行活动创建时间。
	CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`

	// 执行活动更新时间。
	UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`

	// 自定义参数取值。
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// 自定义参数的默认取值。
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`
}

type InvocationTask

type InvocationTask struct {

	// 执行活动ID。
	InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

	// 执行任务ID。
	InvocationTaskId *string `json:"InvocationTaskId,omitempty" name:"InvocationTaskId"`

	// 命令ID。
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// 执行任务状态。取值范围:
	// <li> PENDING:等待下发
	// <li> DELIVERING:下发中
	// <li> DELIVER_DELAYED:延时下发
	// <li> DELIVER_FAILED:下发失败
	// <li> RUNNING:命令运行中
	// <li> SUCCESS:命令成功
	// <li> FAILED:命令失败
	// <li> TIMEOUT:命令超时
	// <li> TASK_TIMEOUT:执行任务超时
	TaskStatus *string `json:"TaskStatus,omitempty" name:"TaskStatus"`

	// 实例ID。
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 执行结果。
	TaskResult *TaskResult `json:"TaskResult,omitempty" name:"TaskResult"`

	// 执行任务开始时间。
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// 执行任务结束时间。
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// 创建时间。
	CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`

	// 更新时间。
	UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`

	// 执行任务所执行的命令详情。
	CommandDocument *CommandDocument `json:"CommandDocument,omitempty" name:"CommandDocument"`
}

type InvocationTaskBasicInfo

type InvocationTaskBasicInfo struct {

	// 执行任务ID。
	InvocationTaskId *string `json:"InvocationTaskId,omitempty" name:"InvocationTaskId"`

	// 执行任务状态。取值范围:
	// <li> PENDING:等待下发
	// <li> DELIVERING:下发中
	// <li> DELIVER_DELAYED:延时下发
	// <li> DELIVER_FAILED:下发失败
	// <li> RUNNING:命令运行中
	// <li> SUCCESS:命令成功
	// <li> FAILED:命令失败
	// <li> TIMEOUT:命令超时
	// <li> TASK_TIMEOUT:执行任务超时
	TaskStatus *string `json:"TaskStatus,omitempty" name:"TaskStatus"`

	// 实例ID。
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

type InvokeCommandRequest

type InvokeCommandRequest struct {
	*tchttp.BaseRequest

	// 待触发的命令ID。
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// 待执行命令的实例ID列表。
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds" list`

	// Command 的自定义参数。字段类型为json encoded string。如:{\"varA\": \"222\"}。
	// key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
	// 如果未提供该参数取值,将使用 Command 的 DefaultParameters 进行替换。
	// 自定义参数最多20个。
	// 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`
}

func NewInvokeCommandRequest

func NewInvokeCommandRequest() (request *InvokeCommandRequest)

func (*InvokeCommandRequest) FromJsonString

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

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 {

		// 执行活动ID。
		InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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 ModifyCommandRequest

type ModifyCommandRequest struct {
	*tchttp.BaseRequest

	// 命令ID。
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// 命令描述。不超过120字符。
	Description *string `json:"Description,omitempty" name:"Description"`

	// Base64编码后的命令内容,长度不可超过64KB。
	Content *string `json:"Content,omitempty" name:"Content"`

	// 命令类型,目前仅支持取值:SHELL。
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// 命令执行路径,默认:`/root`。
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// 命令超时时间,默认60秒。取值范围[1, 86400]。
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{\"varA\": \"222\"}。
	// 采取整体全覆盖式修改,即修改时必须提供所有新默认值。
	// 必须 Command 的 EnableParameter 为 true 时,才允许修改这个值。
	// key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
	// 自定义参数最多20个。
	// 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`
}

func NewModifyCommandRequest

func NewModifyCommandRequest() (request *ModifyCommandRequest)

func (*ModifyCommandRequest) FromJsonString

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

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 {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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 PreviewReplacedCommandContentRequest

type PreviewReplacedCommandContentRequest struct {
	*tchttp.BaseRequest

	// 本次预览采用的自定义参数。字段类型为 json encoded string,如:{\"varA\": \"222\"}。
	// key 为自定义参数名称,value 为该参数的取值。kv 均为字符串型。
	// 自定义参数最多 20 个。
	// 自定义参数名称需符合以下规范:字符数目上限 64,可选范围【a-zA-Z0-9-_】。
	// 如果将预览的 CommandId 设置过 DefaultParameters,本参数可以为空。
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`

	// 要进行替换预览的命令,如果有设置过 DefaultParameters,会与 Parameters 进行叠加,后者覆盖前者。
	// CommandId 与 Content,必须且只能提供一个。
	CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

	// 要预览的命令内容,经 Base64 编码,长度不可超过 64KB。
	// CommandId 与 Content,必须且只能提供一个。
	Content *string `json:"Content,omitempty" name:"Content"`
}

func NewPreviewReplacedCommandContentRequest

func NewPreviewReplacedCommandContentRequest() (request *PreviewReplacedCommandContentRequest)

func (*PreviewReplacedCommandContentRequest) FromJsonString

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

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编码的命令内容。
		ReplacedContent *string `json:"ReplacedContent,omitempty" name:"ReplacedContent"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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

func (*PreviewReplacedCommandContentResponse) ToJsonString

type RegionInfo

type RegionInfo struct {

	// 地域名称,例如,ap-guangzhou
	Region *string `json:"Region,omitempty" name:"Region"`

	// 地域描述,例如: 广州
	RegionName *string `json:"RegionName,omitempty" name:"RegionName"`

	// 地域是否可用状态
	RegionState *string `json:"RegionState,omitempty" name:"RegionState"`
}

type RunCommandRequest

type RunCommandRequest struct {
	*tchttp.BaseRequest

	// Base64编码后的命令内容,长度不可超过64KB。
	Content *string `json:"Content,omitempty" name:"Content"`

	// 待执行命令的实例ID列表。 支持实例类型:
	// <li> CVM
	// <li> LIGHTHOUSE
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds" list`

	// 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
	CommandName *string `json:"CommandName,omitempty" name:"CommandName"`

	// 命令描述。不超过120字符。
	Description *string `json:"Description,omitempty" name:"Description"`

	// 命令类型,目前仅支持取值:SHELL。默认:SHELL。
	CommandType *string `json:"CommandType,omitempty" name:"CommandType"`

	// 命令执行路径,默认:/root。
	WorkingDirectory *string `json:"WorkingDirectory,omitempty" name:"WorkingDirectory"`

	// 命令超时时间,默认60秒。取值范围[1, 86400]。
	Timeout *uint64 `json:"Timeout,omitempty" name:"Timeout"`

	// 是否保存命令,取值范围:
	// <li> True:保存
	// <li> False:不保存
	// 默认为 False。
	SaveCommand *bool `json:"SaveCommand,omitempty" name:"SaveCommand"`

	// 是否启用自定义参数功能。
	// 一旦创建,此值不提供修改。
	// 默认值:false。
	EnableParameter *bool `json:"EnableParameter,omitempty" name:"EnableParameter"`

	// 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{\"varA\": \"222\"}。
	// key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
	// 如果 Parameters 未提供,将使用这里的默认值进行替换。
	// 自定义参数最多20个。
	// 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
	DefaultParameters *string `json:"DefaultParameters,omitempty" name:"DefaultParameters"`

	// Command 的自定义参数。字段类型为json encoded string。如:{\"varA\": \"222\"}。
	// key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
	// 如果未提供该参数取值,将使用 DefaultParameters 进行替换。
	// 自定义参数最多20个。
	// 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
	Parameters *string `json:"Parameters,omitempty" name:"Parameters"`
}

func NewRunCommandRequest

func NewRunCommandRequest() (request *RunCommandRequest)

func (*RunCommandRequest) FromJsonString

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

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 {

		// 命令ID。
		CommandId *string `json:"CommandId,omitempty" name:"CommandId"`

		// 执行活动ID。
		InvocationId *string `json:"InvocationId,omitempty" name:"InvocationId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		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

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 TaskResult

type TaskResult struct {

	// 命令执行ExitCode。
	ExitCode *int64 `json:"ExitCode,omitempty" name:"ExitCode"`

	// Base64编码后的命令输出。最大长度24KB。
	Output *string `json:"Output,omitempty" name:"Output"`

	// 命令执行开始时间。
	ExecStartTime *string `json:"ExecStartTime,omitempty" name:"ExecStartTime"`

	// 命令执行结束时间。
	ExecEndTime *string `json:"ExecEndTime,omitempty" name:"ExecEndTime"`

	// 命令最终输出被截断的字节数。
	Dropped *uint64 `json:"Dropped,omitempty" name:"Dropped"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL