tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
943 lines (862 loc) • 54.5 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 自动化助手客户端信息 */
declare interface AutomationAgentInfo {
/** 实例ID。 */
InstanceId?: string;
/** Agent 版本号。 */
Version?: string;
/** 上次心跳时间 */
LastHeartbeatTime?: string;
/** Agent状态,取值范围:Online:在线,Offline:离线 */
AgentStatus?: string;
/** Agent运行环境,取值范围:Linux:Linux实例Windows:Windows实例 */
Environment?: string;
/** Agent 支持的功能列表。 */
SupportFeatures?: string[];
}
/** 命令详情。 */
declare interface Command {
/** 命令ID。 */
CommandId?: string;
/** 命令名称。 */
CommandName?: string;
/** 命令描述。 */
Description?: string;
/** Base64编码后的命令内容。 */
Content?: string;
/** 命令类型。取值为 SHELL、POWERSHELL、BAT 之一。 */
CommandType?: string;
/** 命令执行路径。 */
WorkingDirectory?: string;
/** 命令超时时间。 */
Timeout?: number;
/** 命令创建时间。格式为:YYYY-MM-DDThh:mm:ssZ */
CreatedTime?: string;
/** 命令更新时间。格式为:YYYY-MM-DDThh:mm:ssZ */
UpdatedTime?: string;
/** 是否启用自定义参数功能。 */
EnableParameter?: boolean;
/** 自定义参数的默认取值。 */
DefaultParameters?: string;
/** 自定义参数的默认取值。 */
DefaultParameterConfs?: DefaultParameterConf[];
/** 命令关联的场景 */
Scenes?: string[];
/** 命令的结构化描述。公共命令有值,用户命令为空字符串。 */
FormattedDescription?: string;
/** 命令创建者。TAT 代表公共命令,USER 代表个人命令。 */
CreatedBy?: string;
/** 命令关联的标签列表。 */
Tags?: Tag[];
/** 在实例上执行命令的用户名。 */
Username?: string;
/** 日志上传的cos bucket 地址。 */
OutputCOSBucketUrl?: string;
/** 日志在cos bucket中的目录。 */
OutputCOSKeyPrefix?: string;
}
/** 命令执行详情。 */
declare interface CommandDocument {
/** Base64 编码后的执行命令。 */
Content?: string;
/** 命令类型。取值为 SHELL、POWERSHELL、BAT 之一。 */
CommandType?: string;
/** 超时时间。单位:秒。 */
Timeout?: number;
/** 执行路径。 */
WorkingDirectory?: string;
/** 执行用户。 */
Username?: string;
/** 保存输出的 COS Bucket 链接。 */
OutputCOSBucketUrl?: string;
/** 保存输出的文件名称前缀。 */
OutputCOSKeyPrefix?: string;
}
/** 自定义参数。 */
declare interface DefaultParameterConf {
/** 参数名。 */
ParameterName: string;
/** 参数默认值。 */
ParameterValue: string;
/** 参数描述。 */
ParameterDescription?: string;
}
/** > 描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等> - 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。> - 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。> > 以[DescribeCommands](https://cloud.tencent.com/document/api/1340/52681)接口的`Filters`为例。若我们需要查询命令名称(`command-name`)为 “打印工作目录” ***并且*** 命令类型(`command-type`)为 “POWERSHELL” ***或者*** “BAT” 时,可如下实现:```Filters.0.Name=command-name&Filters.0.Values.0=打印工作目录&Filters.1.Name=command-type&Filters.1.Values.0=POWERSHELL&Filters.1.Values.1=BAT``` */
declare interface Filter {
/** 需要过滤的字段。 */
Name: string;
/** 字段的过滤值。 */
Values: string[];
}
/** 用户配额信息。 */
declare interface GeneralResourceQuotaSet {
/** 资源名称取值为:- COMMAND:命令- REGISTER_CODE:托管实例注册码 */
ResourceName?: string;
/** 已使用额度 */
ResourceQuotaUsed?: number;
/** 总额度 */
ResourceQuotaTotal?: number;
}
/** 执行活动详情。 */
declare interface Invocation {
/** 执行活动ID。 */
InvocationId?: string;
/** 命令ID。 */
CommandId?: string;
/** 执行的命令的名称 */
CommandName?: string;
/** 执行任务状态。取值范围:- PENDING:等待下发- RUNNING:命令运行中- CANCELLING:取消中- SUCCESS:命令成功- TIMEOUT:命令超时- FAILED:命令失败- CANCELLED:命令全部取消- PARTIAL_FAILED:命令部分失败- PARTIAL_CANCELLED:命令部分取消 */
InvocationStatus?: string;
/** 执行任务信息列表。 */
InvocationTaskBasicInfoSet?: InvocationTaskBasicInfo[];
/** 执行活动描述。 */
Description?: string;
/** 执行活动开始时间。格式为:YYYY-MM-DDThh:mm:ssZ */
StartTime?: string;
/** 执行活动结束时间。格式为:YYYY-MM-DDThh:mm:ssZ */
EndTime?: string;
/** 执行活动创建时间。格式为:YYYY-MM-DDThh:mm:ssZ */
CreatedTime?: string;
/** 执行活动更新时间。格式为:YYYY-MM-DDThh:mm:ssZ */
UpdatedTime?: string;
/** 自定义参数取值。 */
Parameters?: string;
/** 自定义参数的默认取值。 */
DefaultParameters?: string;
/** 执行命令的实例类型,取值范围:CVM、LIGHTHOUSE。 */
InstanceKind?: string;
/** 在实例上执行命令时使用的用户名。 */
Username?: string;
/** 调用来源。- USER:来源于用户调用。- INVOKER:来源于定时执行。 */
InvocationSource?: string;
/** base64编码的命令内容 */
CommandContent?: string;
/** 命令类型 */
CommandType?: string;
/** 执行命令过期时间, 单位秒 */
Timeout?: number;
/** 执行命令的工作路径 */
WorkingDirectory?: string;
/** 日志上传的cos bucket 地址。 */
OutputCOSBucketUrl?: string;
/** 日志在cos bucket中的目录。 */
OutputCOSKeyPrefix?: string;
}
/** 执行任务。 */
declare interface InvocationTask {
/** 执行活动ID。 */
InvocationId?: string;
/** 执行任务ID。 */
InvocationTaskId?: string;
/** 命令ID。 */
CommandId?: string;
/** 执行任务状态。取值范围:- PENDING:等待下发- DELIVERING:下发中- DELIVER_DELAYED:延时下发- DELIVER_FAILED:下发失败- START_FAILED:命令启动失败- RUNNING:命令运行中- SUCCESS:命令成功- FAILED:命令执行失败,执行完退出码不为 0- TIMEOUT:命令超时- TASK_TIMEOUT:客户端无响应- CANCELLING:取消中- CANCELLED:已取消(命令启动前就被取消)- TERMINATED:已中止(命令执行期间被取消) */
TaskStatus?: string;
/** 实例ID。 */
InstanceId?: string;
/** 执行结果。 */
TaskResult?: TaskResult;
/** 执行任务开始时间。格式为:YYYY-MM-DDThh:mm:ssZ */
StartTime?: string | null;
/** 执行任务结束时间。格式为:YYYY-MM-DDThh:mm:ssZ */
EndTime?: string | null;
/** 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ */
CreatedTime?: string;
/** 更新时间。格式为:YYYY-MM-DDThh:mm:ssZ */
UpdatedTime?: string;
/** 执行任务所执行的命令详情。 */
CommandDocument?: CommandDocument;
/** 执行任务失败时的错误信息。 */
ErrorInfo?: string;
/** 调用来源。- USER:来源于用户调用。- INVOKER:来源于定时执行。 */
InvocationSource?: string;
}
/** 执行活动任务简介。 */
declare interface InvocationTaskBasicInfo {
/** 执行任务ID。 */
InvocationTaskId?: string;
/** 执行任务状态。取值范围:- PENDING:等待下发- DELIVERING:下发中- DELIVER_DELAYED:延时下发- DELIVER_FAILED:下发失败- START_FAILED:命令启动失败- RUNNING:命令运行中- SUCCESS:命令成功- FAILED:命令执行失败,执行完退出码不为 0- TIMEOUT:命令超时- TASK_TIMEOUT:客户端无响应- CANCELLING:取消中- CANCELLED:已取消(命令启动前就被取消)- TERMINATED:已中止(命令执行期间被取消) */
TaskStatus?: string;
/** 实例ID。 */
InstanceId?: string;
}
/** 执行器信息。 */
declare interface Invoker {
/** 执行器ID。 */
InvokerId?: string;
/** 执行器名称。 */
Name?: string;
/** 执行器类型。目前仅支持 SCHEDULE 一种。 */
Type?: string;
/** 命令ID。 */
CommandId?: string;
/** 用户名。 */
Username?: string;
/** 自定义参数。 */
Parameters?: string;
/** 实例ID列表。 */
InstanceIds?: string[];
/** 执行器是否启用。 */
Enable?: boolean;
/** 执行器周期计划。周期执行器会返回此字段。 */
ScheduleSettings?: ScheduleSettings;
/** 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ */
CreatedTime?: string;
/** 修改时间。格式为:YYYY-MM-DDThh:mm:ssZ */
UpdatedTime?: string;
}
/** 执行器执行记录。 */
declare interface InvokerRecord {
/** 执行器ID。 */
InvokerId?: string;
/** 执行时间。格式为:YYYY-MM-DDThh:mm:ssZ */
InvokeTime?: string;
/** 执行原因。 */
Reason?: string;
/** 命令执行ID。 */
InvocationId?: string;
/** 触发结果。- PENDING:等待下发- RUNNING:命令运行中- CANCELLING:取消中- SUCCESS:命令成功- TIMEOUT:命令超时- FAILED:命令失败- CANCELLED:命令全部取消- PARTIAL_FAILED:命令部分失败- PARTIAL_CANCELLED:命令部分取消 */
Result?: string;
}
/** 描述单个地域信息 */
declare interface RegionInfo {
/** 地域名称,例如,ap-guangzhou */
Region?: string;
/** 地域描述,例如: 广州 */
RegionName?: string;
/** 地域是否可用状态,AVAILABLE 代表可用,UNAVAILABLE 代表不可用。 */
RegionState?: string;
}
/** 注册码信息。 */
declare interface RegisterCodeInfo {
/** 注册码ID。 */
RegisterCodeId?: string;
/** 注册码描述。 */
Description?: string;
/** 注册实例名称前缀。 */
InstanceNamePrefix?: string;
/** 该注册码允许注册的实例数目。 */
RegisterLimit?: number;
/** 该注册码的过期时间,按照 ISO8601 标准表示,并且使用 UTC 时间。 格式为: YYYY-MM-DDThh:mm:ssZ。 */
ExpiredTime?: string;
/** 该注册码限制tat_agent只能从IpAddressRange所描述公网出口进行注册。 */
IpAddressRange?: string;
/** 该注册码是否可用。 */
Enabled?: boolean;
/** 该注册码已注册数目。 */
RegisteredCount?: number;
/** 注册码创建时间,按照 ISO8601 标准表示,并且使用 UTC 时间。 格式为: YYYY-MM-DDThh:mm:ssZ。 */
CreatedTime?: string;
/** 注册码最近一次更新时间,按照 ISO8601 标准表示,并且使用 UTC 时间。 格式为: YYYY-MM-DDThh:mm:ssZ。 */
UpdatedTime?: string;
}
/** 注册实例信息。 */
declare interface RegisterInstanceInfo {
/** 注册码ID。 */
RegisterCodeId?: string;
/** 托管实例ID。 */
InstanceId?: string;
/** 托管实例名。 */
InstanceName?: string;
/** 机器ID。 */
MachineId?: string;
/** 系统名。取值:Linux | Windows。 */
SystemName?: string;
/** 主机名。 */
HostName?: string;
/** 内网IP。 */
LocalIp?: string;
/** 公钥。 */
PublicKey?: string;
/** 托管状态。返回Online表示实例正在托管,返回Offline表示实例未托管。 */
Status?: string;
/** 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ */
CreatedTime?: string;
/** 上次更新时间。格式为:YYYY-MM-DDThh:mm:ssZ */
UpdatedTime?: string;
/** 标签 */
Tags?: Tag[];
}
/** 场景详情。 */
declare interface Scene {
/** 场景 ID 。 */
SceneId?: string;
/** 场景名称。 */
SceneName?: string;
/** 场景创建者。- TAT:公共场景 */
CreatedBy?: string;
/** 创建时间。格式为:YYYY-MM-DDThh:mm:ssZ */
CreatedTime?: string;
/** 更新时间。格式为:YYYY-MM-DDThh:mm:ssZ */
UpdatedTime?: string;
}
/** 周期执行器设置。 */
declare interface ScheduleSettings {
/** 执行策略:- ONCE:单次执行- RECURRENCE:周期执行 */
Policy: string;
/** 触发 Crontab 表达式。Policy 为 RECURRENCE 时,需要指定此字段。Crontab 按北京时间解析。 */
Recurrence?: string;
/** 执行器下次执行时间。Policy 为 ONCE 时,需要指定此字段。时间格式为:YYYY-MM-DDThh:mm:ssZ */
InvokeTime?: string;
}
/** 标签 */
declare interface Tag {
/** 标签键。 */
Key: string;
/** 标签值。 */
Value: string;
}
/** 任务结果。 */
declare interface TaskResult {
/** 命令执行ExitCode。 */
ExitCode?: number;
/** Base64编码后的命令输出。最大长度24KB。 */
Output?: string;
/** 命令执行开始时间。格式为:YYYY-MM-DDThh:mm:ssZ */
ExecStartTime?: string | null;
/** 命令执行结束时间。格式为:YYYY-MM-DDThh:mm:ssZ */
ExecEndTime?: string | null;
/** 命令最终输出被截断的字节数。 */
Dropped?: number;
/** 日志在cos中的地址 */
OutputUrl?: string;
/** 日志上传cos的错误信息。 */
OutputUploadCOSErrorInfo?: string;
}
declare interface CancelInvocationRequest {
/** 执行活动ID。可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。 */
InvocationId: string;
/** 实例ID列表,上限100。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:- CVM- Lighthouse- TAT 托管实例 */
InstanceIds?: string[];
}
declare interface CancelInvocationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCommandRequest {
/** 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。 */
CommandName: string;
/** Base64编码后的命令内容,长度不可超过64KB。 */
Content: string;
/** 命令描述。不超过120字符。 */
Description?: string;
/** 命令类型,目前支持取值:SHELL、POWERSHELL、BAT。默认:SHELL。 */
CommandType?: string;
/** 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。 */
WorkingDirectory?: string;
/** 命令超时时间,默认60秒。取值范围[1, 86400]。 */
Timeout?: number;
/** 是否启用自定义参数功能。一旦创建,此值不提供修改。默认值:false。 */
EnableParameter?: boolean;
/** 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。仅在 EnableParameter 参数为 true 时,才允许设置此参数。自定义参数最多20个。自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。 */
DefaultParameters?: string;
/** 自定义参数数组。如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。仅在 EnableParameter 参数为 true 时,才允许设置此参数。自定义参数最多20个。 */
DefaultParameterConfs?: DefaultParameterConf[];
/** 为命令关联的标签,列表长度不超过10。 */
Tags?: Tag[];
/** 在 CVM 或 Lighthouse 实例中执行命令的用户名称。使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在 Linux 实例中以 root 用户执行命令;在Windows 实例中以 System 用户执行命令。 */
Username?: string;
/** 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。 */
OutputCOSBucketUrl?: string;
/** 指定日志在cos bucket中的目录,目录命名有如下规则:1. 可用数字、中英文和可见字符的组合,长度最多为60。2. 用 / 分割路径,可快速创建子目录。3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称 */
OutputCOSKeyPrefix?: string;
}
declare interface CreateCommandResponse {
/** 命令ID。 */
CommandId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateInvokerRequest {
/** 执行器名称。长度不超过 120 字符。 */
Name: string;
/** 执行器类型。可选取值(当前仅支持一种):- `SCHEDULE`:周期类型执行器。 */
Type: string;
/** 远程命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 */
CommandId: string;
/** 触发器关联的实例ID。列表上限 100。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。 */
InstanceIds: string[];
/** 命令执行用户。长度不超过 256 字符。 */
Username?: string;
/** 命令自定义参数。字段类型为 JSON encode string。仅在 CommandId 所指命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 */
Parameters?: string;
/** 周期执行器设置。当执行器类型为 `SCHEDULE` 时,必须指定此参数。 */
ScheduleSettings?: ScheduleSettings;
}
declare interface CreateInvokerResponse {
/** 执行器ID。 */
InvokerId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateRegisterCodeRequest {
/** 注册码描述。最大长度为 128 字符。 */
Description?: string;
/** 注册实例名称前缀。最大长度为 32 字符。 */
InstanceNamePrefix?: string;
/** 该注册码允许注册的实例数目。默认值为 10,最小值为 1,最大值为 10000。 */
RegisterLimit?: number;
/** 该注册码的有效时间,单位为小时。默认值为 4。- 若传入值小于等于 99999,则以小时为单位设置有效时间。- 若传入值大于 99999,则设置为长期有效。 */
EffectiveTime?: number;
/** 限制注册码只能从 IpAddressRange 所描述公网出口进行注册。默认为空,即无任何限制。取值应为标准 IPv4 或 CIDRv4 格式。例如 192.168.1.1 或 192.168.0.0/16。 */
IpAddressRange?: string;
}
declare interface CreateRegisterCodeResponse {
/** 注册码ID。 */
RegisterCodeId?: string;
/** 注册码值。 */
RegisterCodeValue?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteCommandRequest {
/** 待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 */
CommandId: string;
}
declare interface DeleteCommandResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteCommandsRequest {
/** 待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 */
CommandIds: string[];
}
declare interface DeleteCommandsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteInvokerRequest {
/** 待删除的执行器ID。可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。 */
InvokerId: string;
}
declare interface DeleteInvokerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteRegisterCodesRequest {
/** 注册码ID列表。限制输入的注册码ID数量大于0小于100。可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。 */
RegisterCodeIds: string[];
}
declare interface DeleteRegisterCodesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteRegisterInstanceRequest {
/** 托管实例ID。可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。 */
InstanceId: string;
}
declare interface DeleteRegisterInstanceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAutomationAgentStatusRequest {
/** 待查询的实例ID列表。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。每次请求的上限为 100。参数不支持同时指定 `InstanceIds ` 和 `Filters ` 。 */
InstanceIds?: string[];
/** - agent-status - String - 是否必填:否 -(过滤条件)按照agent状态过滤,取值:Online 在线,Offline 离线。 - environment - String - 是否必填:否 -(过滤条件)按照agent运行环境查询,取值:Linux, Windows。- instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InstanceIds ` 和 `Filters ` 。 */
Filters?: Filter[];
/** 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Limit?: number;
/** 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Offset?: number;
}
declare interface DescribeAutomationAgentStatusResponse {
/** Agent 信息列表。 */
AutomationAgentSet?: AutomationAgentInfo[];
/** 符合条件的 Agent 总数。 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCommandsRequest {
/** 命令ID列表,每次请求的上限为100。参数不支持同时指定 `CommandIds` 和 `Filters` 。 */
CommandIds?: string[];
/** 过滤条件。- command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。- command-name - String - 是否必填:否 -(过滤条件)按照命令名称过滤。- command-type - String - 是否必填:否 -(过滤条件)按照命令类型过滤,取值为 SHELL、POWERSHELL、BAT。- scene-id - String - 是否必填:否 -(过滤条件)按照场景ID过滤。可通过 [DescribeScenes(查询场景)](https://cloud.tencent.com/document/api/1340/109968) 接口获取场景ID。- created-by - String - 是否必填:否 -(过滤条件)按照命令创建者过滤,取值为 TAT 或 USER。TAT 代表公共命令,USER 代表由用户创建的命令。- tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。- tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。- tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例4每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `CommandIds` 和 `Filters` 。 */
Filters?: Filter[];
/** 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Limit?: number;
/** 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Offset?: number;
}
declare interface DescribeCommandsResponse {
/** 符合条件的命令总数。 */
TotalCount?: number;
/** 命令详情列表。 */
CommandSet?: Command[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeInvocationTasksRequest {
/** 执行任务ID列表,每次请求的上限为100。参数不支持同时指定 `InvocationTaskIds` 和 `Filters`。 */
InvocationTaskIds?: string[];
/** 过滤条件。- invocation-task-id - String - 是否必填:否 -(过滤条件)按照执行任务ID过滤。- invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。- instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型: CVM、Lighthouse、TAT 托管实例- command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationTaskIds` 和 `Filters` 。 */
Filters?: Filter[];
/** 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Limit?: number;
/** 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Offset?: number;
/** 是否隐藏命令输出结果,取值范围:- true:隐藏输出- false:不隐藏 默认为 true。 */
HideOutput?: boolean;
}
declare interface DescribeInvocationTasksResponse {
/** 符合条件的执行任务总数。 */
TotalCount?: number;
/** 执行任务列表。 */
InvocationTaskSet?: InvocationTask[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeInvocationsRequest {
/** 执行活动ID列表,每次请求的上限为100。参数不支持同时指定 `InvocationIds` 和 `Filters`。 */
InvocationIds?: string[];
/** 过滤条件。 invocation-id - String - 是否必填:否 -(过滤条件)按照执行活动ID过滤。 command-id - String - 是否必填:否 -(过滤条件)按照命令ID过滤。 command-created-by - String - 是否必填:否 -(过滤条件)按照执行的命令类型过滤,取值为 TAT 或 USER,TAT 代表公共命令,USER 代表由用户创建的命令。 instance-kind - String - 是否必填:否 -(过滤条件)按照运行实例类型过滤,取值为 CVM 或 LIGHTHOUSE,CVM 代表实例为云服务器, LIGHTHOUSE 代表实例为轻量应用服务器。 每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `InvocationIds` 和 `Filters` 。 */
Filters?: Filter[];
/** 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Limit?: number;
/** 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Offset?: number;
}
declare interface DescribeInvocationsResponse {
/** 符合条件的执行活动总数。 */
TotalCount?: number;
/** 执行活动列表。 */
InvocationSet?: Invocation[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeInvokerRecordsRequest {
/** 执行器ID列表。列表上限 100。可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。 */
InvokerIds?: string[];
/** 返回数量,默认为20,最大值为100。 */
Limit?: number;
/** 偏移量,默认为0。 */
Offset?: number;
}
declare interface DescribeInvokerRecordsResponse {
/** 符合条件的历史记录数量。 */
TotalCount?: number;
/** 执行器执行历史记录。 */
InvokerRecordSet?: InvokerRecord[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeInvokersRequest {
/** 执行器 ID 列表。每次请求的上限为 100。参数不支持同时指定 `InvokerIds ` 和 `Filters ` 。 */
InvokerIds?: string[];
/** 过滤条件:- invoker-id - String - 是否必填:否 - (过滤条件)按执行器ID过滤。- command-id - String - 是否必填:否 - (过滤条件)按命令ID过滤。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。- invoker-type - String - 是否必填:否 - (过滤条件)按执行器类型过滤。目前仅支持 SCHEDULE 一种。每次请求的 `Filters` 的上限为 10,`Filter.Values` 的上限为 5。参数不支持同时指定 `InvokerIds` 和 `Filters` 。 */
Filters?: Filter[];
/** 返回数量,默认为20,最大值为100。 */
Limit?: number;
/** 偏移量,默认为0。 */
Offset?: number;
}
declare interface DescribeInvokersResponse {
/** 满足条件的执行器数量。 */
TotalCount?: number;
/** 执行器信息。 */
InvokerSet?: Invoker[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeQuotasRequest {
/** 资源名称取值为:- COMMAND:命令- REGISTER_CODE:托管实例注册码 */
ResourceNames: string[];
}
declare interface DescribeQuotasResponse {
/** 资源额度列表 */
GeneralResourceQuotaSet?: GeneralResourceQuotaSet[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeRegionsRequest {
}
declare interface DescribeRegionsResponse {
/** 地域数量 */
TotalCount?: number;
/** 地域信息列表 */
RegionSet?: RegionInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeRegisterCodesRequest {
/** 注册码ID。每次请求的上限为 100。参数不支持同时指定 `RegisterCodeIds ` 和 `Filters ` 。 */
RegisterCodeIds?: string[];
/** 偏移量,默认为 0。 */
Offset?: number;
/** 返回数量,默认为 20,最大值为 100。 */
Limit?: number;
}
declare interface DescribeRegisterCodesResponse {
/** 查询到的注册码总数。 */
TotalCount?: number;
/** 注册码信息列表。 */
RegisterCodeSet?: RegisterCodeInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeRegisterInstancesRequest {
/** 托管实例 id。每次请求的上限为 100。参数不支持同时指定 `InstanceIds` 和 `Filters` 。 */
InstanceIds?: string[];
/** 过滤器列表。每次请求的 `Filters` 的上限为 10,`Filter.Values` 的上限为 5。参数不支持同时指定 `InstanceIds` 和 `Filters` 。- instance-name按照【托管实例名称】进行过滤。类型:String必选:否- instance-id按照【托管实例ID】进行过滤。类型:String必选:否- register-status按照【托管实例状态】进行过滤,取值:Online | Offline。类型:String必选:否- local-ip按照【托管实例网卡IP】进行过滤。类型:String必选:否- register-code-id按照【托管实例注册码ID】进行过滤。可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。类型:String必选:否- sys-name按照【操作系统类型】进行过滤,取值:Linux | Windows。类型:String必选:否- tag-key按照【标签键】进行过滤。类型:String必选:否- tag-value按照【标签值】进行过滤。类型:String必选:否- tag:tag-key按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。类型:String必选:否例如 Filter 为 {"Name": "tag:key1", "Values": ["v1", "v2"] } ,即查询所有标签为 key1:v1 或 key1:v2 的资源。 */
Filters?: Filter[];
/** 偏移量,默认为 0。 */
Offset?: number;
/** 返回数量,默认为 20,最大值为 100。 */
Limit?: number;
}
declare interface DescribeRegisterInstancesResponse {
/** 该实例注册过的注册码总数。 */
TotalCount?: number;
/** 被托管的实例信息的列表。 */
RegisterInstanceSet?: RegisterInstanceInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeScenesRequest {
/** 场景 ID 数组。每次请求的上限为 100。参数不支持同时指定 `SceneIds ` 和 `Filters ` 。 */
SceneIds?: string[];
/** 过滤条件。- scene-id - String - 是否必填:否 -(过滤条件)按照场景 ID 过滤。- scene-name - String - 是否必填:否 -(过滤条件)按照场景名称过滤。- created-by - String - 是否必填:否 -(过滤条件)按照场景创建者过滤,目前仅支持 TAT,代表公共场景。每次请求的 `Filters` 的上限为10, `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。 */
Filters?: Filter[];
/** 返回数量,默认为20,最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Limit?: number;
/** 偏移量,默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */
Offset?: number;
}
declare interface DescribeScenesResponse {
/** 符合条件的场景总数。 */
TotalCount?: number;
/** 场景详情列表。 */
SceneSet?: Scene[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DisableInvokerRequest {
/** 待停止的执行器ID。可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。 */
InvokerId: string;
}
declare interface DisableInvokerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DisableRegisterCodesRequest {
/** 注册码ID。可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。 */
RegisterCodeIds: string[];
}
declare interface DisableRegisterCodesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface EnableInvokerRequest {
/** 待启用的执行器ID。可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。 */
InvokerId: string;
}
declare interface EnableInvokerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface InvokeCommandRequest {
/** 待触发的命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 */
CommandId: string;
/** 待执行命令的实例ID列表,上限200。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:- CVM- Lighthouse- TAT 托管实例 */
InstanceIds: string[];
/** Command 的自定义参数。字段类型为json encoded string。如:{"varA": "222"}。key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。仅在命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。如果未提供该参数取值,将使用 Command 的 DefaultParameters 或 DefaultParameterConfs 进行替换。自定义参数最多20个。自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。 */
Parameters?: string;
/** 在 CVM 或 Lighthouse 实例中执行命令的用户名称。使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。若不填,默认以 Command 配置的 Username 执行。 */
Username?: string;
/** 命令执行路径, 默认以Command配置的WorkingDirectory执行。 */
WorkingDirectory?: string;
/** 命令超时时间,取值范围[1, 86400]。默认以Command配置的Timeout执行。 */
Timeout?: number;
/** 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。 */
OutputCOSBucketUrl?: string;
/** 指定日志在cos bucket中的目录,目录命名有如下规则:1. 可用数字、中英文和可见字符的组合,长度最多为60。2. 用 / 分割路径,可快速创建子目录。3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。 */
OutputCOSKeyPrefix?: string;
}
declare interface InvokeCommandResponse {
/** 执行活动ID。 */
InvocationId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyCommandRequest {
/** 命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 */
CommandId: string;
/** 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。 */
CommandName?: string;
/** 命令描述。不超过120字符。 */
Description?: string;
/** Base64编码后的命令内容,长度不可超过64KB。 */
Content?: string;
/** 命令类型,目前支持取值:SHELL、POWERSHELL、BAT。 */
CommandType?: string;
/** 命令执行路径。 */
WorkingDirectory?: string;
/** 命令超时时间。取值范围[1, 86400]。 */
Timeout?: number;
/** 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。采取整体全覆盖式修改,即修改时必须提供所有新默认值。仅在命令的 EnableParameter 为 true 时,才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。自定义参数最多20个。自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。 */
DefaultParameters?: string;
/** 自定义参数数组。如果 InvokeCommand 时未提供参数取值,将使用这里的默认值进行替换。参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。仅在命令的 EnableParameter 为 true 时,才允许修改此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。自定义参数最多20个。 */
DefaultParameterConfs?: DefaultParameterConf[];
/** 在 CVM 或 Lighthouse 实例中执行命令的用户名称。使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。 */
Username?: string;
/** 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。 */
OutputCOSBucketUrl?: string;
/** 指定日志在cos bucket中的目录,目录命名有如下规则:1. 可用数字、中英文和可见字符的组合,长度最多为60。2. 用 / 分割路径,可快速创建子目录。3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。 */
OutputCOSKeyPrefix?: string;
}
declare interface ModifyCommandResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyInvokerRequest {
/** 待修改的执行器ID。可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。 */
InvokerId: string;
/** 待修改的执行器名称。长度不超过 120 字符。 */
Name?: string;
/** 待修改的执行器类型。可选取值(当前仅支持一种):- `SCHEDULE`:周期类型执行器。 */
Type?: string;
/** 待修改的命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 */
CommandId?: string;
/** 待修改的用户名。长度不超过 256 字符。 */
Username?: string;
/** 待修改的自定义参数。字段类型为 JSON encode string。仅在 CommandId 所指命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 */
Parameters?: string;
/** 待修改的实例ID列表。列表长度上限100。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:CVM、Lighthouse、TAT 托管实例。实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。 */
InstanceIds?: string[];
/** 待修改的周期执行器设置。要将执行器类型修改为 `SCHEDULE` 时,必须指定此参数。 */
ScheduleSettings?: ScheduleSettings;
}
declare interface ModifyInvokerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyRegisterInstanceRequest {
/** 托管实例ID。可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。 */
InstanceId: string;
/** 实例名称。有效长度为 1~60 字符。 */
InstanceName: string;
}
declare interface ModifyRegisterInstanceResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface PreviewReplacedCommandContentRequest {
/** 本次预览采用的自定义参数。字段类型为 json encoded string,如:{"varA": "222"}。仅在命令的 EnableParameter 为 true 时,才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。如果有设置过 DefaultParameters 或 DefaultParameterConfs,会与 Parameters 进行叠加,优先使用 Parameters 的值。key 为自定义参数名称,value 为该参数的取值。kv 均为字符串型。自定义参数最多 20 个。自定义参数名称需符合以下规范:字符数目上限 64,可选范围【a-zA-Z0-9-_】。如果将预览的 CommandId 设置过 DefaultParameters,本参数可以为空。 */
Parameters?: string;
/** 要进行替换预览的命令。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。CommandId 与 Content,必须且只能提供一个。 */
CommandId?: string;
/** 要预览的命令内容,经 Base64 编码,长度不可超过 64KB。CommandId 与 Content,必须且只能提供一个。 */
Content?: string;
}
declare interface PreviewReplacedCommandContentResponse {
/** 自定义参数替换后的,经Base64编码的命令内容。 */
ReplacedContent?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RunCommandRequest {
/** Base64编码后的命令内容,长度不可超过64KB。 */
Content: string;
/** 待执行命令的实例ID列表,上限200。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型:- CVM- Lighthouse- TAT 托管实例 */
InstanceIds: string[];
/** 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。 */
CommandName?: string;
/** 命令描述。不超过120字符。 */
Description?: string;
/** 命令类型,目前支持取值:SHELL、POWERSHELL、BAT。默认:SHELL。 */
CommandType?: string;
/** 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。 */
WorkingDirectory?: string;
/** 命令超时时间,默认60秒。取值范围[1, 86400]。 */
Timeout?: number;
/** 是否保存命令,取值范围: true:保存 false:不保存默认为 false。 */
SaveCommand?: boolean;
/** 是否启用自定义参数功能。一旦创建,此值不提供修改。取值范围: true:启用 false:不启用 默认值:false。 */
EnableParameter?: boolean;
/** 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{"varA": "222"}。key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。仅在命令的 EnableParameter 为 true 时,才允许设置此参数。参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。如果 Parameters 未提供,将使用这里的默认值进行替换。自定义参数最多20个。自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。 */
DefaultParameters?: string;
/** 自定义参数数组。 如果 Parameters 未提供,将使用这里的默认值进行替换。 自定义参数最多20个。如果 Parameters 未提供,将使用这里的默认值进行替换。仅在命令的 EnableParameter 为 true 时,才允许设置此参数。参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 */
DefaultParameterConfs?: DefaultParameterConf[];
/** Command 的自定义参数。字段类型为json encoded string。如:{"varA": "222"}。key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。仅在命令的 EnableParameter 为 true 时,才允许设置此参数。如果未提供该参数取值,将使用 DefaultParameters 或 DefaultParameterConfs 进行替换。自定义参数最多20个。自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。 */
Parameters?: string;
/** 如果保存命令,可为命令设置标签。列表长度不超过10。 */
Tags?: Tag[];
/** 在 CVM 或 Lighthouse 实例中执行命令的用户名称。使用最小权限执行命令是权限管理的最佳实践,建议您以普通用户身份执行云助手命令。默认情况下,在 Linux 实例中以 root 用户执行命令;在Windows 实例中以 System 用户执行命令。 */
Username?: string;
/** 指定日志上传的cos bucket 地址,必须以https开头,如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。 */
OutputCOSBucketUrl?: string;
/** 指定日志在cos bucket中的目录,目录命名有如下规则:1. 可用数字、中英文和可见字符的组合,长度最多为60。2. 用 / 分割路径,可快速创建子目录。3. 不允许连续 / ;不允许以 / 开头;不允许以..作为文件夹名称。 */
OutputCOSKeyPrefix?: string;
}
declare interface RunCommandResponse {
/** 命令ID。 */
CommandId?: string;
/** 执行活动ID。 */
InvocationId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
/** {@link Tat 自动化助手} */
declare interface Tat {
(): Versions;
/** 取消命令执行 {@link CancelInvocationRequest} {@link CancelInvocationResponse} */
CancelInvocation(data: CancelInvocationRequest, config?: AxiosRequestConfig): AxiosPromise<CancelInvocationResponse>;
/** 创建命令 {@link CreateCommandRequest} {@link CreateCommandResponse} */
CreateCommand(data: CreateCommandRequest, config?: AxiosRequestConfig): AxiosPromise<CreateCommandResponse>;
/** 创建执行器 {@link CreateInvokerRequest} {@link CreateInvokerResponse} */
CreateInvoker(data: CreateInvokerRequest, config?: AxiosRequestConfig): AxiosPromise<CreateInvokerResponse>;
/** 创建注册码 {@link CreateRegisterCodeRequest} {@link CreateRegisterCodeResponse} */
CreateRegisterCode(data?: CreateRegisterCodeRequest, config?: AxiosRequestConfig): AxiosPromise<CreateRegisterCodeResponse>;
/** 删除命令 {@link DeleteCommandRequest} {@link DeleteCommandResponse} */
DeleteCommand(data: DeleteCommandRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteCommandResponse>;
/** 批量删除命令 {@link DeleteCommandsRequest} {@link DeleteCommandsResponse} */
DeleteCommands(data: DeleteCommandsRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteCommandsResponse>;
/** 删除执行器 {@link DeleteInvokerRequest} {@link DeleteInvokerResponse} */
DeleteInvoker(data: DeleteInvokerRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteInvokerResponse>;
/** 批量删除注册码 {@link DeleteRegisterCodesRequest} {@link DeleteRegisterCodesResponse} */
DeleteRegisterCodes(data: DeleteRegisterCodesRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteRegisterCodesResponse>;
/** 删除托管实例 {@link DeleteRegisterInstanceRequest} {@link DeleteRegisterInstanceResponse} */
DeleteRegisterInstance(data: DeleteRegisterInstanceRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteRegisterInstanceResponse>;
/** 查询客户端状态 {@link DescribeAutomationAgentStatusRequest} {@link DescribeAutomationAgentStatusResponse} */
DescribeAutomationAgentStatus(data?: DescribeAutomationAgentStatusRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeAutomationAgentStatusResponse>;
/** 查询命令详情 {@link DescribeCommandsRequest} {@link DescribeCommandsResponse} */
DescribeCommands(data?: DescribeCommandsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeCommandsResponse>;
/** 查询执行任务 {@link DescribeInvocationTasksRequest} {@link DescribeInvocationTasksResponse} */
DescribeInvocationTasks(data?: DescribeInvocationTasksRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeInvocationTasksResponse>;
/** 查询执行活动 {@link DescribeInvocationsRequest} {@link DescribeInvocationsResponse} */
DescribeInvocations(data?: DescribeInvocationsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeInvocationsResponse>;
/** 查询执行器执行记录 {@link DescribeInvokerRecordsRequest} {@link DescribeInvokerRecordsResponse} */
DescribeInvokerRecords(data?: DescribeInvokerRecordsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeInvokerRecordsResponse>;
/** 查询执行器 {@link DescribeInvokersRequest} {@link DescribeInvokersResponse} */
DescribeInvokers(data?: DescribeInvokersRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeInvokersResponse>;
/** 获取配额信息 {@link DescribeQuotasRequest} {@link DescribeQuotasResponse} */
DescribeQuotas(data: DescribeQuotasRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeQuotasResponse>;
/** 查询地域列表 {@link DescribeRegionsRequest} {@link DescribeRegionsResponse} */
DescribeRegions(data?: DescribeRegionsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeRegionsResponse>;
/** 查询注册码 {@link DescribeRegisterCodesRequest} {@link DescribeRegisterCodesResponse} */
DescribeRegisterCodes(data?: DescribeRegisterCodesRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeRegisterCodesResponse>;
/** 查询托管实例 {@link DescribeRegisterInstancesRequest} {@link DescribeRegisterInstancesResponse} */
DescribeRegisterInstances(data?: DescribeRegisterInstancesRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeRegisterInstancesResponse>;
/** 查询场景 {@link DescribeScenesRequest} {@link DescribeScenesResponse} */
DescribeScenes(data?: DescribeScenesRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeScenesResponse>;
/** 停用执行器 {@link DisableInvokerRequest} {@link DisableInvokerResponse} */
DisableInvoker(data: DisableInvokerRequest, config?: AxiosRequestConfig): AxiosPromise<DisableInvokerResponse>;
/** 批量禁用注册码 {@link DisableRegisterCodesRequest} {@link DisableRegisterCodesResponse} */
DisableRegisterCodes(data: DisableRegisterCodesRequest, config?: AxiosRequestConfig): AxiosPromise<DisableRegisterCodesResponse>;
/** 启用执行器 {@link EnableInvokerRequest} {@link EnableInvokerResponse} */
EnableInvoker(data: EnableInvokerRequest, config?: AxiosRequestConfig): AxiosPromise<EnableInvokerResponse>;
/** 触发命令 {@link InvokeCommandRequest} {@link InvokeCommandResponse} */
InvokeCommand(data: InvokeCommandRequest, config?: AxiosRequestConfig): AxiosPromise<InvokeCommandResponse>;
/** 修改命令 {@link ModifyCommandRequest} {@link ModifyCommandResponse} */
ModifyCommand(data: ModifyCommandRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyCommandResponse>;
/** 修改执行器 {@link ModifyInvokerRequest} {@link ModifyInvokerResponse} */
ModifyInvoker(data: ModifyInvokerRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyInvokerResponse>;
/** 修改托管实例 {@link ModifyRegisterInstanceRequest} {@link ModifyRegisterInstanceResponse} */
ModifyRegisterInstance(data: ModifyRegisterInstanceRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyRegisterInstanceResponse>;
/** 命令预览 {@link PreviewReplacedCommandContentRequest} {@link PreviewReplacedCommandContentResponse} */
PreviewReplacedCommandContent(data?: PreviewReplacedCommandContentRequest, config?: AxiosRequestConfig): AxiosPromise<PreviewReplacedCommandContentResponse>;
/** 执行命令 {@link RunCommandRequest} {@link RunCommandResponse} */
RunCommand(data: RunCommandRequest, config?: AxiosRequestConfig): AxiosPromise<RunCommandResponse>;
}
export declare type Versions = ["2020-10-28"];
export default Tat;