当前位置:主页 > 查看内容

腾讯云自动化助手 数据结构 - API 文档

发布时间:2021-09-13 00:00| 位朋友查看

简介:AutomationAgentInfo 自动化助手客户端信息 被如下接口引用:DescribeAutomationAgentStatus。 名称 类型 描述 InstanceId String 实例ID。 Version String Agent 版本号。 LastHeartbeatTime Timestamp ISO8601 上次心跳时间 AgentStatus String Agent状态……

AutomationAgentInfo

自动化助手客户端信息

被如下接口引用:DescribeAutomationAgentStatus。

名称 类型 描述
InstanceId String 实例ID。
Version String Agent 版本号。
LastHeartbeatTime Timestamp ISO8601 上次心跳时间
AgentStatus String Agent状态,取值范围:
  • Online:在线
  • Offline:离线
  • Environment String Agent运行环境

    Command

    命令详情。

    被如下接口引用:DescribeCommands。

    名称 类型 描述
    CommandId String 命令ID。
    CommandName String 命令名称。
    Description String 命令描述。
    Content String Base64编码后的命令内容。
    CommandType String 命令类型。
    WorkingDirectory String 命令执行路径。
    Timeout Integer 命令超时时间。
    CreatedTime Timestamp ISO8601 命令创建时间。
    UpdatedTime Timestamp ISO8601 命令更新时间。
    EnableParameter Boolean 是否启用自定义参数功能。
    DefaultParameters String 自定义参数的默认取值。
    FormattedDescription String 命令的结构化描述。公共命令有值,用户命令为空字符串。
    CreatedBy String 命令创建者。TAT 代表公共命令,USER 代表个人命令。

    CommandDocument

    命令执行详情。

    被如下接口引用:DescribeInvocationTasks。

    名称 类型 描述
    Content String Base64 编码后的执行命令。
    CommandType String 命令类型。
    Timeout Integer 超时时间。
    WorkingDirectory String 执行路径。

    Filter

    描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等

    • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(OR)关系。

    以DescribeInstances接口的Filter为例。若我们需要查询可用区(zone)为广州一区 并且 实例计费模式(instance-charge-type)为包年包月 或者 按量计费的实例时,可如下实现:

    Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-1
    &Filters.1.Name=instance-charge-type
    &Filters.1.Values.0=PREPAID
    &Filters.1.Values.1=POSTPAID_BY_HOUR

    被如下接口引用:DescribeAutomationAgentStatus, DescribeCommands, DescribeInvocationTasks, DescribeInvocations。

    名称 类型 必选 描述
    Name String 需要过滤的字段。
    Values Array of String 字段的过滤值。

    Invocation

    执行活动详情。

    被如下接口引用:DescribeInvocations。

    名称 类型 描述
    InvocationId String 执行活动ID。
    CommandId String 命令ID。
    InvocationStatus String 执行任务状态。取值范围:
  • PENDING:等待下发
  • RUNNING:命令运行中
  • SUCCESS:命令成功
  • FAILED:命令失败
  • TIMEOUT:命令超时
  • PARTIAL_FAILED:命令部分失败
  • InvocationTaskBasicInfoSet Array of InvocationTaskBasicInfo 执行任务信息列表。
    Description String 执行活动描述。
    StartTime Timestamp ISO8601 执行活动开始时间。
    EndTime Timestamp ISO8601 执行活动结束时间。
    CreatedTime Timestamp ISO8601 执行活动创建时间。
    UpdatedTime Timestamp ISO8601 执行活动更新时间。
    Parameters String 自定义参数取值。
    DefaultParameters String 自定义参数的默认取值。

    InvocationTask

    执行任务。

    被如下接口引用:DescribeInvocationTasks。

    名称 类型 描述
    InvocationId String 执行活动ID。
    InvocationTaskId String 执行任务ID。
    CommandId String 命令ID。
    TaskStatus String 执行任务状态。取值范围:
  • PENDING:等待下发
  • DELIVERING:下发中
  • DELIVER_DELAYED:延时下发
  • DELIVER_FAILED:下发失败
  • RUNNING:命令运行中
  • SUCCESS:命令成功
  • FAILED:命令失败
  • TIMEOUT:命令超时
  • TASK_TIMEOUT:执行任务超时
  • InstanceId String 实例ID。
    TaskResult TaskResult 执行结果。
    StartTime Timestamp ISO8601 执行任务开始时间。
    EndTime Timestamp ISO8601 执行任务结束时间。
    CreatedTime Timestamp ISO8601 创建时间。
    UpdatedTime Timestamp ISO8601 更新时间。
    CommandDocument CommandDocument 执行任务所执行的命令详情。

    InvocationTaskBasicInfo

    执行活动任务简介。

    被如下接口引用:DescribeInvocations。

    名称 类型 描述
    InvocationTaskId String 执行任务ID。
    TaskStatus String 执行任务状态。取值范围:
  • PENDING:等待下发
  • DELIVERING:下发中
  • DELIVER_DELAYED:延时下发
  • DELIVER_FAILED:下发失败
  • RUNNING:命令运行中
  • SUCCESS:命令成功
  • FAILED:命令失败
  • TIMEOUT:命令超时
  • TASK_TIMEOUT:执行任务超时
  • InstanceId String 实例ID。

    RegionInfo

    描述单个地域信息

    被如下接口引用:DescribeRegions。

    名称 类型 描述
    Region String 地域名称,例如,ap-guangzhou
    RegionName String 地域描述,例如: 广州
    RegionState String 地域是否可用状态

    TaskResult

    任务结果。

    被如下接口引用:DescribeInvocationTasks。

    名称 类型 描述
    ExitCode Integer 命令执行ExitCode。
    Output String Base64编码后的命令输出。最大长度24KB。
    ExecStartTime Timestamp ISO8601 命令执行开始时间。
    ExecEndTime Timestamp ISO8601 命令执行结束时间。

    本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐