DescribeInvocations_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 当您执行命令后,不代表命令一定成功运行,并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果,以实际输出结果为准。

  • 您可以查询最近 4 周的执行信息,执行信息的保留上限为 10 万条。

  • 您可以通过云助手任务状态事件订阅的方式,通过事件获取任务结果,避免频繁轮询,用以提升效率。

  • 分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。

  • DescribeInvocationsDescribeInvocationResults差异点:

    • 当一次RunCommand/InvokeCommand调用指定有多个实例时:
      • 使用DescribeInvocations可以获得任务在各个实例上的执行状态、多个实例任务状态的聚合状态;
      • 使用DescribeInvocationResults仅能获得各个实例上的单独的执行状态,不包含多实例的聚合状态;
    • 当一次RunCommand/InvokeCommand调用指定有一个实例时:
      • DescribeInvocationsDescribeInvocationResults区别不大,完全可以互相替换。
    • 当需要查看定时性(周期性)任务、开机自动执行任务(RepeatMode=Period, EveryReboot)的每一次执行情况时,仅能用DescribeInvocationResults可以查询获得执行的过往历史记录(需指定IncludeHistory=true),而DescribeInvocations仅支持返回最新的任务状态。
    • 当需要查看命令的内容、参数时,仅有DescribeInvocations返回CommandContent

流控信息

请求速率为1000/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecs:DescribeInvocations
Get
Instance
acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
Command
acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

请求参数

字段名称字段详情
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ResourceGroupIdstring

命令执行的资源组 ID。传入该参数后,需要在执行命令时指定 ResourceGroupId,支持筛选出对应的命令执行结果。

示例值:rg-bp67acfmxazb4p****参考取值来源:
    DescribeSnapshotGroups
InvokeIdstring

命令执行 ID。

示例值:t-hz0jdfwd9f****参考取值来源:
    InvokeCommand
CommandIdstring

命令 ID。您可以通过接口 DescribeCommands 查询所有可用的 CommandId。

示例值:c-hz0jdfwcsr****参考取值来源:
    RunCommand
    CreateCommand
    DescribeCommands
CommandNamestring

命令名称。如果同时设置了InstanceId参数,则该参数不生效。

示例值:CommandTestName
CommandTypestring

命令类型。取值范围:展开详情

示例值:RunShellScript
Timedboolean

查询的命令是否在将来会自动执行。取值范围:展开详情

示例值:true
InvokeStatusstring

命令执行的总执行状态。总执行状态取决于创建执行中的一台或多台实例的共同执行状态。取值范围: 展开详情

示例值:Finished
InstanceIdstring

实例 ID。当您传入了该参数,将查询该实例所有的命令执行记录。

示例值:i-bp1i7gg30r52z2em****参考取值来源:
    RunInstances
    StopInstances
    StartInstances
    CreateInstance
    RebootInstances
    DescribeInstances
    ModifyManagedInstance
    RenewReservedInstances
    DetachInstanceRamRole
    AttachInstanceRamRole
    DeregisterManagedInstance
    PurchaseReservedInstancesOffering
ContentEncodingstring

设置返回数据中CommandContent字段和Output字段的编码方式。取值范围:展开详情

示例值:PlainText
IncludeOutputboolean

是否在结果中返回命令运行的输出信息。展开详情

示例值:false
PageNumberinteger<int64>
说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
PageSizeinteger<int64>
说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10
MaxResultsinteger<int32>

分页查询时每页的最大条目数。展开详情

示例值:10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

示例值:AAAAAdDWBF2
RepeatModestring

命令执行的方式。如果同时设置了InstanceId参数,则不生效。取值范围:展开详情

示例值:Once
Tagarray<object>

标签列表。

子级条数 <= 21

返回参数

字段名称字段详情
PageSizeinteger<int64>

每页行数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberinteger<int64>

查询结果的页码。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1
TotalCountinteger<int64>

命令总个数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1
NextTokenstring

本次调用返回的查询凭证值。

示例值:AAAAAdDWBF2
Invocationsobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
RegionId.ApiNotSupported
The api is not supported in this region.诊断
400
NumberExceed.Tags
The Tags parameter number is exceed.诊断
400
Duplicate.TagKey
The Tag.N.Key contain duplicate key.诊断
400
InvalidTagKey.Malformed
The specified Tag.n.Key is not valid.诊断
400
InvalidTagValue.Malformed
The specified Tag.n.Value is not valid.诊断
400
MissingParameter.TagKey
You must specify Tag.N.Key.诊断
400
InvalidParam.PageNumber
The specified parameter is invalid.诊断
400
InvalidParam.PageSize
The specified parameter is invalid.诊断
400
InvalidParameter.NextToken
The specified parameter NextToken is not valid.诊断
400
InvalidParameter.MaxResults
The specified parameter MaxResults is not valid.诊断
403
Operation.Forbidden
The operation is not permitted.诊断
404
InvalidRegionId.NotFound
The RegionId provided does not exist in our records.诊断
500
InternalError.Dispatch
An error occurred when you dispatched the request.诊断

变更历史

变更时间变更内容概要操作
2024-08-01
变更返回参数
2024-05-14
变更返回参数
2023-12-21
变更错误码400
新增请求参数MaxResults
新增请求参数NextToken
变更返回参数
2023-05-12
变更错误码400
变更错误码403
2022-10-28
新增请求参数ResourceGroupId
2022-09-09
变更返回参数
  • 1
  • 2
  • 10 条/页

相关示例