1. 云计算教程网首页
  2. 阿里云

DescribeInvocations

佚, 佚名 • • 阿里云 • 阅读 247

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

调试

前往【API Explorer】在线调试，API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力，能显著降低使用云 API 的难度，强烈推荐使用。

请求参数

名称 类型 是否必选 示例值 描述
RegionId String 是 cn-hangzhou

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

Action String 否 DescribeInvocations

系统规定参数。取值：DescribeInvocations

CommandId String 否 c-4d34302d02424c5c8e10281e3a315a05

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

CommandName String 否 Test1

命令名称。

CommandType String 否 RunShellScript

命令类型。

InstanceId String 否 i-uf614fhehhzxx

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

InvokeId String 否 t-7d2a745b412b4601b2d47f6a768d3b53

命令进程执行 ID。

InvokeStatus String 否 Finished

指定的命令总的执行状态。总的执行状态取决于指定命令管理的所有目标实例中的命令进程执行状态 InstanceInvokeStatus。取值范围：

  • Running：命令进程进行中
    • 周期执行：未手动停止周期执行命令前，命令进程一直为 进行中（Running）。
    • 单次执行：指定命令管理的所有目标实例中一旦有 进行中（Running）的命令进程，总的执行状态为 进行中（Running）。
  • Finished：命令进程执行完成
    • 周期执行：命令进程不可能为 执行完成（Finished）。
    • 单次执行：指定命令管理的所有目标实例全部执行完成，总的执行状态为 执行完成（Finished）。 或者 手动停止（Stopped）部分目标实例的命令进程，其余目标实例全部执行完成，总的执行状态为 执行完成（Finished）。
  • Failed：命令进程执行失败，命令进程出现超时情况或者其他异常
    • 周期执行：命令进程不可能为 执行失败（Failed）。
    • 单次执行：指定命令管理的所有目标实例全部执行失败，总的执行状态为 执行失败（Failed）。
  • PartialFailed：命令进程执行部分失败
    • 周期执行：命令进程不可能为 部分失败（PartialFailed）。
    • 单次执行：指定命令管理的所有目标实例中个别有 执行失败（Failed）的命令进程，总的执行状态为 部分失败（PartialFailed）。
  • Stopped：命令进程被手动停止
OwnerAccount String 否 ECSforCloud@Alibaba.com

RAM 用户的账号登录名称。

PageNumber Long 否 1

当前页码，起始值：1

默认值：1

PageSize Long 否 10

分页查询时设置的每页行数，最大值：50

默认值：10

Timed Boolean 否 true

命令是否为周期执行。默认值：False

返回参数

名称 类型 示例值 描述
Invocations

命令执行记录集类型（InvocationSetType）。

  └CommandId String c-4d34302d02424c5c8e10281e3a315a05

命令 ID。

  └CommandName String Test1

命令名称。

  └CommandType String RunShellScript

命令类型。

  └Frequency String 0 */20 * * * *

周期任务的执行周期。 该参数值结构以 Cron 表达式 为准。

  └InvokeId String t-7d2a745b412b4601b2d47f6a768d3b53

命令执行ID。

  └InvokeInstances

执行目标实例集类型（InvokeInstanceSetType）。

    └InstanceId String i-uf614fhehhzxx

实例ID。

    └InstanceInvokeStatus String Finished

指定实例的命令进程状态。

  • Running：命令进程进行中。
    • 周期执行：未手动停止周期执行命令前，命令进程一直为 进行中（Running）。
    • 单次执行：指定实例的命令进程状态为 进行中（Running）。
  • Finished：命令进程执行完成。
    • 周期执行：命令进程不可能为 执行完成（Finished）。
    • 单次执行：指定实例的命令进程状态为 执行完成（Finished）。
  • Failed：命令进程执行失败，命令进程出现超时情况或者其他异常。
    • 周期执行：命令进程不可能为 执行失败（Failed）。
    • 单次执行：指定实例的命令进程状态为 执行失败（Failed）。
  • Stopped：命令进程被手动停止 。
  └InvokeStatus String Finished

指定的命令总的执行状态。总的执行状态取决于指定命令管理的所有目标实例中的命令进程执行状态 InstanceInvokeStatus。取值范围：

  • Running：命令进程进行中。
    • 周期执行：未手动停止周期执行命令前，命令进程一直为 进行中（Running）。
    • 单次执行：指定命令管理的所有目标实例中一旦有 进行中（Running）的命令进程，总的执行状态为 进行中（Running）。
  • Finished：命令进程执行完成。
    • 周期执行：命令进程不可能为 执行完成（Finished）。
    • 单次执行：指定命令管理的所有目标实例全部执行完成，总的执行状态为 执行完成（Finished）。 或者 手动停止（Stopped）部分目标实例的命令进程，其余目标实例全部执行完成，总的执行状态为 执行完成（Finished）。
  • Failed：命令进程执行失败，命令进程出现超时情况或者其他异常。
    • 周期执行：命令进程不可能为 执行失败（Failed）。
    • 单次执行：指定命令管理的所有目标实例全部执行失败，总的执行状态为 执行失败（Failed）。
  • PartialFailed：命令进程执行部分失败。
    • 周期执行：命令进程不可能为 部分失败（PartialFailed）。
    • 单次执行：指定命令管理的所有目标实例中个别有 执行失败（Failed）的命令进程，总的执行状态为 部分失败（PartialFailed）。
  • Stopped：命令进程被手动停止 。
  └Timed Boolean false

是否为周期执行。

PageNumber Long 1

查询结果的页码。

PageSize Long 10

每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求 ID。无论调用接口成功与否，我们都会返回请求 ID。

TotalCount Long 2

命令总个数。

示例

请求示例


https://ecs.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&InvokeId=t-7d2a745b412b4601b2d47f6a768d3b53
&CommandId=c-4d34302d02424c5c8e10281e3a315a05
&CommandName=Test1
&CommandType=RunShellScript
&Timed=true
&InvokeStatus=Finished
&InstanceId=i-uf614fhehhzxx
&PageNumber=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeInvocationsResponse>
  <TotalCount>2</TotalCount>
  <PageNumber>1</PageNumber>
  <PageSize>10</PageSize>
  <Invocations>
    <Invocation>
      <InvokeStatus>Running</InvokeStatus>
      <InvokeId>t-7d2a745b412b4601b2d47f6a768d3b53</InvokeId>
      <CommandName>Test1</CommandName>
      <CommandType>RunShellScript</CommandType>
      <Frequency>0 */20 * * * *</Frequency>
      <InvokeInstances>
        <InvokeInstance>
          <InstanceId>i-uf614fhehhzmx</InstanceId>
          <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
        </InvokeInstance>
        <InvokeInstance>
          <InstanceId>i-uf614fhehhzmy</InstanceId>
          <InstanceInvokeStatus>Running</InstanceInvokeStatus>
        </InvokeInstance>
      </InvokeInstances>
      <Timed>True</Timed>
      <CommandId>c-7d2a745b412b4601b2d47f6a768d3a14</CommandId>
    </Invocation>
    <Invocation>
      <InvokeStatus>Finished</InvokeStatus>
      <InvokeId>t-7d2a745b412b4601b2d47f6a768d3b55</InvokeId>
      <CommandName>Test3</CommandName>
      <CommandType>RunShellScript</CommandType>
      <Frequency/>
      <InvokeInstances>
        <InvokeInstance>
          <InstanceId>i-uf614fhehhzmx</InstanceId>
          <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
        </InvokeInstance>
        <InvokeInstance>
          <InstanceId>i-uf64isakb713x</InstanceId>
          <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
        </InvokeInstance>
      </InvokeInstances>
      <Timed>False</Timed>
      <CommandId>c-7d2a745b412b4601b2d47f6a768d3a16</CommandId>
    </Invocation>
  </Invocations>
  <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
</DescribeInvocationsResponse>

JSON 格式 

{
	"PageNumber":1,
	"Invocations":{
		"Invocation":[
			{
				"CommandType":"RunShellScript",
				"CommandName":"Test1",
				"InvokeStatus":"Running",
				"InvokeId":"t-7d2a745b412b4601b2d47f6a768d3b53",
				"CommandId":"c-7d2a745b412b4601b2d47f6a768d3a14",
				"Timed":true,
				"InvokeInstances":{
					"InvokeInstance":[
						{
							"InstanceInvokeStatus":"Finished",
							"InstanceId":"i-uf614fhehhzmx"
						},
						{
							"InstanceInvokeStatus":"Running",
							"InstanceId":"i-uf64isakb713x"
						}
					]
				},
				"Frequency":"0 */20 * * * *"
			},
			{
				"CommandType":"RunShellScript",
				"CommandName":"Test3",
				"InvokeStatus":"Finished",
				"InvokeId":">t-7d2a745b412b4601b2d47f6a768d3b55",
				"CommandId":"c-7d2a745b412b4601b2d47f6a768d3a16",
				"Timed":false,
				"InvokeInstances":{
					"InvokeInstance":[
						{
							"InstanceInvokeStatus":"Finished",
							"InstanceId":"i-uf614fhehhzmx"
						},
						{
							"InstanceInvokeStatus":"Finished",
							"InstanceId":"i-uf64isakb713x"
						}
					]
				}
			}
		]
	},
	"TotalCount":2,
	"PageSize":10,
	"RequestId":"E69EF3CC-94CD-42E7-8926-F133B86387C0"
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError.Dispatch An error occurred when you dispatched the request. 发生未知错误。
403 InvalidParam.PageNumber The specified parameter is invalid. 指定的参数无效。
403 InvalidParam.PageSize The specified parameter is invalid. 指定的参数无效。
403 InvalidRegionId.CloudAssistant Current region is not available. 指定的地域暂不可用。

查看本产品错误码

微海报分享

发布者：佚, 佚名，转转请注明出处：https://www.cms2.cn/aliyun/1857.html

赞 (0)
打赏 微信扫一扫 微信扫一扫
佚, 佚名佚, 佚名
0
上一篇 2019年3月21日 pm8:45
下一篇 2019年3月21日 pm8:45

相关推荐

  • 创建GPU计算型实例 阿里云

    创建GPU计算型实例

    GPU计算型实例必须安装GPU驱动才可以使用。您可以在创建实例时自动安装GPU驱动，也可以在实例创建后手动安装GPU驱动。本文介绍如何创建GPU计算型实例并自动安装驱动。 注意事项 如果您使用了自动安装GPU驱动功能，请注意： 自动安装只支持Linux公共镜像。 自动安装过程受不…

    2019年3月21日
  • 事件通知概述 阿里云

    事件通知概述

    事件通知是一种监控手段，可以自动发送消息至云监控或消息服务，帮助您及时掌握伸缩组的动态，进一步实现自动化管理。 事件通知方式 事件通知支持发送消息到云监控系统事件、MNS主题或MNS队列。 云监控提供了各类云产品系统事件的统计和查询入口，包括弹性伸缩，您可以通过云监控及时了解伸缩…

    2019年3月21日
  • 大数据型 阿里云

    大数据型

    本文介绍大数据网络增强型实例规格族d1ne和大数据型实例规格族d1，并列出了具体的实例规格。 大数据型实例规格族介绍 d1ne 和 d1 是为 Hadoop 分布式计算、海量日志处理和大型数据仓库等业务场景设计的实例规格族，指在解决大数据时代下海量业务数据云上计算和存储难题。适用…

    2019年3月21日
  • 阿里云ECS云服务器使用限制详细说明 阿里云

    阿里云ECS云服务器使用限制详细说明

    通过本文，您会了解云服务器ECS在产品功能和服务性能上的不同限制，以及如何申请更高限额。 限制概述 使用云服务器ECS有下列限制： 不支持虚拟化软件安装和再进行虚拟化（如安装使用VMware）。目前，仅 弹性裸金属服务器 和 超级计算集群 支持再虚拟化。 不支持声卡应用。 不支持…

    2019年3月21日
  • EipAddressAssociateType 阿里云

    EipAddressAssociateType

    包含弹性公网 IP 绑定信息的类型。 节点名 接口决定。 子节点 名称 类型 描述 AllocationId String 弹性公网 IP 绑定的实例 ID。 IpAddress String 弹性公网 IP。 Bandwidth Integer 弹性公网 IP 的公网带宽限速，…

    2019年3月21日

  • 创建部署集

    本文描述了如何在ECS管理控制台上创建一个部署集。 背景信息 部署集是实例分布的控制策略，使您能在创建实例时就开始设计容灾能力和业务可用性。您可以使用部署集将业务涉及到的几台ECS实例分散部署在不同的物理服务器上，以此保证业务的高可用性和底层容灾能力。更多详情，请参阅部署集。如果…

    阿里云 2019年3月21日

发表评论

邮箱地址不会被公开。 必填项已用*标注

记住昵称、邮箱和网址，下次评论免输入