接口说明
-
当您执行命令后,不代表命令一定成功运行,并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果,以实际输出结果为准。
-
您可以查询最近 4 周的执行信息,执行信息的保留上限为 10 万条。
-
您可以通过云助手任务状态事件订阅的方式,通过事件获取任务结果,避免频繁轮询,用以提升效率。
-
分页查询首页时,仅需设置
MaxResults
以限制返回信息的条目数,返回结果中的NextToken
将作为查询后续页的凭证。查询后续页时,将NextToken
参数设置为上一次返回结果中获取到的NextToken
作为查询凭证,并设置MaxResults
限制返回条目数。 -
DescribeInvocations
和DescribeInvocationResults
差异点:- 当一次
RunCommand
/InvokeCommand
调用指定有多个实例时:- 使用
DescribeInvocations
可以获得任务在各个实例上的执行状态、多个实例任务状态的聚合状态; - 使用
DescribeInvocationResults
仅能获得各个实例上的单独的执行状态,不包含多实例的聚合状态;
- 使用
- 当一次
RunCommand
/InvokeCommand
调用指定有一个实例时:DescribeInvocations
与DescribeInvocationResults
区别不大,完全可以互相替换。
- 当需要查看定时性(周期性)任务、开机自动执行任务(
RepeatMode=Period, EveryReboot
)的每一次执行情况时,仅能用DescribeInvocationResults
可以查询获得执行的过往历史记录(需指定IncludeHistory=true
),而DescribeInvocations
仅支持返回最新的任务状态。 - 当需要查看命令的内容、参数时,仅有
DescribeInvocations
返回CommandContent
。
- 当一次
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
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 | 命令名称。如果同时设置了 示例值:CommandTestName |
CommandTypestring | 命令类型。取值范围:展开详情 示例值:RunShellScript |
Timedboolean | 查询的命令是否在将来会自动执行。取值范围:展开详情 示例值:true |
InvokeStatusstring | 命令执行的总执行状态。总执行状态取决于创建执行中的一台或多台实例的共同执行状态。取值范围: 展开详情 示例值:Finished |
InstanceIdstring | 实例 ID。当您传入了该参数,将查询该实例所有的命令执行记录。 示例值:i-bp1i7gg30r52z2em****参考取值来源: RunInstances StopInstances StartInstances CreateInstance RebootInstances DescribeInstances ModifyManagedInstance RenewReservedInstances DetachInstanceRamRole AttachInstanceRamRole DeregisterManagedInstance PurchaseReservedInstancesOffering |
ContentEncodingstring | 设置返回数据中 示例值: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 | 命令执行的方式。如果同时设置了 示例值: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 |