v20201028

package
v1.0.941 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2024 License: Apache-2.0 Imports: 7 Imported by: 10

Documentation

Index

Constants

View Source
const (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

	// 调用 CVM 失败。
	FAILEDOPERATION_CVMERROR = "FailedOperation.CVMError"

	// 调用 Lighthouse 失败。
	FAILEDOPERATION_LIGHTHOUSEERROR = "FailedOperation.LighthouseError"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 参数冲突。
	INVALIDPARAMETER_CONFLICTPARAMETER = "InvalidParameter.ConflictParameter"

	// 无效用户名。
	INVALIDPARAMETER_INVALIDUSERNAME = "InvalidParameter.InvalidUsername"

	// 参数名称重复。
	INVALIDPARAMETER_PARAMETERNAMEDUPLICATED = "InvalidParameter.ParameterNameDuplicated"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// Agent不支持此命令类型。
	INVALIDPARAMETERVALUE_AGENTUNSUPPORTEDCOMMANDTYPE = "InvalidParameterValue.AgentUnsupportedCommandType"

	// Command 内容无效。
	INVALIDPARAMETERVALUE_COMMANDCONTENTINVALID = "InvalidParameterValue.CommandContentInvalid"

	// Command 名称重复。
	INVALIDPARAMETERVALUE_COMMANDNAMEDUPLICATED = "InvalidParameterValue.CommandNameDuplicated"

	// 实例类型不一致。
	INVALIDPARAMETERVALUE_INCONSISTENTINSTANCE = "InvalidParameterValue.InconsistentInstance"

	// 实例ID与执行活动无关。
	INVALIDPARAMETERVALUE_INSTANCEISNOTRELATEDTOINVOCATION = "InvalidParameterValue.InstanceIsNotRelatedToInvocation"

	// CommandId 无效。
	INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"

	// Command 名称无效。
	INVALIDPARAMETERVALUE_INVALIDCOMMANDNAME = "InvalidParameterValue.InvalidCommandName"

	// 命令内容无效。
	INVALIDPARAMETERVALUE_INVALIDCONTENT = "InvalidParameterValue.InvalidContent"

	// Crontab 表达式无效。
	INVALIDPARAMETERVALUE_INVALIDCRONEXPRESSION = "InvalidParameterValue.InvalidCronExpression"

	// Filter 无效。
	INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"

	// 实例ID无效。
	INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"

	// 不合法的执行活动ID。
	INVALIDPARAMETERVALUE_INVALIDINVOCATIONID = "InvalidParameterValue.InvalidInvocationId"

	// 不合法的执行任务ID。
	INVALIDPARAMETERVALUE_INVALIDINVOCATIONTASKID = "InvalidParameterValue.InvalidInvocationTaskId"

	// InvokerId 无效。
	INVALIDPARAMETERVALUE_INVALIDINVOKERID = "InvalidParameterValue.InvalidInvokerId"

	// OutputCOSBucketUrl 无效。
	INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSBUCKETURL = "InvalidParameterValue.InvalidOutputCOSBucketUrl"

	// OutputCOSKeyPrefix 无效。
	INVALIDPARAMETERVALUE_INVALIDOUTPUTCOSKEYPREFIX = "InvalidParameterValue.InvalidOutputCOSKeyPrefix"

	// 无效的注册码ID。
	INVALIDPARAMETERVALUE_INVALIDREGISTERCODEID = "InvalidParameterValue.InvalidRegisterCodeId"

	// 无效的托管实例ID。
	INVALIDPARAMETERVALUE_INVALIDREGISTERINSTANCEID = "InvalidParameterValue.InvalidRegisterInstanceId"

	// 无效的时间格式。
	INVALIDPARAMETERVALUE_INVALIDTIMEFORMAT = "InvalidParameterValue.InvalidTimeFormat"

	// 用户名不合法。
	INVALIDPARAMETERVALUE_INVALIDUSERNAME = "InvalidParameterValue.InvalidUsername"

	// 命令执行路径不合法。
	INVALIDPARAMETERVALUE_INVALIDWORKINGDIRECTORY = "InvalidParameterValue.InvalidWorkingDirectory"

	// 调用时间已过期。
	INVALIDPARAMETERVALUE_INVOKETIMEEXPIRED = "InvalidParameterValue.InvokeTimeExpired"

	// 已启用自定义参数功能,但缺失自定义参数信息。
	INVALIDPARAMETERVALUE_LACKOFPARAMETERINFO = "InvalidParameterValue.LackOfParameterInfo"

	// 未提供 Parameters 信息。
	INVALIDPARAMETERVALUE_LACKOFPARAMETERS = "InvalidParameterValue.LackOfParameters"

	// 超过参数限制。
	INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"

	// 未启用自定义参数功能。
	INVALIDPARAMETERVALUE_PARAMETERDISABLED = "InvalidParameterValue.ParameterDisabled"

	// 参数为非法 json string 格式。
	INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"

	// 参数 Key 包含非法字符。
	INVALIDPARAMETERVALUE_PARAMETERKEYCONTAINSINVALIDCHAR = "InvalidParameterValue.ParameterKeyContainsInvalidChar"

	// 参数 Key 重复。
	INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"

	// 参数 Key 过长。
	INVALIDPARAMETERVALUE_PARAMETERKEYLENEXCEEDED = "InvalidParameterValue.ParameterKeyLenExceeded"

	// 参数数目过多。
	INVALIDPARAMETERVALUE_PARAMETERNUMBEREXCEEDED = "InvalidParameterValue.ParameterNumberExceeded"

	// 参数 Value 非 string 类型。
	INVALIDPARAMETERVALUE_PARAMETERVALUENOTSTRING = "InvalidParameterValue.ParameterValueNotString"

	// 参数取值范围不合法。
	INVALIDPARAMETERVALUE_RANGE = "InvalidParameterValue.Range"

	// 未启用自定义参数功能。
	INVALIDPARAMETERVALUE_SUPPORTPARAMETERSONLYIFENABLEPARAMETER = "InvalidParameterValue.SupportParametersOnlyIfEnableParameter"

	// 长度超过限制。
	INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"

	// 超过配额限制。
	LIMITEXCEEDED = "LimitExceeded"

	// 填写的 Filter 取值过多。
	LIMITEXCEEDED_FILTERVALUEEXCEEDED = "LimitExceeded.FilterValueExceeded"

	// 缺少参数错误。
	MISSINGPARAMETER = "MissingParameter"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"

	// 命令不存在。
	RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"

	// 实例不存在。
	RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"

	// 执行活动未找到。
	RESOURCENOTFOUND_INVOCATIONNOTFOUND = "ResourceNotFound.InvocationNotFound"

	// 查询不到注册码。
	RESOURCENOTFOUND_REGISTERCODESNOTFOUNDCODE = "ResourceNotFound.RegisterCodesNotFoundCode"

	// 查询不到注册实例。
	RESOURCENOTFOUND_REGISTERINSTANCENOTFOUNDCODE = "ResourceNotFound.RegisterInstanceNotFoundCode"

	// 角色不存在。
	RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"

	// 资源不可用。
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// Agent 未安装。
	RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"

	// Agent 不在线。
	RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"

	// 命令正在执行中。
	RESOURCEUNAVAILABLE_COMMANDINEXECUTING = "ResourceUnavailable.CommandInExecuting"

	// 命令已关联执行器。
	RESOURCEUNAVAILABLE_COMMANDININVOKER = "ResourceUnavailable.CommandInInvoker"

	// 实例未处于运行中。
	RESOURCEUNAVAILABLE_INSTANCESTATENOTRUNNING = "ResourceUnavailable.InstanceStateNotRunning"

	// 不存在的资源名称
	RESOURCEUNAVAILABLE_INVALIDRESOURCEQUOTARESOURCECODE = "ResourceUnavailable.InvalidResourceQuotaResourceCode"

	// Lighthouse 尚不支持指定的地域。
	RESOURCEUNAVAILABLE_LIGHTHOUSEUNSUPPORTEDREGION = "ResourceUnavailable.LighthouseUnsupportedRegion"

	// 用户配额已用完
	RESOURCEUNAVAILABLE_USERHASNOQUOTACODE = "ResourceUnavailable.UserHasNoQuotaCode"

	// 角色扮演未授权。
	UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

	// CAM鉴权失败。
	UNAUTHORIZEDOPERATION_CAMAUTHFAILED = "UnauthorizedOperation.CamAuthFailed"

	// Token 无效。
	UNAUTHORIZEDOPERATION_INVALIDTOKEN = "UnauthorizedOperation.InvalidToken"

	// Multi-Factor Authentication(MFA) 过期。
	UNAUTHORIZEDOPERATION_MFAEXPIRED = "UnauthorizedOperation.MFAExpired"

	// Multi-Factor Authentication(MFA) 不存在。
	UNAUTHORIZEDOPERATION_MFANOTFOUND = "UnauthorizedOperation.MFANotFound"

	// 未知参数错误。
	UNKNOWNPARAMETER = "UnknownParameter"

	// 操作不支持。
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
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,omitnil,omitempty" name:"InstanceId"`

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

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

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

	// Agent运行环境,取值范围:Linux:Linux实例Windows:Windows实例
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// Agent 支持的功能列表。
	SupportFeatures []*string `json:"SupportFeatures,omitnil,omitempty" name:"SupportFeatures"`
}

type CancelInvocationRequest added in v1.0.309

type CancelInvocationRequest struct {
	*tchttp.BaseRequest

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

	// 实例ID列表,上限100。支持实例类型:
	// <li> CVM </li>
	// <li> LIGHTHOUSE </li>
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`
}

func NewCancelInvocationRequest added in v1.0.309

func NewCancelInvocationRequest() (request *CancelInvocationRequest)

func (*CancelInvocationRequest) FromJsonString added in v1.0.309

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

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

func (*CancelInvocationRequest) ToJsonString added in v1.0.309

func (r *CancelInvocationRequest) ToJsonString() string

type CancelInvocationRequestParams added in v1.0.426

type CancelInvocationRequestParams struct {
	// 执行活动ID
	InvocationId *string `json:"InvocationId,omitnil,omitempty" name:"InvocationId"`

	// 实例ID列表,上限100。支持实例类型:
	// <li> CVM </li>
	// <li> LIGHTHOUSE </li>
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`
}

Predefined struct for user

type CancelInvocationResponse added in v1.0.309

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

func NewCancelInvocationResponse added in v1.0.309

func NewCancelInvocationResponse() (response *CancelInvocationResponse)

func (*CancelInvocationResponse) FromJsonString added in v1.0.309

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

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

func (*CancelInvocationResponse) ToJsonString added in v1.0.309

func (r *CancelInvocationResponse) ToJsonString() string

type CancelInvocationResponseParams added in v1.0.426

type CancelInvocationResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client

type Client struct {
	common.Client
}

func NewClient

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

func NewClientWithSecretId

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

Deprecated

func (*Client) CancelInvocation added in v1.0.309

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

CancelInvocation 取消一台或多台CVM实例执行的命令

* 如果命令还未下发到agent,任务状态处于处于PENDING、DELIVERING、DELIVER_DELAYED,取消后任务状态是CANCELLED

* 如果命令已下发到agent,任务状态处于RUNNING, 取消后任务状态是TERMINATED

可能返回的错误码:

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

func (*Client) CancelInvocationWithContext added in v1.0.324

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

CancelInvocation 取消一台或多台CVM实例执行的命令

* 如果命令还未下发到agent,任务状态处于处于PENDING、DELIVERING、DELIVER_DELAYED,取消后任务状态是CANCELLED

* 如果命令已下发到agent,任务状态处于RUNNING, 取消后任务状态是TERMINATED

可能返回的错误码:

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

func (*Client) CreateCommand

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

CreateCommand 此接口用于创建命令。

可能返回的错误码:

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

func (*Client) CreateCommandWithContext added in v1.0.324

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

CreateCommand 此接口用于创建命令。

可能返回的错误码:

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

func (*Client) CreateInvoker added in v1.0.256

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

CreateInvoker 此接口用于创建执行器。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDCRONEXPRESSION = "InvalidParameterValue.InvalidCronExpression"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDTIMEFORMAT = "InvalidParameterValue.InvalidTimeFormat"
INVALIDPARAMETERVALUE_INVOKETIMEEXPIRED = "InvalidParameterValue.InvokeTimeExpired"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"
RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"

func (*Client) CreateInvokerWithContext added in v1.0.324

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

CreateInvoker 此接口用于创建执行器。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCOMMANDID = "InvalidParameterValue.InvalidCommandId"
INVALIDPARAMETERVALUE_INVALIDCRONEXPRESSION = "InvalidParameterValue.InvalidCronExpression"
INVALIDPARAMETERVALUE_INVALIDINSTANCEID = "InvalidParameterValue.InvalidInstanceId"
INVALIDPARAMETERVALUE_INVALIDTIMEFORMAT = "InvalidParameterValue.InvalidTimeFormat"
INVALIDPARAMETERVALUE_INVOKETIMEEXPIRED = "InvalidParameterValue.InvokeTimeExpired"
INVALIDPARAMETERVALUE_PARAMETERINVALIDJSONFORMAT = "InvalidParameterValue.ParameterInvalidJsonFormat"
RESOURCENOTFOUND_COMMANDNOTFOUND = "ResourceNotFound.CommandNotFound"
RESOURCENOTFOUND_INSTANCENOTFOUND = "ResourceNotFound.InstanceNotFound"
RESOURCEUNAVAILABLE_AGENTNOTINSTALLED = "ResourceUnavailable.AgentNotInstalled"
RESOURCEUNAVAILABLE_AGENTSTATUSNOTONLINE = "ResourceUnavailable.AgentStatusNotOnline"

func (*Client) CreateRegisterCode added in v1.0.730

func (c *Client) CreateRegisterCode(request *CreateRegisterCodeRequest) (response *CreateRegisterCodeResponse, err error)

CreateRegisterCode 接口用于创建注册码。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) CreateRegisterCodeWithContext added in v1.0.730

func (c *Client) CreateRegisterCodeWithContext(ctx context.Context, request *CreateRegisterCodeRequest) (response *CreateRegisterCodeResponse, err error)

CreateRegisterCode 接口用于创建注册码。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DeleteCommand

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

DeleteCommand 此接口用于删除命令。

如果命令与执行器关联,则无法被删除。

可能返回的错误码:

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

func (*Client) DeleteCommandWithContext added in v1.0.324

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

DeleteCommand 此接口用于删除命令。

如果命令与执行器关联,则无法被删除。

可能返回的错误码:

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

func (*Client) DeleteCommands added in v1.0.763

func (c *Client) DeleteCommands(request *DeleteCommandsRequest) (response *DeleteCommandsResponse, err error)

DeleteCommands 批量删除命令接口

可能返回的错误码:

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

func (*Client) DeleteCommandsWithContext added in v1.0.763

func (c *Client) DeleteCommandsWithContext(ctx context.Context, request *DeleteCommandsRequest) (response *DeleteCommandsResponse, err error)

DeleteCommands 批量删除命令接口

可能返回的错误码:

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

func (*Client) DeleteInvoker added in v1.0.256

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

DeleteInvoker 此接口用于删除执行器。

可能返回的错误码:

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

func (*Client) DeleteInvokerWithContext added in v1.0.324

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

DeleteInvoker 此接口用于删除执行器。

可能返回的错误码:

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

func (*Client) DeleteRegisterCodes added in v1.0.730

func (c *Client) DeleteRegisterCodes(request *DeleteRegisterCodesRequest) (response *DeleteRegisterCodesResponse, err error)

DeleteRegisterCodes 此接口用于批量删除注册码。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERCODEID = "InvalidParameterValue.InvalidRegisterCodeId"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_REGISTERCODESNOTFOUNDCODE = "ResourceNotFound.RegisterCodesNotFoundCode"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DeleteRegisterCodesWithContext added in v1.0.730

func (c *Client) DeleteRegisterCodesWithContext(ctx context.Context, request *DeleteRegisterCodesRequest) (response *DeleteRegisterCodesResponse, err error)

DeleteRegisterCodes 此接口用于批量删除注册码。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERCODEID = "InvalidParameterValue.InvalidRegisterCodeId"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_REGISTERCODESNOTFOUNDCODE = "ResourceNotFound.RegisterCodesNotFoundCode"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DeleteRegisterInstance added in v1.0.730

func (c *Client) DeleteRegisterInstance(request *DeleteRegisterInstanceRequest) (response *DeleteRegisterInstanceResponse, err error)

DeleteRegisterInstance 接口用于删除托管实例。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERINSTANCEID = "InvalidParameterValue.InvalidRegisterInstanceId"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_REGISTERINSTANCENOTFOUNDCODE = "ResourceNotFound.RegisterInstanceNotFoundCode"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DeleteRegisterInstanceWithContext added in v1.0.730

func (c *Client) DeleteRegisterInstanceWithContext(ctx context.Context, request *DeleteRegisterInstanceRequest) (response *DeleteRegisterInstanceResponse, err error)

DeleteRegisterInstance 接口用于删除托管实例。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERINSTANCEID = "InvalidParameterValue.InvalidRegisterInstanceId"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_REGISTERINSTANCENOTFOUNDCODE = "ResourceNotFound.RegisterInstanceNotFoundCode"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DescribeAutomationAgentStatus

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

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

可能返回的错误码:

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

func (*Client) DescribeAutomationAgentStatusWithContext added in v1.0.324

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

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

可能返回的错误码:

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

func (*Client) DescribeCommands

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

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

可能返回的错误码:

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

func (*Client) DescribeCommandsWithContext added in v1.0.324

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

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

可能返回的错误码:

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

func (*Client) DescribeInvocationTasks

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

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

可能返回的错误码:

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

func (*Client) DescribeInvocationTasksWithContext added in v1.0.324

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

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

可能返回的错误码:

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

func (*Client) DescribeInvocations

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

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

可能返回的错误码:

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

func (*Client) DescribeInvocationsWithContext added in v1.0.324

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

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

可能返回的错误码:

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

func (*Client) DescribeInvokerRecords added in v1.0.256

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

DescribeInvokerRecords 此接口用于查询执行器的执行记录。

可能返回的错误码:

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

func (*Client) DescribeInvokerRecordsWithContext added in v1.0.324

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

DescribeInvokerRecords 此接口用于查询执行器的执行记录。

可能返回的错误码:

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

func (*Client) DescribeInvokers added in v1.0.256

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

DescribeInvokers 此接口用于查询执行器信息。

可能返回的错误码:

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

func (*Client) DescribeInvokersWithContext added in v1.0.324

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

DescribeInvokers 此接口用于查询执行器信息。

可能返回的错误码:

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

func (*Client) DescribeQuotas added in v1.0.763

func (c *Client) DescribeQuotas(request *DescribeQuotasRequest) (response *DescribeQuotasResponse, err error)

DescribeQuotas 此接口用于获取配额信息

可能返回的错误码:

MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_INVALIDRESOURCEQUOTARESOURCECODE = "ResourceUnavailable.InvalidResourceQuotaResourceCode"

func (*Client) DescribeQuotasWithContext added in v1.0.763

func (c *Client) DescribeQuotasWithContext(ctx context.Context, request *DescribeQuotasRequest) (response *DescribeQuotasResponse, err error)

DescribeQuotas 此接口用于获取配额信息

可能返回的错误码:

MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_INVALIDRESOURCEQUOTARESOURCECODE = "ResourceUnavailable.InvalidResourceQuotaResourceCode"

func (*Client) DescribeRegions

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

DescribeRegions 此接口用于查询 TAT 产品后台地域列表。

RegionState 为 AVAILABLE,代表该地域的 TAT 后台服务已经可用;未返回,代表该地域的 TAT 后台服务尚不可用。

可能返回的错误码:

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

func (*Client) DescribeRegionsWithContext added in v1.0.324

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

DescribeRegions 此接口用于查询 TAT 产品后台地域列表。

RegionState 为 AVAILABLE,代表该地域的 TAT 后台服务已经可用;未返回,代表该地域的 TAT 后台服务尚不可用。

可能返回的错误码:

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

func (*Client) DescribeRegisterCodes added in v1.0.730

func (c *Client) DescribeRegisterCodes(request *DescribeRegisterCodesRequest) (response *DescribeRegisterCodesResponse, err error)

DescribeRegisterCodes 接口用于查询注册码信息。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDREGISTERCODEID = "InvalidParameterValue.InvalidRegisterCodeId"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DescribeRegisterCodesWithContext added in v1.0.730

func (c *Client) DescribeRegisterCodesWithContext(ctx context.Context, request *DescribeRegisterCodesRequest) (response *DescribeRegisterCodesResponse, err error)

DescribeRegisterCodes 接口用于查询注册码信息。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDREGISTERCODEID = "InvalidParameterValue.InvalidRegisterCodeId"
INVALIDPARAMETERVALUE_TOOLONG = "InvalidParameterValue.TooLong"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DescribeRegisterInstances added in v1.0.730

func (c *Client) DescribeRegisterInstances(request *DescribeRegisterInstancesRequest) (response *DescribeRegisterInstancesResponse, err error)

DescribeRegisterInstances 接口用于查询被托管的实例信息。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDREGISTERINSTANCEID = "InvalidParameterValue.InvalidRegisterInstanceId"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DescribeRegisterInstancesWithContext added in v1.0.730

func (c *Client) DescribeRegisterInstancesWithContext(ctx context.Context, request *DescribeRegisterInstancesRequest) (response *DescribeRegisterInstancesResponse, err error)

DescribeRegisterInstances 接口用于查询被托管的实例信息。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDFILTER = "InvalidParameterValue.InvalidFilter"
INVALIDPARAMETERVALUE_INVALIDREGISTERINSTANCEID = "InvalidParameterValue.InvalidRegisterInstanceId"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DisableInvoker added in v1.0.256

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

DisableInvoker 此接口用于停止执行器。

可能返回的错误码:

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

func (*Client) DisableInvokerWithContext added in v1.0.324

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

DisableInvoker 此接口用于停止执行器。

可能返回的错误码:

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

func (*Client) DisableRegisterCodes added in v1.0.730

func (c *Client) DisableRegisterCodes(request *DisableRegisterCodesRequest) (response *DisableRegisterCodesResponse, err error)

DisableRegisterCodes 此接口用于批量禁用注册码。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERCODEID = "InvalidParameterValue.InvalidRegisterCodeId"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_REGISTERCODESNOTFOUNDCODE = "ResourceNotFound.RegisterCodesNotFoundCode"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) DisableRegisterCodesWithContext added in v1.0.730

func (c *Client) DisableRegisterCodesWithContext(ctx context.Context, request *DisableRegisterCodesRequest) (response *DisableRegisterCodesResponse, err error)

DisableRegisterCodes 此接口用于批量禁用注册码。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERCODEID = "InvalidParameterValue.InvalidRegisterCodeId"
INVALIDPARAMETERVALUE_PARAMETERKEYDUPLICATED = "InvalidParameterValue.ParameterKeyDuplicated"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_REGISTERCODESNOTFOUNDCODE = "ResourceNotFound.RegisterCodesNotFoundCode"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) EnableInvoker added in v1.0.256

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

EnableInvoker 此接口用于启用执行器。

可能返回的错误码:

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

func (*Client) EnableInvokerWithContext added in v1.0.324

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

EnableInvoker 此接口用于启用执行器。

可能返回的错误码:

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

func (*Client) InvokeCommand

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

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

* 如果指定实例未安装 agent,或 agent 不在线,返回失败

* 如果命令类型与 agent 运行环境不符,返回失败

* 指定的实例需要处于 VPC 网络

* 指定的实例需要处于 RUNNING 状态

* 不可同时指定 CVM 和 Lighthouse

可能返回的错误码:

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

func (*Client) InvokeCommandWithContext added in v1.0.324

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

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

* 如果指定实例未安装 agent,或 agent 不在线,返回失败

* 如果命令类型与 agent 运行环境不符,返回失败

* 指定的实例需要处于 VPC 网络

* 指定的实例需要处于 RUNNING 状态

* 不可同时指定 CVM 和 Lighthouse

可能返回的错误码:

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

func (*Client) ModifyCommand

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

ModifyCommand 此接口用于修改命令。

可能返回的错误码:

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

func (*Client) ModifyCommandWithContext added in v1.0.324

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

ModifyCommand 此接口用于修改命令。

可能返回的错误码:

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

func (*Client) ModifyInvoker added in v1.0.256

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

ModifyInvoker 此接口用于修改执行器。

可能返回的错误码:

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

func (*Client) ModifyInvokerWithContext added in v1.0.324

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

ModifyInvoker 此接口用于修改执行器。

可能返回的错误码:

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

func (*Client) ModifyRegisterInstance added in v1.0.730

func (c *Client) ModifyRegisterInstance(request *ModifyRegisterInstanceRequest) (response *ModifyRegisterInstanceResponse, err error)

ModifyRegisterInstance 接口用于修改托管实例信息。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERINSTANCEID = "InvalidParameterValue.InvalidRegisterInstanceId"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) ModifyRegisterInstanceWithContext added in v1.0.730

func (c *Client) ModifyRegisterInstanceWithContext(ctx context.Context, request *ModifyRegisterInstanceRequest) (response *ModifyRegisterInstanceResponse, err error)

ModifyRegisterInstance 接口用于修改托管实例信息。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGISTERINSTANCEID = "InvalidParameterValue.InvalidRegisterInstanceId"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_ROLENOTFOUND = "ResourceNotFound.RoleNotFound"
UNAUTHORIZEDOPERATION_ASSUMEROLEUNAUTHORIZED = "UnauthorizedOperation.AssumeRoleUnauthorized"

func (*Client) PreviewReplacedCommandContent

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

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

可能返回的错误码:

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

func (*Client) PreviewReplacedCommandContentWithContext added in v1.0.324

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

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

可能返回的错误码:

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

func (*Client) RunCommand

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

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

* 如果指定实例未安装 agent,或 agent 不在线,返回失败

* 如果命令类型与 agent 运行环境不符,返回失败

* 指定的实例需要处于 VPC 网络

* 指定的实例需要处于 `RUNNING` 状态

* 不可同时指定 CVM 和 Lighthouse

可能返回的错误码:

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

func (*Client) RunCommandWithContext added in v1.0.324

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

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

* 如果指定实例未安装 agent,或 agent 不在线,返回失败

* 如果命令类型与 agent 运行环境不符,返回失败

* 指定的实例需要处于 VPC 网络

* 指定的实例需要处于 `RUNNING` 状态

* 不可同时指定 CVM 和 Lighthouse

可能返回的错误码:

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

type Command

type Command struct {
	// 命令ID。
	CommandId *string `json:"CommandId,omitnil,omitempty" name:"CommandId"`

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

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

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

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

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

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

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

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

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

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

	// 自定义参数的默认取值。
	// 注意:此字段可能返回 null,表示取不到有效值。
	DefaultParameterConfs []*DefaultParameterConf `json:"DefaultParameterConfs,omitnil,omitempty" name:"DefaultParameterConfs"`

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

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

	// 命令关联的标签列表。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 在实例上执行命令的用户名。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 日志上传的cos bucket 地址。
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 日志在cos bucket中的目录。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

type CommandDocument

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

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

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

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

	// 执行用户。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 保存输出的 COS Bucket 链接。
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 保存输出的文件名称前缀。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

type CreateCommandRequest

type CreateCommandRequest struct {
	*tchttp.BaseRequest

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

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

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

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

	// 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
	WorkingDirectory *string `json:"WorkingDirectory,omitnil,omitempty" name:"WorkingDirectory"`

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

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

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

	// 自定义参数数组。
	// 如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
	// 自定义参数最多20个。
	DefaultParameterConfs []*DefaultParameterConf `json:"DefaultParameterConfs,omitnil,omitempty" name:"DefaultParameterConfs"`

	// 为命令关联的标签,列表长度不超过10。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在 Linux 实例中以 root 用户执行命令;在Windows 实例中以 System 用户执行命令。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewCreateCommandRequest

func NewCreateCommandRequest() (request *CreateCommandRequest)

func (*CreateCommandRequest) FromJsonString

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

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

func (*CreateCommandRequest) ToJsonString

func (r *CreateCommandRequest) ToJsonString() string

type CreateCommandRequestParams added in v1.0.426

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

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

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

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

	// 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
	WorkingDirectory *string `json:"WorkingDirectory,omitnil,omitempty" name:"WorkingDirectory"`

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

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

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

	// 自定义参数数组。
	// 如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
	// 自定义参数最多20个。
	DefaultParameterConfs []*DefaultParameterConf `json:"DefaultParameterConfs,omitnil,omitempty" name:"DefaultParameterConfs"`

	// 为命令关联的标签,列表长度不超过10。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在 Linux 实例中以 root 用户执行命令;在Windows 实例中以 System 用户执行命令。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

Predefined struct for user

type CreateCommandResponse

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

func NewCreateCommandResponse

func NewCreateCommandResponse() (response *CreateCommandResponse)

func (*CreateCommandResponse) FromJsonString

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

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

func (*CreateCommandResponse) ToJsonString

func (r *CreateCommandResponse) ToJsonString() string

type CreateCommandResponseParams added in v1.0.426

type CreateCommandResponseParams struct {
	// 命令ID。
	CommandId *string `json:"CommandId,omitnil,omitempty" name:"CommandId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateInvokerRequest added in v1.0.256

type CreateInvokerRequest struct {
	*tchttp.BaseRequest

	// 执行器名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

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

	// 触发器关联的实例ID。列表上限 100。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 命令执行用户。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 命令自定义参数。
	Parameters *string `json:"Parameters,omitnil,omitempty" name:"Parameters"`

	// 周期执行器设置,当创建周期执行器时,必须指定此参数。
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitnil,omitempty" name:"ScheduleSettings"`
}

func NewCreateInvokerRequest added in v1.0.256

func NewCreateInvokerRequest() (request *CreateInvokerRequest)

func (*CreateInvokerRequest) FromJsonString added in v1.0.256

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

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

func (*CreateInvokerRequest) ToJsonString added in v1.0.256

func (r *CreateInvokerRequest) ToJsonString() string

type CreateInvokerRequestParams added in v1.0.426

type CreateInvokerRequestParams struct {
	// 执行器名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

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

	// 触发器关联的实例ID。列表上限 100。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 命令执行用户。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 命令自定义参数。
	Parameters *string `json:"Parameters,omitnil,omitempty" name:"Parameters"`

	// 周期执行器设置,当创建周期执行器时,必须指定此参数。
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitnil,omitempty" name:"ScheduleSettings"`
}

Predefined struct for user

type CreateInvokerResponse added in v1.0.256

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

func NewCreateInvokerResponse added in v1.0.256

func NewCreateInvokerResponse() (response *CreateInvokerResponse)

func (*CreateInvokerResponse) FromJsonString added in v1.0.256

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

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

func (*CreateInvokerResponse) ToJsonString added in v1.0.256

func (r *CreateInvokerResponse) ToJsonString() string

type CreateInvokerResponseParams added in v1.0.426

type CreateInvokerResponseParams struct {
	// 执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateRegisterCodeRequest added in v1.0.730

type CreateRegisterCodeRequest struct {
	*tchttp.BaseRequest

	// 注册码描述。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 注册实例名称前缀。
	InstanceNamePrefix *string `json:"InstanceNamePrefix,omitnil,omitempty" name:"InstanceNamePrefix"`

	// 该注册码允许注册的实例数目。默认限制为10个。
	RegisterLimit *int64 `json:"RegisterLimit,omitnil,omitempty" name:"RegisterLimit"`

	// 该注册码的有效时间,单位为小时。默认为4小时。
	EffectiveTime *int64 `json:"EffectiveTime,omitnil,omitempty" name:"EffectiveTime"`

	// 该注册码限制tat_agent只能从IpAddressRange所描述公网出口进行注册。默认不做限制。
	IpAddressRange *string `json:"IpAddressRange,omitnil,omitempty" name:"IpAddressRange"`
}

func NewCreateRegisterCodeRequest added in v1.0.730

func NewCreateRegisterCodeRequest() (request *CreateRegisterCodeRequest)

func (*CreateRegisterCodeRequest) FromJsonString added in v1.0.730

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

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

func (*CreateRegisterCodeRequest) ToJsonString added in v1.0.730

func (r *CreateRegisterCodeRequest) ToJsonString() string

type CreateRegisterCodeRequestParams added in v1.0.730

type CreateRegisterCodeRequestParams struct {
	// 注册码描述。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 注册实例名称前缀。
	InstanceNamePrefix *string `json:"InstanceNamePrefix,omitnil,omitempty" name:"InstanceNamePrefix"`

	// 该注册码允许注册的实例数目。默认限制为10个。
	RegisterLimit *int64 `json:"RegisterLimit,omitnil,omitempty" name:"RegisterLimit"`

	// 该注册码的有效时间,单位为小时。默认为4小时。
	EffectiveTime *int64 `json:"EffectiveTime,omitnil,omitempty" name:"EffectiveTime"`

	// 该注册码限制tat_agent只能从IpAddressRange所描述公网出口进行注册。默认不做限制。
	IpAddressRange *string `json:"IpAddressRange,omitnil,omitempty" name:"IpAddressRange"`
}

Predefined struct for user

type CreateRegisterCodeResponse added in v1.0.730

type CreateRegisterCodeResponse struct {
	*tchttp.BaseResponse
	Response *CreateRegisterCodeResponseParams `json:"Response"`
}

func NewCreateRegisterCodeResponse added in v1.0.730

func NewCreateRegisterCodeResponse() (response *CreateRegisterCodeResponse)

func (*CreateRegisterCodeResponse) FromJsonString added in v1.0.730

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

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

func (*CreateRegisterCodeResponse) ToJsonString added in v1.0.730

func (r *CreateRegisterCodeResponse) ToJsonString() string

type CreateRegisterCodeResponseParams added in v1.0.730

type CreateRegisterCodeResponseParams struct {
	// 注册码ID。
	RegisterCodeId *string `json:"RegisterCodeId,omitnil,omitempty" name:"RegisterCodeId"`

	// 注册码值。
	RegisterCodeValue *string `json:"RegisterCodeValue,omitnil,omitempty" name:"RegisterCodeValue"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DefaultParameterConf added in v1.0.730

type DefaultParameterConf struct {
	// 参数名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ParameterName *string `json:"ParameterName,omitnil,omitempty" name:"ParameterName"`

	// 参数默认值。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ParameterValue *string `json:"ParameterValue,omitnil,omitempty" name:"ParameterValue"`

	// 参数描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ParameterDescription *string `json:"ParameterDescription,omitnil,omitempty" name:"ParameterDescription"`
}

type DeleteCommandRequest

type DeleteCommandRequest struct {
	*tchttp.BaseRequest

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

func NewDeleteCommandRequest

func NewDeleteCommandRequest() (request *DeleteCommandRequest)

func (*DeleteCommandRequest) FromJsonString

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

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

func (*DeleteCommandRequest) ToJsonString

func (r *DeleteCommandRequest) ToJsonString() string

type DeleteCommandRequestParams added in v1.0.426

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

Predefined struct for user

type DeleteCommandResponse

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

func NewDeleteCommandResponse

func NewDeleteCommandResponse() (response *DeleteCommandResponse)

func (*DeleteCommandResponse) FromJsonString

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

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

func (*DeleteCommandResponse) ToJsonString

func (r *DeleteCommandResponse) ToJsonString() string

type DeleteCommandResponseParams added in v1.0.426

type DeleteCommandResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteCommandsRequest added in v1.0.763

type DeleteCommandsRequest struct {
	*tchttp.BaseRequest

	// 待删除命令id
	CommandIds []*string `json:"CommandIds,omitnil,omitempty" name:"CommandIds"`
}

func NewDeleteCommandsRequest added in v1.0.763

func NewDeleteCommandsRequest() (request *DeleteCommandsRequest)

func (*DeleteCommandsRequest) FromJsonString added in v1.0.763

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

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

func (*DeleteCommandsRequest) ToJsonString added in v1.0.763

func (r *DeleteCommandsRequest) ToJsonString() string

type DeleteCommandsRequestParams added in v1.0.763

type DeleteCommandsRequestParams struct {
	// 待删除命令id
	CommandIds []*string `json:"CommandIds,omitnil,omitempty" name:"CommandIds"`
}

Predefined struct for user

type DeleteCommandsResponse added in v1.0.763

type DeleteCommandsResponse struct {
	*tchttp.BaseResponse
	Response *DeleteCommandsResponseParams `json:"Response"`
}

func NewDeleteCommandsResponse added in v1.0.763

func NewDeleteCommandsResponse() (response *DeleteCommandsResponse)

func (*DeleteCommandsResponse) FromJsonString added in v1.0.763

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

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

func (*DeleteCommandsResponse) ToJsonString added in v1.0.763

func (r *DeleteCommandsResponse) ToJsonString() string

type DeleteCommandsResponseParams added in v1.0.763

type DeleteCommandsResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteInvokerRequest added in v1.0.256

type DeleteInvokerRequest struct {
	*tchttp.BaseRequest

	// 待删除的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`
}

func NewDeleteInvokerRequest added in v1.0.256

func NewDeleteInvokerRequest() (request *DeleteInvokerRequest)

func (*DeleteInvokerRequest) FromJsonString added in v1.0.256

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

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

func (*DeleteInvokerRequest) ToJsonString added in v1.0.256

func (r *DeleteInvokerRequest) ToJsonString() string

type DeleteInvokerRequestParams added in v1.0.426

type DeleteInvokerRequestParams struct {
	// 待删除的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`
}

Predefined struct for user

type DeleteInvokerResponse added in v1.0.256

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

func NewDeleteInvokerResponse added in v1.0.256

func NewDeleteInvokerResponse() (response *DeleteInvokerResponse)

func (*DeleteInvokerResponse) FromJsonString added in v1.0.256

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

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

func (*DeleteInvokerResponse) ToJsonString added in v1.0.256

func (r *DeleteInvokerResponse) ToJsonString() string

type DeleteInvokerResponseParams added in v1.0.426

type DeleteInvokerResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteRegisterCodesRequest added in v1.0.730

type DeleteRegisterCodesRequest struct {
	*tchttp.BaseRequest

	// 注册码ID列表。限制输入的注册码ID数量大于0小于100。
	RegisterCodeIds []*string `json:"RegisterCodeIds,omitnil,omitempty" name:"RegisterCodeIds"`
}

func NewDeleteRegisterCodesRequest added in v1.0.730

func NewDeleteRegisterCodesRequest() (request *DeleteRegisterCodesRequest)

func (*DeleteRegisterCodesRequest) FromJsonString added in v1.0.730

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

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

func (*DeleteRegisterCodesRequest) ToJsonString added in v1.0.730

func (r *DeleteRegisterCodesRequest) ToJsonString() string

type DeleteRegisterCodesRequestParams added in v1.0.730

type DeleteRegisterCodesRequestParams struct {
	// 注册码ID列表。限制输入的注册码ID数量大于0小于100。
	RegisterCodeIds []*string `json:"RegisterCodeIds,omitnil,omitempty" name:"RegisterCodeIds"`
}

Predefined struct for user

type DeleteRegisterCodesResponse added in v1.0.730

type DeleteRegisterCodesResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRegisterCodesResponseParams `json:"Response"`
}

func NewDeleteRegisterCodesResponse added in v1.0.730

func NewDeleteRegisterCodesResponse() (response *DeleteRegisterCodesResponse)

func (*DeleteRegisterCodesResponse) FromJsonString added in v1.0.730

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

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

func (*DeleteRegisterCodesResponse) ToJsonString added in v1.0.730

func (r *DeleteRegisterCodesResponse) ToJsonString() string

type DeleteRegisterCodesResponseParams added in v1.0.730

type DeleteRegisterCodesResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteRegisterInstanceRequest added in v1.0.730

type DeleteRegisterInstanceRequest struct {
	*tchttp.BaseRequest

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

func NewDeleteRegisterInstanceRequest added in v1.0.730

func NewDeleteRegisterInstanceRequest() (request *DeleteRegisterInstanceRequest)

func (*DeleteRegisterInstanceRequest) FromJsonString added in v1.0.730

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

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

func (*DeleteRegisterInstanceRequest) ToJsonString added in v1.0.730

func (r *DeleteRegisterInstanceRequest) ToJsonString() string

type DeleteRegisterInstanceRequestParams added in v1.0.730

type DeleteRegisterInstanceRequestParams struct {
	// 实例ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DeleteRegisterInstanceResponse added in v1.0.730

type DeleteRegisterInstanceResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRegisterInstanceResponseParams `json:"Response"`
}

func NewDeleteRegisterInstanceResponse added in v1.0.730

func NewDeleteRegisterInstanceResponse() (response *DeleteRegisterInstanceResponse)

func (*DeleteRegisterInstanceResponse) FromJsonString added in v1.0.730

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

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

func (*DeleteRegisterInstanceResponse) ToJsonString added in v1.0.730

func (r *DeleteRegisterInstanceResponse) ToJsonString() string

type DeleteRegisterInstanceResponseParams added in v1.0.730

type DeleteRegisterInstanceResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeAutomationAgentStatusRequest

type DescribeAutomationAgentStatusRequest struct {
	*tchttp.BaseRequest

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

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

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

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

func NewDescribeAutomationAgentStatusRequest

func NewDescribeAutomationAgentStatusRequest() (request *DescribeAutomationAgentStatusRequest)

func (*DescribeAutomationAgentStatusRequest) FromJsonString

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

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

func (*DescribeAutomationAgentStatusRequest) ToJsonString

func (r *DescribeAutomationAgentStatusRequest) ToJsonString() string

type DescribeAutomationAgentStatusRequestParams added in v1.0.426

type DescribeAutomationAgentStatusRequestParams struct {
	// 待查询的实例ID列表。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

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

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

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

Predefined struct for user

type DescribeAutomationAgentStatusResponse

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

func NewDescribeAutomationAgentStatusResponse

func NewDescribeAutomationAgentStatusResponse() (response *DescribeAutomationAgentStatusResponse)

func (*DescribeAutomationAgentStatusResponse) FromJsonString

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

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

func (*DescribeAutomationAgentStatusResponse) ToJsonString

type DescribeAutomationAgentStatusResponseParams added in v1.0.426

type DescribeAutomationAgentStatusResponseParams struct {
	// Agent 信息列表。
	AutomationAgentSet []*AutomationAgentInfo `json:"AutomationAgentSet,omitnil,omitempty" name:"AutomationAgentSet"`

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

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeCommandsRequest

type DescribeCommandsRequest struct {
	*tchttp.BaseRequest

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

	// 过滤条件。
	// <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。</li>
	// <li> command-name - String - 是否必填:否 -(过滤条件)按照命令名称过滤。</li>
	// <li> command-type - String - 是否必填:否 -(过滤条件)按照命令类型过滤,取值为 SHELL 或 POWERSHELL。</li>
	// <li> created-by - String - 是否必填:否 -(过滤条件)按照命令创建者过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。</li>
	// <li> tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。</li>
	// <li> tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。</li>
	// <li> tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例4</li>
	//
	// 每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `CommandIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

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

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

func NewDescribeCommandsRequest

func NewDescribeCommandsRequest() (request *DescribeCommandsRequest)

func (*DescribeCommandsRequest) FromJsonString

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

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

func (*DescribeCommandsRequest) ToJsonString

func (r *DescribeCommandsRequest) ToJsonString() string

type DescribeCommandsRequestParams added in v1.0.426

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

	// 过滤条件。
	// <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。</li>
	// <li> command-name - String - 是否必填:否 -(过滤条件)按照命令名称过滤。</li>
	// <li> command-type - String - 是否必填:否 -(过滤条件)按照命令类型过滤,取值为 SHELL 或 POWERSHELL。</li>
	// <li> created-by - String - 是否必填:否 -(过滤条件)按照命令创建者过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。</li>
	// <li> tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。</li>
	// <li> tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。</li>
	// <li> tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例4</li>
	//
	// 每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `CommandIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

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

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

Predefined struct for user

type DescribeCommandsResponse

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

func NewDescribeCommandsResponse

func NewDescribeCommandsResponse() (response *DescribeCommandsResponse)

func (*DescribeCommandsResponse) FromJsonString

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

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

func (*DescribeCommandsResponse) ToJsonString

func (r *DescribeCommandsResponse) ToJsonString() string

type DescribeCommandsResponseParams added in v1.0.426

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

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

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInvocationTasksRequest

type DescribeInvocationTasksRequest struct {
	*tchttp.BaseRequest

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

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

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

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

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

func NewDescribeInvocationTasksRequest

func NewDescribeInvocationTasksRequest() (request *DescribeInvocationTasksRequest)

func (*DescribeInvocationTasksRequest) FromJsonString

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

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

func (*DescribeInvocationTasksRequest) ToJsonString

func (r *DescribeInvocationTasksRequest) ToJsonString() string

type DescribeInvocationTasksRequestParams added in v1.0.426

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

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

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

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

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

Predefined struct for user

type DescribeInvocationTasksResponse

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

func NewDescribeInvocationTasksResponse

func NewDescribeInvocationTasksResponse() (response *DescribeInvocationTasksResponse)

func (*DescribeInvocationTasksResponse) FromJsonString

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

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

func (*DescribeInvocationTasksResponse) ToJsonString

func (r *DescribeInvocationTasksResponse) ToJsonString() string

type DescribeInvocationTasksResponseParams added in v1.0.426

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

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

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInvocationsRequest

type DescribeInvocationsRequest struct {
	*tchttp.BaseRequest

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

	// 过滤条件。<br>
	//
	// <li> invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。</li>
	//  <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。</li>
	// <li> command-created-by - String - 是否必填:否 -(过滤条件)按照执行的命令类型过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。</li>
	//  <li> instance-kind - String - 是否必填:否 -(过滤条件)按照运行实例类型过滤,取值为 CVM 或 LIGHTHOUSE,CVM 代表实例为云服务器, LIGHTHOUSE 代表实例为轻量应用服务器。</li>
	//  <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

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

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

func NewDescribeInvocationsRequest

func NewDescribeInvocationsRequest() (request *DescribeInvocationsRequest)

func (*DescribeInvocationsRequest) FromJsonString

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

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

func (*DescribeInvocationsRequest) ToJsonString

func (r *DescribeInvocationsRequest) ToJsonString() string

type DescribeInvocationsRequestParams added in v1.0.426

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

	// 过滤条件。<br>
	//
	// <li> invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。</li>
	//  <li> command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。</li>
	// <li> command-created-by - String - 是否必填:否 -(过滤条件)按照执行的命令类型过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。</li>
	//  <li> instance-kind - String - 是否必填:否 -(过滤条件)按照运行实例类型过滤,取值为 CVM 或 LIGHTHOUSE,CVM 代表实例为云服务器, LIGHTHOUSE 代表实例为轻量应用服务器。</li>
	//  <br>每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationIds` 和 `Filters` 。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

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

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

Predefined struct for user

type DescribeInvocationsResponse

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

func NewDescribeInvocationsResponse

func NewDescribeInvocationsResponse() (response *DescribeInvocationsResponse)

func (*DescribeInvocationsResponse) FromJsonString

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

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

func (*DescribeInvocationsResponse) ToJsonString

func (r *DescribeInvocationsResponse) ToJsonString() string

type DescribeInvocationsResponseParams added in v1.0.426

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

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

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInvokerRecordsRequest added in v1.0.256

type DescribeInvokerRecordsRequest struct {
	*tchttp.BaseRequest

	// 执行器ID列表。列表上限 100。
	InvokerIds []*string `json:"InvokerIds,omitnil,omitempty" name:"InvokerIds"`

	// 返回数量,默认为20,最大值为100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeInvokerRecordsRequest added in v1.0.256

func NewDescribeInvokerRecordsRequest() (request *DescribeInvokerRecordsRequest)

func (*DescribeInvokerRecordsRequest) FromJsonString added in v1.0.256

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

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

func (*DescribeInvokerRecordsRequest) ToJsonString added in v1.0.256

func (r *DescribeInvokerRecordsRequest) ToJsonString() string

type DescribeInvokerRecordsRequestParams added in v1.0.426

type DescribeInvokerRecordsRequestParams struct {
	// 执行器ID列表。列表上限 100。
	InvokerIds []*string `json:"InvokerIds,omitnil,omitempty" name:"InvokerIds"`

	// 返回数量,默认为20,最大值为100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeInvokerRecordsResponse added in v1.0.256

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

func NewDescribeInvokerRecordsResponse added in v1.0.256

func NewDescribeInvokerRecordsResponse() (response *DescribeInvokerRecordsResponse)

func (*DescribeInvokerRecordsResponse) FromJsonString added in v1.0.256

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

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

func (*DescribeInvokerRecordsResponse) ToJsonString added in v1.0.256

func (r *DescribeInvokerRecordsResponse) ToJsonString() string

type DescribeInvokerRecordsResponseParams added in v1.0.426

type DescribeInvokerRecordsResponseParams struct {
	// 符合条件的历史记录数量。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 执行器执行历史记录。
	InvokerRecordSet []*InvokerRecord `json:"InvokerRecordSet,omitnil,omitempty" name:"InvokerRecordSet"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInvokersRequest added in v1.0.256

type DescribeInvokersRequest struct {
	*tchttp.BaseRequest

	// 执行器ID列表。
	InvokerIds []*string `json:"InvokerIds,omitnil,omitempty" name:"InvokerIds"`

	// 过滤条件:
	//
	// <li> invoker-id - String - 是否必填:否 - (过滤条件)按执行器ID过滤。
	// <li> command-id - String - 是否必填:否 - (过滤条件)按命令ID过滤。
	// <li> type - String - 是否必填:否 - (过滤条件)按执行器类型过滤。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// 返回数量,默认为20,最大值为100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeInvokersRequest added in v1.0.256

func NewDescribeInvokersRequest() (request *DescribeInvokersRequest)

func (*DescribeInvokersRequest) FromJsonString added in v1.0.256

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

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

func (*DescribeInvokersRequest) ToJsonString added in v1.0.256

func (r *DescribeInvokersRequest) ToJsonString() string

type DescribeInvokersRequestParams added in v1.0.426

type DescribeInvokersRequestParams struct {
	// 执行器ID列表。
	InvokerIds []*string `json:"InvokerIds,omitnil,omitempty" name:"InvokerIds"`

	// 过滤条件:
	//
	// <li> invoker-id - String - 是否必填:否 - (过滤条件)按执行器ID过滤。
	// <li> command-id - String - 是否必填:否 - (过滤条件)按命令ID过滤。
	// <li> type - String - 是否必填:否 - (过滤条件)按执行器类型过滤。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// 返回数量,默认为20,最大值为100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeInvokersResponse added in v1.0.256

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

func NewDescribeInvokersResponse added in v1.0.256

func NewDescribeInvokersResponse() (response *DescribeInvokersResponse)

func (*DescribeInvokersResponse) FromJsonString added in v1.0.256

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

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

func (*DescribeInvokersResponse) ToJsonString added in v1.0.256

func (r *DescribeInvokersResponse) ToJsonString() string

type DescribeInvokersResponseParams added in v1.0.426

type DescribeInvokersResponseParams struct {
	// 满足条件的执行器数量。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 执行器信息。
	InvokerSet []*Invoker `json:"InvokerSet,omitnil,omitempty" name:"InvokerSet"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeQuotasRequest added in v1.0.763

type DescribeQuotasRequest struct {
	*tchttp.BaseRequest

	// 资源名称,目前有"COMMAND","REGISTER_CODE" 这两个指标
	ResourceNames []*string `json:"ResourceNames,omitnil,omitempty" name:"ResourceNames"`
}

func NewDescribeQuotasRequest added in v1.0.763

func NewDescribeQuotasRequest() (request *DescribeQuotasRequest)

func (*DescribeQuotasRequest) FromJsonString added in v1.0.763

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

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

func (*DescribeQuotasRequest) ToJsonString added in v1.0.763

func (r *DescribeQuotasRequest) ToJsonString() string

type DescribeQuotasRequestParams added in v1.0.763

type DescribeQuotasRequestParams struct {
	// 资源名称,目前有"COMMAND","REGISTER_CODE" 这两个指标
	ResourceNames []*string `json:"ResourceNames,omitnil,omitempty" name:"ResourceNames"`
}

Predefined struct for user

type DescribeQuotasResponse added in v1.0.763

type DescribeQuotasResponse struct {
	*tchttp.BaseResponse
	Response *DescribeQuotasResponseParams `json:"Response"`
}

func NewDescribeQuotasResponse added in v1.0.763

func NewDescribeQuotasResponse() (response *DescribeQuotasResponse)

func (*DescribeQuotasResponse) FromJsonString added in v1.0.763

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

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

func (*DescribeQuotasResponse) ToJsonString added in v1.0.763

func (r *DescribeQuotasResponse) ToJsonString() string

type DescribeQuotasResponseParams added in v1.0.763

type DescribeQuotasResponseParams struct {
	// 资源额度列表
	GeneralResourceQuotaSet []*GeneralResourceQuotaSet `json:"GeneralResourceQuotaSet,omitnil,omitempty" name:"GeneralResourceQuotaSet"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRegionsRequest

type DescribeRegionsRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeRegionsRequest

func NewDescribeRegionsRequest() (request *DescribeRegionsRequest)

func (*DescribeRegionsRequest) FromJsonString

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

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

func (*DescribeRegionsRequest) ToJsonString

func (r *DescribeRegionsRequest) ToJsonString() string

type DescribeRegionsRequestParams added in v1.0.426

type DescribeRegionsRequestParams struct {
}

Predefined struct for user

type DescribeRegionsResponse

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

func NewDescribeRegionsResponse

func NewDescribeRegionsResponse() (response *DescribeRegionsResponse)

func (*DescribeRegionsResponse) FromJsonString

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

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

func (*DescribeRegionsResponse) ToJsonString

func (r *DescribeRegionsResponse) ToJsonString() string

type DescribeRegionsResponseParams added in v1.0.426

type DescribeRegionsResponseParams struct {
	// 地域数量
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRegisterCodesRequest added in v1.0.730

type DescribeRegisterCodesRequest struct {
	*tchttp.BaseRequest

	// 注册码ID。
	RegisterCodeIds []*string `json:"RegisterCodeIds,omitnil,omitempty" name:"RegisterCodeIds"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeRegisterCodesRequest added in v1.0.730

func NewDescribeRegisterCodesRequest() (request *DescribeRegisterCodesRequest)

func (*DescribeRegisterCodesRequest) FromJsonString added in v1.0.730

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

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

func (*DescribeRegisterCodesRequest) ToJsonString added in v1.0.730

func (r *DescribeRegisterCodesRequest) ToJsonString() string

type DescribeRegisterCodesRequestParams added in v1.0.730

type DescribeRegisterCodesRequestParams struct {
	// 注册码ID。
	RegisterCodeIds []*string `json:"RegisterCodeIds,omitnil,omitempty" name:"RegisterCodeIds"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeRegisterCodesResponse added in v1.0.730

type DescribeRegisterCodesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRegisterCodesResponseParams `json:"Response"`
}

func NewDescribeRegisterCodesResponse added in v1.0.730

func NewDescribeRegisterCodesResponse() (response *DescribeRegisterCodesResponse)

func (*DescribeRegisterCodesResponse) FromJsonString added in v1.0.730

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

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

func (*DescribeRegisterCodesResponse) ToJsonString added in v1.0.730

func (r *DescribeRegisterCodesResponse) ToJsonString() string

type DescribeRegisterCodesResponseParams added in v1.0.730

type DescribeRegisterCodesResponseParams struct {
	// 查询到的注册码总数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 注册码信息列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RegisterCodeSet []*RegisterCodeInfo `json:"RegisterCodeSet,omitnil,omitempty" name:"RegisterCodeSet"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRegisterInstancesRequest added in v1.0.730

type DescribeRegisterInstancesRequest struct {
	*tchttp.BaseRequest

	// 实例id。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 过滤器列表。
	//
	// - instance-name
	//
	// 按照【实例名称】进行过滤。
	// 类型:String
	// 必选:否
	//
	// - instance-id
	//
	// 按照【实例ID】进行过滤。
	// 类型:String
	// 必选:否
	//
	// - register-code-id
	//
	// 按照【注册码ID】进行过滤。
	// 类型:String
	// 必选:否
	//
	// - sys-name
	//
	// 按照【操作系统类型】进行过滤,取值:Linux | Windows。
	// 类型:String
	// 必选:否
	//
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeRegisterInstancesRequest added in v1.0.730

func NewDescribeRegisterInstancesRequest() (request *DescribeRegisterInstancesRequest)

func (*DescribeRegisterInstancesRequest) FromJsonString added in v1.0.730

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

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

func (*DescribeRegisterInstancesRequest) ToJsonString added in v1.0.730

func (r *DescribeRegisterInstancesRequest) ToJsonString() string

type DescribeRegisterInstancesRequestParams added in v1.0.730

type DescribeRegisterInstancesRequestParams struct {
	// 实例id。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 过滤器列表。
	//
	// - instance-name
	//
	// 按照【实例名称】进行过滤。
	// 类型:String
	// 必选:否
	//
	// - instance-id
	//
	// 按照【实例ID】进行过滤。
	// 类型:String
	// 必选:否
	//
	// - register-code-id
	//
	// 按照【注册码ID】进行过滤。
	// 类型:String
	// 必选:否
	//
	// - sys-name
	//
	// 按照【操作系统类型】进行过滤,取值:Linux | Windows。
	// 类型:String
	// 必选:否
	//
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeRegisterInstancesResponse added in v1.0.730

type DescribeRegisterInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRegisterInstancesResponseParams `json:"Response"`
}

func NewDescribeRegisterInstancesResponse added in v1.0.730

func NewDescribeRegisterInstancesResponse() (response *DescribeRegisterInstancesResponse)

func (*DescribeRegisterInstancesResponse) FromJsonString added in v1.0.730

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

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

func (*DescribeRegisterInstancesResponse) ToJsonString added in v1.0.730

func (r *DescribeRegisterInstancesResponse) ToJsonString() string

type DescribeRegisterInstancesResponseParams added in v1.0.730

type DescribeRegisterInstancesResponseParams struct {
	// 该实例注册过的注册码总数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 被托管的实例信息的列表。
	RegisterInstanceSet []*RegisterInstanceInfo `json:"RegisterInstanceSet,omitnil,omitempty" name:"RegisterInstanceSet"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableInvokerRequest added in v1.0.256

type DisableInvokerRequest struct {
	*tchttp.BaseRequest

	// 待停止的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`
}

func NewDisableInvokerRequest added in v1.0.256

func NewDisableInvokerRequest() (request *DisableInvokerRequest)

func (*DisableInvokerRequest) FromJsonString added in v1.0.256

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

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

func (*DisableInvokerRequest) ToJsonString added in v1.0.256

func (r *DisableInvokerRequest) ToJsonString() string

type DisableInvokerRequestParams added in v1.0.426

type DisableInvokerRequestParams struct {
	// 待停止的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`
}

Predefined struct for user

type DisableInvokerResponse added in v1.0.256

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

func NewDisableInvokerResponse added in v1.0.256

func NewDisableInvokerResponse() (response *DisableInvokerResponse)

func (*DisableInvokerResponse) FromJsonString added in v1.0.256

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

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

func (*DisableInvokerResponse) ToJsonString added in v1.0.256

func (r *DisableInvokerResponse) ToJsonString() string

type DisableInvokerResponseParams added in v1.0.426

type DisableInvokerResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableRegisterCodesRequest added in v1.0.730

type DisableRegisterCodesRequest struct {
	*tchttp.BaseRequest

	// 注册码ID。
	RegisterCodeIds []*string `json:"RegisterCodeIds,omitnil,omitempty" name:"RegisterCodeIds"`
}

func NewDisableRegisterCodesRequest added in v1.0.730

func NewDisableRegisterCodesRequest() (request *DisableRegisterCodesRequest)

func (*DisableRegisterCodesRequest) FromJsonString added in v1.0.730

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

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

func (*DisableRegisterCodesRequest) ToJsonString added in v1.0.730

func (r *DisableRegisterCodesRequest) ToJsonString() string

type DisableRegisterCodesRequestParams added in v1.0.730

type DisableRegisterCodesRequestParams struct {
	// 注册码ID。
	RegisterCodeIds []*string `json:"RegisterCodeIds,omitnil,omitempty" name:"RegisterCodeIds"`
}

Predefined struct for user

type DisableRegisterCodesResponse added in v1.0.730

type DisableRegisterCodesResponse struct {
	*tchttp.BaseResponse
	Response *DisableRegisterCodesResponseParams `json:"Response"`
}

func NewDisableRegisterCodesResponse added in v1.0.730

func NewDisableRegisterCodesResponse() (response *DisableRegisterCodesResponse)

func (*DisableRegisterCodesResponse) FromJsonString added in v1.0.730

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

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

func (*DisableRegisterCodesResponse) ToJsonString added in v1.0.730

func (r *DisableRegisterCodesResponse) ToJsonString() string

type DisableRegisterCodesResponseParams added in v1.0.730

type DisableRegisterCodesResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableInvokerRequest added in v1.0.256

type EnableInvokerRequest struct {
	*tchttp.BaseRequest

	// 待启用的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`
}

func NewEnableInvokerRequest added in v1.0.256

func NewEnableInvokerRequest() (request *EnableInvokerRequest)

func (*EnableInvokerRequest) FromJsonString added in v1.0.256

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

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

func (*EnableInvokerRequest) ToJsonString added in v1.0.256

func (r *EnableInvokerRequest) ToJsonString() string

type EnableInvokerRequestParams added in v1.0.426

type EnableInvokerRequestParams struct {
	// 待启用的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`
}

Predefined struct for user

type EnableInvokerResponse added in v1.0.256

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

func NewEnableInvokerResponse added in v1.0.256

func NewEnableInvokerResponse() (response *EnableInvokerResponse)

func (*EnableInvokerResponse) FromJsonString added in v1.0.256

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

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

func (*EnableInvokerResponse) ToJsonString added in v1.0.256

func (r *EnableInvokerResponse) ToJsonString() string

type EnableInvokerResponseParams added in v1.0.426

type EnableInvokerResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Filter

type Filter struct {
	// 需要过滤的字段。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

type GeneralResourceQuotaSet added in v1.0.763

type GeneralResourceQuotaSet struct {
	// 资源名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

	// 已使用额度
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceQuotaUsed *int64 `json:"ResourceQuotaUsed,omitnil,omitempty" name:"ResourceQuotaUsed"`

	// 总额度
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceQuotaTotal *int64 `json:"ResourceQuotaTotal,omitnil,omitempty" name:"ResourceQuotaTotal"`
}

type Invocation

type Invocation struct {
	// 执行活动ID。
	InvocationId *string `json:"InvocationId,omitnil,omitempty" name:"InvocationId"`

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

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

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

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

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

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

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

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

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

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

	// 执行命令的实例类型,取值范围:CVM、LIGHTHOUSE。
	InstanceKind *string `json:"InstanceKind,omitnil,omitempty" name:"InstanceKind"`

	// 在实例上执行命令时使用的用户名。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 调用来源。
	InvocationSource *string `json:"InvocationSource,omitnil,omitempty" name:"InvocationSource"`

	// base64编码的命令内容
	CommandContent *string `json:"CommandContent,omitnil,omitempty" name:"CommandContent"`

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

	// 执行命令过期时间, 单位秒
	Timeout *uint64 `json:"Timeout,omitnil,omitempty" name:"Timeout"`

	// 执行命令的工作路径
	WorkingDirectory *string `json:"WorkingDirectory,omitnil,omitempty" name:"WorkingDirectory"`

	// 日志上传的cos bucket 地址。
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 日志在cos bucket中的目录。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

type InvocationTask

type InvocationTask struct {
	// 执行活动ID。
	InvocationId *string `json:"InvocationId,omitnil,omitempty" name:"InvocationId"`

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

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

	// 执行任务状态。取值范围:
	//
	// <ul> <li>PENDING:等待下发</li> <li>DELIVERING:下发中</li> <li>DELIVER_DELAYED:延时下发</li> <li>DELIVER_FAILED:下发失败</li> <li>START_FAILED:命令启动失败</li> <li>RUNNING:命令运行中</li> <li>SUCCESS:命令成功</li> <li>FAILED:命令执行失败,执行完退出码不为 0</li> <li>TIMEOUT:命令超时</li> <li>TASK_TIMEOUT:执行任务超时</li> <li>CANCELLING:取消中</li> <li>CANCELLED:已取消(命令启动前就被取消)</li> <li>TERMINATED:已中止(命令执行期间被取消)</li> </ul>
	TaskStatus *string `json:"TaskStatus,omitnil,omitempty" name:"TaskStatus"`

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

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

	// 执行任务开始时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 执行任务结束时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

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

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

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

	// 执行任务失败时的错误信息。
	ErrorInfo *string `json:"ErrorInfo,omitnil,omitempty" name:"ErrorInfo"`

	// 调用来源。
	InvocationSource *string `json:"InvocationSource,omitnil,omitempty" name:"InvocationSource"`
}

type InvocationTaskBasicInfo

type InvocationTaskBasicInfo struct {
	// 执行任务ID。
	InvocationTaskId *string `json:"InvocationTaskId,omitnil,omitempty" name:"InvocationTaskId"`

	// 执行任务状态。取值范围:
	// <li> PENDING:等待下发
	// <li> DELIVERING:下发中
	// <li> DELIVER_DELAYED:延时下发
	// <li> DELIVER_FAILED:下发失败
	// <li> START_FAILED:命令启动失败
	// <li> RUNNING:命令运行中
	// <li> SUCCESS:命令成功
	// <li> FAILED:命令执行失败,执行完退出码不为 0
	// <li> TIMEOUT:命令超时
	// <li> TASK_TIMEOUT:执行任务超时
	// <li> CANCELLING:取消中
	// <li> CANCELLED:已取消(命令启动前就被取消)
	// <li> TERMINATED:已中止(命令执行期间被取消)
	TaskStatus *string `json:"TaskStatus,omitnil,omitempty" name:"TaskStatus"`

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

type InvokeCommandRequest

type InvokeCommandRequest struct {
	*tchttp.BaseRequest

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

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

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

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。若不填,默认以 Command 配置的 Username 执行。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 命令执行路径, 默认以Command配置的WorkingDirectory执行。
	WorkingDirectory *string `json:"WorkingDirectory,omitnil,omitempty" name:"WorkingDirectory"`

	// 命令超时时间,取值范围[1, 86400]。默认以Command配置的Timeout执行。
	Timeout *uint64 `json:"Timeout,omitnil,omitempty" name:"Timeout"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewInvokeCommandRequest

func NewInvokeCommandRequest() (request *InvokeCommandRequest)

func (*InvokeCommandRequest) FromJsonString

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

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

func (*InvokeCommandRequest) ToJsonString

func (r *InvokeCommandRequest) ToJsonString() string

type InvokeCommandRequestParams added in v1.0.426

type InvokeCommandRequestParams struct {
	// 待触发的命令ID。
	CommandId *string `json:"CommandId,omitnil,omitempty" name:"CommandId"`

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

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

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。若不填,默认以 Command 配置的 Username 执行。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 命令执行路径, 默认以Command配置的WorkingDirectory执行。
	WorkingDirectory *string `json:"WorkingDirectory,omitnil,omitempty" name:"WorkingDirectory"`

	// 命令超时时间,取值范围[1, 86400]。默认以Command配置的Timeout执行。
	Timeout *uint64 `json:"Timeout,omitnil,omitempty" name:"Timeout"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

Predefined struct for user

type InvokeCommandResponse

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

func NewInvokeCommandResponse

func NewInvokeCommandResponse() (response *InvokeCommandResponse)

func (*InvokeCommandResponse) FromJsonString

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

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

func (*InvokeCommandResponse) ToJsonString

func (r *InvokeCommandResponse) ToJsonString() string

type InvokeCommandResponseParams added in v1.0.426

type InvokeCommandResponseParams struct {
	// 执行活动ID。
	InvocationId *string `json:"InvocationId,omitnil,omitempty" name:"InvocationId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Invoker added in v1.0.256

type Invoker struct {
	// 执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`

	// 执行器名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 执行器类型。
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

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

	// 用户名。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

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

	// 实例ID列表。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 执行器是否启用。
	Enable *bool `json:"Enable,omitnil,omitempty" name:"Enable"`

	// 执行器周期计划。周期执行器会返回此字段。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitnil,omitempty" name:"ScheduleSettings"`

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

	// 修改时间。
	UpdatedTime *string `json:"UpdatedTime,omitnil,omitempty" name:"UpdatedTime"`
}

type InvokerRecord added in v1.0.256

type InvokerRecord struct {
	// 执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`

	// 执行时间。
	InvokeTime *string `json:"InvokeTime,omitnil,omitempty" name:"InvokeTime"`

	// 执行原因。
	Reason *string `json:"Reason,omitnil,omitempty" name:"Reason"`

	// 命令执行ID。
	InvocationId *string `json:"InvocationId,omitnil,omitempty" name:"InvocationId"`

	// 触发结果。
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`
}

type ModifyCommandRequest

type ModifyCommandRequest struct {
	*tchttp.BaseRequest

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

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

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

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

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

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

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

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

	// 自定义参数数组。
	// 如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
	// 自定义参数最多20个。
	DefaultParameterConfs []*DefaultParameterConf `json:"DefaultParameterConfs,omitnil,omitempty" name:"DefaultParameterConfs"`

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewModifyCommandRequest

func NewModifyCommandRequest() (request *ModifyCommandRequest)

func (*ModifyCommandRequest) FromJsonString

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

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

func (*ModifyCommandRequest) ToJsonString

func (r *ModifyCommandRequest) ToJsonString() string

type ModifyCommandRequestParams added in v1.0.426

type ModifyCommandRequestParams struct {
	// 命令ID。
	CommandId *string `json:"CommandId,omitnil,omitempty" name:"CommandId"`

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

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

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

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

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

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

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

	// 自定义参数数组。
	// 如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。
	// 自定义参数最多20个。
	DefaultParameterConfs []*DefaultParameterConf `json:"DefaultParameterConfs,omitnil,omitempty" name:"DefaultParameterConfs"`

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

Predefined struct for user

type ModifyCommandResponse

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

func NewModifyCommandResponse

func NewModifyCommandResponse() (response *ModifyCommandResponse)

func (*ModifyCommandResponse) FromJsonString

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

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

func (*ModifyCommandResponse) ToJsonString

func (r *ModifyCommandResponse) ToJsonString() string

type ModifyCommandResponseParams added in v1.0.426

type ModifyCommandResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyInvokerRequest added in v1.0.256

type ModifyInvokerRequest struct {
	*tchttp.BaseRequest

	// 待修改的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`

	// 待修改的执行器名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 待修改的命令ID。
	CommandId *string `json:"CommandId,omitnil,omitempty" name:"CommandId"`

	// 待修改的用户名。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 待修改的自定义参数。
	Parameters *string `json:"Parameters,omitnil,omitempty" name:"Parameters"`

	// 待修改的实例ID列表。列表长度上限100。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 待修改的周期执行器设置。
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitnil,omitempty" name:"ScheduleSettings"`
}

func NewModifyInvokerRequest added in v1.0.256

func NewModifyInvokerRequest() (request *ModifyInvokerRequest)

func (*ModifyInvokerRequest) FromJsonString added in v1.0.256

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

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

func (*ModifyInvokerRequest) ToJsonString added in v1.0.256

func (r *ModifyInvokerRequest) ToJsonString() string

type ModifyInvokerRequestParams added in v1.0.426

type ModifyInvokerRequestParams struct {
	// 待修改的执行器ID。
	InvokerId *string `json:"InvokerId,omitnil,omitempty" name:"InvokerId"`

	// 待修改的执行器名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 执行器类型,当前仅支持周期类型执行器,取值:`SCHEDULE` 。
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 待修改的命令ID。
	CommandId *string `json:"CommandId,omitnil,omitempty" name:"CommandId"`

	// 待修改的用户名。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 待修改的自定义参数。
	Parameters *string `json:"Parameters,omitnil,omitempty" name:"Parameters"`

	// 待修改的实例ID列表。列表长度上限100。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 待修改的周期执行器设置。
	ScheduleSettings *ScheduleSettings `json:"ScheduleSettings,omitnil,omitempty" name:"ScheduleSettings"`
}

Predefined struct for user

type ModifyInvokerResponse added in v1.0.256

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

func NewModifyInvokerResponse added in v1.0.256

func NewModifyInvokerResponse() (response *ModifyInvokerResponse)

func (*ModifyInvokerResponse) FromJsonString added in v1.0.256

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

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

func (*ModifyInvokerResponse) ToJsonString added in v1.0.256

func (r *ModifyInvokerResponse) ToJsonString() string

type ModifyInvokerResponseParams added in v1.0.426

type ModifyInvokerResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyRegisterInstanceRequest added in v1.0.730

type ModifyRegisterInstanceRequest struct {
	*tchttp.BaseRequest

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

	// 实例名。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`
}

func NewModifyRegisterInstanceRequest added in v1.0.730

func NewModifyRegisterInstanceRequest() (request *ModifyRegisterInstanceRequest)

func (*ModifyRegisterInstanceRequest) FromJsonString added in v1.0.730

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

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

func (*ModifyRegisterInstanceRequest) ToJsonString added in v1.0.730

func (r *ModifyRegisterInstanceRequest) ToJsonString() string

type ModifyRegisterInstanceRequestParams added in v1.0.730

type ModifyRegisterInstanceRequestParams struct {
	// 实例ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 实例名。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`
}

Predefined struct for user

type ModifyRegisterInstanceResponse added in v1.0.730

type ModifyRegisterInstanceResponse struct {
	*tchttp.BaseResponse
	Response *ModifyRegisterInstanceResponseParams `json:"Response"`
}

func NewModifyRegisterInstanceResponse added in v1.0.730

func NewModifyRegisterInstanceResponse() (response *ModifyRegisterInstanceResponse)

func (*ModifyRegisterInstanceResponse) FromJsonString added in v1.0.730

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

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

func (*ModifyRegisterInstanceResponse) ToJsonString added in v1.0.730

func (r *ModifyRegisterInstanceResponse) ToJsonString() string

type ModifyRegisterInstanceResponseParams added in v1.0.730

type ModifyRegisterInstanceResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

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,omitnil,omitempty" name:"Parameters"`

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

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

func NewPreviewReplacedCommandContentRequest

func NewPreviewReplacedCommandContentRequest() (request *PreviewReplacedCommandContentRequest)

func (*PreviewReplacedCommandContentRequest) FromJsonString

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

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

func (*PreviewReplacedCommandContentRequest) ToJsonString

func (r *PreviewReplacedCommandContentRequest) ToJsonString() string

type PreviewReplacedCommandContentRequestParams added in v1.0.426

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

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

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

Predefined struct for user

type PreviewReplacedCommandContentResponse

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

func NewPreviewReplacedCommandContentResponse

func NewPreviewReplacedCommandContentResponse() (response *PreviewReplacedCommandContentResponse)

func (*PreviewReplacedCommandContentResponse) FromJsonString

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

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

func (*PreviewReplacedCommandContentResponse) ToJsonString

type PreviewReplacedCommandContentResponseParams added in v1.0.426

type PreviewReplacedCommandContentResponseParams struct {
	// 自定义参数替换后的,经Base64编码的命令内容。
	ReplacedContent *string `json:"ReplacedContent,omitnil,omitempty" name:"ReplacedContent"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RegionInfo

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

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

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

type RegisterCodeInfo added in v1.0.730

type RegisterCodeInfo struct {
	// 注册码ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RegisterCodeId *string `json:"RegisterCodeId,omitnil,omitempty" name:"RegisterCodeId"`

	// 注册码描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 注册实例名称前缀。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceNamePrefix *string `json:"InstanceNamePrefix,omitnil,omitempty" name:"InstanceNamePrefix"`

	// 该注册码允许注册的实例数目。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RegisterLimit *int64 `json:"RegisterLimit,omitnil,omitempty" name:"RegisterLimit"`

	// 该注册码的过期时间,按照 ISO8601 标准表示,并且使用 UTC 时间。
	// 格式为: YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ExpiredTime *string `json:"ExpiredTime,omitnil,omitempty" name:"ExpiredTime"`

	// 该注册码限制tat_agent只能从IpAddressRange所描述公网出口进行注册。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IpAddressRange *string `json:"IpAddressRange,omitnil,omitempty" name:"IpAddressRange"`

	// 该注册码是否可用。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Enabled *bool `json:"Enabled,omitnil,omitempty" name:"Enabled"`

	// 该注册码已注册数目。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RegisteredCount *int64 `json:"RegisteredCount,omitnil,omitempty" name:"RegisteredCount"`

	// 注册码创建时间,按照 ISO8601 标准表示,并且使用 UTC 时间。
	// 格式为: YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 注册码最近一次更新时间,按照 ISO8601 标准表示,并且使用 UTC 时间。
	// 格式为: YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpdatedTime *string `json:"UpdatedTime,omitnil,omitempty" name:"UpdatedTime"`
}

type RegisterInstanceInfo added in v1.0.730

type RegisterInstanceInfo struct {
	// 注册码ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RegisterCodeId *string `json:"RegisterCodeId,omitnil,omitempty" name:"RegisterCodeId"`

	// 实例ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 实例名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 机器ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MachineId *string `json:"MachineId,omitnil,omitempty" name:"MachineId"`

	// 系统名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SystemName *string `json:"SystemName,omitnil,omitempty" name:"SystemName"`

	// 主机名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	HostName *string `json:"HostName,omitnil,omitempty" name:"HostName"`

	// 内网IP。
	// 注意:此字段可能返回 null,表示取不到有效值。
	LocalIp *string `json:"LocalIp,omitnil,omitempty" name:"LocalIp"`

	// 公钥。
	// 注意:此字段可能返回 null,表示取不到有效值。
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// 托管状态。
	// 返回Online表示实例正在托管,返回Offline表示实例未托管。
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 创建时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 上次更新时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpdatedTime *string `json:"UpdatedTime,omitnil,omitempty" name:"UpdatedTime"`
}

type RunCommandRequest

type RunCommandRequest struct {
	*tchttp.BaseRequest

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

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

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

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

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

	// 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
	WorkingDirectory *string `json:"WorkingDirectory,omitnil,omitempty" name:"WorkingDirectory"`

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

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

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

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

	// 自定义参数数组。 如果 Parameters 未提供,将使用这里的默认值进行替换。 自定义参数最多20个。
	DefaultParameterConfs []*DefaultParameterConf `json:"DefaultParameterConfs,omitnil,omitempty" name:"DefaultParameterConfs"`

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

	// 如果保存命令,可为命令设置标签。列表长度不超过10。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在 Linux 实例中以 root 用户执行命令;在Windows 实例中以 System 用户执行命令。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

func NewRunCommandRequest

func NewRunCommandRequest() (request *RunCommandRequest)

func (*RunCommandRequest) FromJsonString

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

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

func (*RunCommandRequest) ToJsonString

func (r *RunCommandRequest) ToJsonString() string

type RunCommandRequestParams added in v1.0.426

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

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

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

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

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

	// 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
	WorkingDirectory *string `json:"WorkingDirectory,omitnil,omitempty" name:"WorkingDirectory"`

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

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

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

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

	// 自定义参数数组。 如果 Parameters 未提供,将使用这里的默认值进行替换。 自定义参数最多20个。
	DefaultParameterConfs []*DefaultParameterConf `json:"DefaultParameterConfs,omitnil,omitempty" name:"DefaultParameterConfs"`

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

	// 如果保存命令,可为命令设置标签。列表长度不超过10。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 在 CVM 或 Lighthouse 实例中执行命令的用户名称。
	// 使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在 Linux 实例中以 root 用户执行命令;在Windows 实例中以 System 用户执行命令。
	Username *string `json:"Username,omitnil,omitempty" name:"Username"`

	// 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com
	OutputCOSBucketUrl *string `json:"OutputCOSBucketUrl,omitnil,omitempty" name:"OutputCOSBucketUrl"`

	// 指定日志在cos bucket中的目录,目录命名有如下规则:
	// 1. 可用数字、中英文和可见字符的组合,长度最多为60。
	// 2. 用 / 分割路径,可快速创建子目录。
	// 3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。
	OutputCOSKeyPrefix *string `json:"OutputCOSKeyPrefix,omitnil,omitempty" name:"OutputCOSKeyPrefix"`
}

Predefined struct for user

type RunCommandResponse

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

func NewRunCommandResponse

func NewRunCommandResponse() (response *RunCommandResponse)

func (*RunCommandResponse) FromJsonString

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

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

func (*RunCommandResponse) ToJsonString

func (r *RunCommandResponse) ToJsonString() string

type RunCommandResponseParams added in v1.0.426

type RunCommandResponseParams struct {
	// 命令ID。
	CommandId *string `json:"CommandId,omitnil,omitempty" name:"CommandId"`

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

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ScheduleSettings added in v1.0.256

type ScheduleSettings struct {
	// 执行策略:
	// <br><li>ONCE:单次执行
	// <br><li>RECURRENCE:周期执行
	Policy *string `json:"Policy,omitnil,omitempty" name:"Policy"`

	// 触发 Crontab 表达式。Policy 为 RECURRENCE 时,需要指定此字段。Crontab 按北京时间解析。
	Recurrence *string `json:"Recurrence,omitnil,omitempty" name:"Recurrence"`

	// 执行器下次执行时间。Policy 为 ONCE 时,需要指定此字段。
	InvokeTime *string `json:"InvokeTime,omitnil,omitempty" name:"InvokeTime"`
}

type Tag

type Tag struct {
	// 标签键。
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`

	// 标签值。
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type TaskResult

type TaskResult struct {
	// 命令执行ExitCode。
	ExitCode *int64 `json:"ExitCode,omitnil,omitempty" name:"ExitCode"`

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

	// 命令执行开始时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ExecStartTime *string `json:"ExecStartTime,omitnil,omitempty" name:"ExecStartTime"`

	// 命令执行结束时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ExecEndTime *string `json:"ExecEndTime,omitnil,omitempty" name:"ExecEndTime"`

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

	// 日志在cos中的地址
	OutputUrl *string `json:"OutputUrl,omitnil,omitempty" name:"OutputUrl"`

	// 日志上传cos的错误信息。
	OutputUploadCOSErrorInfo *string `json:"OutputUploadCOSErrorInfo,omitnil,omitempty" name:"OutputUploadCOSErrorInfo"`
}

Jump to

Keyboard shortcuts

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