全部产品
Search

搜索本产品

    云服务器 ECS：DescribeInvocations

    文档中心

    云服务器 ECS：DescribeInvocations

    更新时间：Sep 20, 2023

    调用DescribeInvocations查询云助手命令的执行列表和状态。

    接口说明

    • 当您执行命令后，不代表命令一定成功运行，并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果，以实际输出结果为准。
    • 您可以查询最近4周的执行信息，执行信息的保留上限为10万条。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    请求参数

    名称

    类型

    是否必选

    示例值

    描述
    Action String 是 DescribeInvocations

    系统规定参数。取值：DescribeInvocations。
    RegionId String 是 cn-hangzhou

    地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
    ResourceGroupId String 否 rg-bp67acfmxazb4p****

    命令执行的资源组ID。传入该参数后，需要在执行命令时指定ResourceGroupId，支持筛选出对应的命令执行结果。
    InvokeId String 否 t-hz0jdfwd9f****

    命令执行ID。
    CommandId String 否 c-hz0jdfwcsr****

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

    CommandName String 否 CommandTestName

    命令名称。如果同时设置了InstanceId参数，则该参数不生效。
    CommandType String 否 RunShellScript

    命令类型。取值范围：

    • RunBatScript：命令为在Windows实例中运行的Bat脚本。
    • RunPowerShellScript：命令为在Windows实例中运行的PowerShell脚本。
    • RunShellScript：命令为在Linux实例中运行的Shell脚本。
    Timed Boolean 否 true

    查询的命令是否在将来会自动执行。取值范围：

    • true：查询在调用RunCommand或InvokeCommand执行命令时，RepeatMode参数取值为Period、NextRebootOnly或者EveryReboot。
    • false：查询以下两种状态的命令。
      • 在调用RunCommand或InvokeCommand执行命令时，RepeatMode参数取值为Once。
      • 已被取消、被停止或者已完成执行的命令。

    默认值：false。
    InvokeStatus String 否 Finished

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

    • Running：
      • 定时执行：未手动停止定时执行命令前，执行状态一直为进行中。
      • 单次执行：一旦有进行中的命令进程，总的执行状态就为进行中。
    • Finished：
      • 定时执行：命令进程不可能为执行完成。
      • 单次执行：所有实例全部完成执行。或者手动停止部分实例的命令进程，其余实例全部执行完成。
    • Success：各个实例上的命令执行状态均为Stopped或Success，且至少一个实例的命令执行状态是Success，则总执行状态为Success。
      • 立即运行的任务：命令执行完成，且退出码为0。
      • 定时运行的任务：最近一次执行成功且退出码为0，且指定的时间已全部完成。
    • Failed：
      • 定时执行：命令进程不可能为执行失败。
      • 单次执行：所有实例全部执行失败。
    • Stopped：停止命令。
    • Stopping：停止中。
    • PartialFailed：部分失败；如果同时设置了InstanceId参数，则不生效。
    InstanceId String 否 i-bp1i7gg30r52z2em****

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

    设置返回数据中CommandContent字段和Output字段的编码方式。取值范围：

    • PlainText：返回原始命令内容和输出信息。
    • Base64：返回Base64编码后的命令内容和输出信息。

    默认值：Base64。
    IncludeOutput Boolean 否 false

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

    • true：返回。此时，您至少指定参数InvokeId或InstanceId。
    • false：不返回。

    默认值：false。
    PageNumber Long 否 1

    当前页码。

    起始值：1。

    默认值：1。
    PageSize Long 否 10

    分页查询时设置的每页行数。

    最大值：50。

    默认值：10。
    RepeatMode String 否 Once

    命令执行的方式。如果同时设置了InstanceId参数，则不生效。取值范围：

    • Once：立即执行命令。
    • Period：定时执行命令。
    • NextRebootOnly：当实例下一次启动时，自动执行命令。
    • EveryReboot：实例每一次启动都将自动执行命令。

    默认值为空，表示查询全部。
    Tag.N.Key String 否 TestKey

    命令执行的标签键。N的取值范围为1~20。一旦传入该值，则不允许为空字符串。

    使用一个标签过滤资源，查询到该标签下的资源数量不能超过1000个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个，您需要使用ListTagResources接口进行查询。

    最多支持64个字符，不能以aliyun或acs:开头，不能包含http://或https://。
    Tag.N.Value String 否 TestValue

    命令执行的标签值。N的取值范围为1~20。该值可以为空字符串。

    最多支持128个字符，不能包含http://或https://。

    返回数据

    名称

    类型

    示例值

    描述
    PageSize Long 10

    每页行数。
    RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    请求ID。
    PageNumber Long 1

    查询结果的页码。
    TotalCount Long 1

    命令总个数。
    Invocations Array of Invocation

    命令执行记录组成的数组。

    Invocation
    CreationTime String 2020-01-19T09:15:46Z

    任务的创建时间。
    Frequency String 0 */20 * * * *

    定时执行命令的执行时间。
    InvocationStatus String Running

    命令执行的总执行状态，总执行状态取决于本次调用的全部实例的共同执行状态，可能值：

    • Pending：系统正在校验或发送命令。存在至少一台实例的命令执行状态为Pending，则总执行状态为Pending。
    • Scheduled：定时执行的命令已发送，等待运行。存在至少一台实例的命令执行状态为Scheduled，则总执行状态为Scheduled。
    • Running：命令正在实例上运行。存在至少一台实例的命令执行状态为Running，则总执行状态为Running。
    • Success：各个实例上的命令执行状态均为Stopped或Success，且至少一个实例的命令执行状态是Success，则总执行状态为Success。
      • 立即运行的任务：命令执行完成，且退出码为0。
      • 定时运行的任务：最近一次执行成功且退出码为0，且指定的时间已全部完成。
    • Failed：各个实例上的命令执行状态均为Stopped或Failed，则总执行状态为Failed。实例上的命令执行状态一项或多项为以下状态时，返回值均为Failed状态：
      • 命令校验失败（Invalid）。
      • 命令发送失败（Aborted）。
      • 命令执行完成但退出码非0（Failed）。
      • 命令执行超时（Timeout）。
      • 命令执行异常（Error）。
    • Stopping：正在停止任务。存在至少一台实例的命令执行状态为Stopping，则总执行状态为Stopping。
    • Stopped：任务已停止。所有实例的命令执行状态是Stopped，则总执行状态为Stopped。实例上的命令执行状态为以下状态时，返回值均为Stopped状态：
      • 任务已取消（Cancelled）。
      • 任务已终止（Terminated）。
    • PartialFailed：部分实例执行成功且部分实例执行失败。各个实例的命令执行状态均为Success、Failed或Stopped，则总执行状态为PartialFailed。
    说明 返回参数中的InvokeStatus与该参数意义相似，但建议您查看该返回值。
    RepeatMode String Once

    命令执行的方式。可能值：

    • Once：立即执行命令。
    • Period：定时执行命令。
    • NextRebootOnly：当实例下一次启动时，自动执行命令。
    • EveryReboot：实例每一次启动都将自动执行命令。
    CommandId String c-hz0jdfwcsr****

    命令ID。
    CommandType String RunShellScript

    命令类型。
    InvokeStatus String Finished

    命令总的执行状态。

    说明 不推荐查看该返回值，推荐您查看InvocationStatus的返回值。
    Parameters String {}

    命令中的自定义参数。
    Timed Boolean false

    查询的命令是否在将来会自动执行。
    CommandContent String cnBtIC1xYSB8IGdyZXAgdnNm****

    命令内容。

    • 若ContentEncoding指定PlainText，返回原始脚本内容。
    • 若ContentEncoding指定Base64，返回Base64编码后的脚本内容。
    CommandName String CommandTestName

    命令名称。
    CommandDescription String testDescription

    命令描述。
    InvokeId String t-hz0jdfwd9f****

    命令执行ID。
    Username String test

    ECS实例中执行命令的用户名称。
    WorkingDir String /home/

    命令执行路径。
    Timeout Long 60

    您创建的命令在ECS实例中执行时最大的超时时间，单位：秒。

    当因为某种原因无法运行您创建的命令时，会出现超时现象。超时后，会强制终止命令进程，即取消命令的PID。
    ContainerId String ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****

    容器ID。
    ContainerName String test-container

    容器名称。
    InvokeInstances Array of InvokeInstance

    执行目标实例集类型。

    InvokeInstance
    CreationTime String 2019-12-20T06:15:54Z

    命令执行的开始时间。
    UpdateTime String 2020-01-19T09:15:47Z

    命令状态的更新时间。
    FinishTime String 2019-12-20T06:15:56Z

    命令进程的结束时间。
    InvocationStatus String Success

    单台实例的命令进度状态，可能值：

    • Pending：系统正在校验或发送命令。
    • Invalid：指定命令类型或参数有误。
    • Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。
    • Running：命令正在实例上运行。
    • Success：
      • 单次执行的命令：命令执行完成，且退出码为0。
      • 定时执行的命令：上一次运行成功且退出码为0，且指定的时间已结束。
    • Failed：
      • 单次执行的命令：命令执行完成，且退出码非0。
      • 定时执行的命令：上一次运行成功且退出码非0，且指定的时间将中止。
    • Error：命令执行时发生异常无法继续。
    • Timeout：命令执行超时。
    • Cancelled：命令的执行动作已经取消，命令未曾启动。
    • Stopping：正在停止任务。
    • Terminated：命令运行时被终止。
    • Scheduled：
      • 单次执行的命令：不适用，不会出现。
      • 定时执行的命令：等待运行。
    Repeats Integer 0

    命令在该实例上执行的次数。

    • 若执行方式为单次执行，则值为0或1。
    • 若执行方式为定时执行，则值为执行过多少次。
    InstanceId String i-bp1i7gg30r52z2em****

    实例ID。
    Output String OutPutTestmsg

    命令的输出信息。

    • 若ContentEncoding指定PlainText，返回原始输出信息。
    • 若ContentEncoding指定Base64，返回Base64编码后的输出信息。
    Dropped Integer 0

    Output字段中文字长度超出24 KB后，截断丢弃的文字长度。
    StopTime String 2020-01-19T09:15:47Z

    若调用了StopInvocation以停止命令执行，表示调用的时间。
    ExitCode Long 0

    命令进程的退出代码。可能值：

    • Linux实例为Shell进程的退出码。
    • Windows实例为Bat或者PowerShell进程的退出码。
    StartTime String 2019-12-20T06:15:55Z

    命令在实例中开始执行的时间。
    ErrorInfo String the specified instance does not exists

    命令的下发失败或执行失败原因的详情，可能值：

    • 空：命令运行正常。
    • the specified instance does not exists：指定的实例不存在或已释放。
    • the instance has released when create task：执行命令期间，该实例被释放。
    • the instance is not running when create task：开始执行命令时，该实例不在运行中。
    • the command is not applicable：命令不适用于指定的实例。
    • the specified account does not exists：指定的账号不存在。
    • the specified directory does not exists：指定的目录不存在。
    • the cron job expression is invalid：指定的执行时间表达式不合法。
    • the aliyun service is not running on the instance：云助手Agent未运行。
    • the aliyun service in the instance does not response：云助手Agent无响应。
    • the aliyun service in the instance is upgrading now：云助手Agent正在升级中。
    • the aliyun service in the instance need upgrade：云助手Agent需要升级。
    • the command delivery has been timeout：发送命令超时。
    • the command execution has been timeout：命令执行超时。
    • the command execution got an exception：命令执行发生异常。
    • the command execution has been interrupted：命令执行任务中断。
    • the command execution exit code is not zero：命令执行结束，退出码非0。
    • the specified instance has been released：下发文件期间，该实例被释放。
    Timed Boolean false

    查询的命令是否在将来会自动执行。
    ErrorCode String InstanceNotExists

    命令的下发失败或执行失败原因的代码，可能值：

    • 空：命令运行正常。
    • InstanceNotExists：指定的实例不存在或已释放。
    • InstanceReleased：执行命令期间，该实例被释放。
    • InstanceNotRunning：开始执行命令时，该实例不在运行中。
    • CommandNotApplicable：命令不适用于指定的实例。
    • AccountNotExists：指定的账号不存在。
    • DirectoryNotExists：指定的目录不存在。
    • BadCronExpression：指定的执行时间表达式不合法。
    • ClientNotRunning：云助手Agent未运行。
    • ClientNotResponse：云助手Agent无响应。
    • ClientIsUpgrading：云助手Agent正在升级中。
    • ClientNeedUpgrade：云助手Agent需要升级。
    • DeliveryTimeout：发送命令超时。
    • ExecutionTimeout：命令执行超时。
    • ExecutionException：命令执行发生异常。
    • ExecutionInterrupted：命令执行任务中断。
    • ExitCodeNonzero：命令执行结束，退出码非0。
    InstanceInvokeStatus String Finished

    单台实例的命令进度状态。

    说明 不推荐查看该返回值，推荐您查看InvocationStatus的返回值。
    Tags Array of Tag

    命令执行的标签信息。
    Tag
    TagKey String owner

    命令执行的标签键。
    TagValue String zhangsan

    命令执行的标签值。

    示例

    请求示例

    http(s)://ecs.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&InvokeId=t-hz0jdfwd9f****
&CommandId=c-hz0jdfwcsr****
&CommandName=CommandTestName
&CommandType=RunShellScript
&Timed=true
&InvokeStatus=Finished
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=10
&RepeatMode=Once
&公共请求参数

    正常返回示例

    XML格式

    HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInvocationsResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Invocations>
        <Invocation>
            <CreationTime>2020-01-19T09:15:46Z</CreationTime>
            <Frequency>0 */20 * * * *</Frequency>
            <InvocationStatus>Running</InvocationStatus>
            <RepeatMode>Once</RepeatMode>
            <CommandId>c-hz0jdfwcsr****</CommandId>
            <CommandType>RunShellScript</CommandType>
            <InvokeStatus>Finished</InvokeStatus>
            <Parameters>{}</Parameters>
            <Timed>false</Timed>
            <CommandContent>cnBtIC1xYSB8IGdyZXAgdnNm****</CommandContent>
            <CommandName>CommandTestName</CommandName>
            <CommandDescription>testDescription</CommandDescription>
            <InvokeId>t-hz0jdfwd9f****</InvokeId>
            <Username>test</Username>
            <WorkingDir>/home/</WorkingDir>
            <Timeout>60</Timeout>
            <ContainerId>ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****</ContainerId>
            <ContainerName>test-container</ContainerName>
            <InvokeInstances>
                <InvokeInstance>
                    <CreationTime>2019-12-20T06:15:54Z</CreationTime>
                    <UpdateTime>2020-01-19T09:15:47Z</UpdateTime>
                    <FinishTime>2019-12-20T06:15:56Z</FinishTime>
                    <InvocationStatus>Success</InvocationStatus>
                    <Repeats>0</Repeats>
                    <InstanceId>i-bp1i7gg30r52z2em****</InstanceId>
                    <Output>OutPutTestmsg</Output>
                    <Dropped>0</Dropped>
                    <StopTime>2020-01-19T09:15:47Z</StopTime>
                    <ExitCode>0</ExitCode>
                    <StartTime>2019-12-20T06:15:55Z</StartTime>
                    <ErrorInfo>the specified instance does not exists</ErrorInfo>
                    <Timed>false</Timed>
                    <ErrorCode>InstanceNotExists</ErrorCode>
                    <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
                </InvokeInstance>
                <Tags>
                    <TagKey>owner</TagKey>
                    <TagValue>zhangsan</TagValue>
                </Tags>
            </InvokeInstances>
        </Invocation>
    </Invocations>
</DescribeInvocationsResponse>

    JSON格式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Invocations" : {
    "Invocation" : [ {
      "CreationTime" : "2020-01-19T09:15:46Z",
      "Frequency" : "0 */20 * * * *",
      "InvocationStatus" : "Running",
      "RepeatMode" : "Once",
      "CommandId" : "c-hz0jdfwcsr****",
      "CommandType" : "RunShellScript",
      "InvokeStatus" : "Finished",
      "Parameters" : "{}",
      "Timed" : false,
      "CommandContent" : "cnBtIC1xYSB8IGdyZXAgdnNm****",
      "CommandName" : "CommandTestName",
      "CommandDescription" : "testDescription",
      "InvokeId" : "t-hz0jdfwd9f****",
      "Username" : "test",
      "WorkingDir" : "/home/",
      "Timeout" : 60,
      "ContainerId" : "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
      "ContainerName" : "test-container",
      "InvokeInstances" : {
        "InvokeInstance" : [ {
          "CreationTime" : "2019-12-20T06:15:54Z",
          "UpdateTime" : "2020-01-19T09:15:47Z",
          "FinishTime" : "2019-12-20T06:15:56Z",
          "InvocationStatus" : "Success",
          "Repeats" : 0,
          "InstanceId" : "i-bp1i7gg30r52z2em****",
          "Output" : "OutPutTestmsg",
          "Dropped" : 0,
          "StopTime" : "2020-01-19T09:15:47Z",
          "ExitCode" : 0,
          "StartTime" : "2019-12-20T06:15:55Z",
          "ErrorInfo" : "the specified instance does not exists",
          "Timed" : false,
          "ErrorCode" : "InstanceNotExists",
          "InstanceInvokeStatus" : "Finished"
        } ],
        "Tags" : [ {
          "TagKey" : "owner",
          "TagValue" : "zhangsan"
        } ]
      }
    } ]
  }
}

    错误码

    HttpCode

    错误码

    错误信息

    描述
    400 RegionId.ApiNotSupported The api is not supported in this region. 指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
    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. 指定的 PageNumber 参数无效。
    400 InvalidParam.PageSize The specified parameter is invalid. 指定的 PageSize 参数无效。
    403 Operation.Forbidden The operation is not permitted. 该操作是不被允许的。
    500 InternalError.Dispatch An error occurred when you dispatched the request. 发送请求时发生错误，请稍后重试。

    访问错误中心查看更多错误码。