You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeInvocationResults

最近更新时间：2023.11.20 19:43:07

首次发布时间：2023.09.04 15:43:19

我的收藏

调用DescribeInvocationResults接口，查看一条或多条批量作业的执行结果。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填示例值描述
ActionString是DescribeInvocationResults要执行的操作，取值：DescribeInvocationResults
VersionString是2020-04-01接口的版本，取值：2020-04-01。
InvocationIdString是ivk-ycidmmvbm9l8j***作业ID，您可以调用DescribeInvocations接口查询获取。
InstanceIdString否i-bp1i7gg30r52z2em****实例ID。
CommandIdString否cmd-hz0jdfwcsr****命令ID。

InvocationResultStatus

String

否

Running

单台实例执行命令的状态，取值：

  • Pending：初始状态，命令正在等待调度执行。
  • Running：命令运行中。
  • Success：命令执行完成，执行成功。
  • Failed：命令执行完成，执行失败。
  • Timeout：命令执行超时。

PageNumber

Integer

否

1

当前页码。

  • 起始值：1。
  • 默认值：1。

PageSize

Integer

否

1

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

  • 取值范围：1~100。
  • 默认值：10。

返回数据

名称类型示例值描述
PageSizeInteger10分页查询时设置的每页行数。
PageNumberInteger1当前页码。
TotalCountInteger1执行结果总个数。
InvocationResultsArray of Struct-符合条件的命令执行结果信息。具体请参见下表“InvocationResult 结构”。

InvocationResult 结构

名称类型示例值描述
InvocationResultIdStringivr-ycidmmvbm****作业执行结果ID。
InvocationIdStringivk-ycidmmvbm9l8j****作业ID。
CommandIdStringcmd-ybtvqkikdih96z8****命令ID。
InstanceIdStringi-ychq95dknz5pk****实例ID。
InvocationResultStatusStringPending单台实例的命令进度状态。
UsernameStringroot在ECS实例中执行命令的用户名称。
OutputStringsuccess经过Base64编码的命令执行后输出信息。
ExitCodeInteger0脚本执行后的退出状态码。

ErrorCode

String

TaskExecutionTimeout

命令执行失败的错误码。取值：

  • TaskDeliveryTimeout：表示命令下发超时。
  • TaskExecutionTimeout：表示命令执行超时。
  • TaskExecutionFailed：表示命令执行失败。
ErrorMessgaeStringTask execution timeout命令执行失败的错误信息。
StartTimeString2023-06-30T09:00:45Z命令在实例中开始执行的时间。
EndTimeString2023-07-01T09:00:45Z命令执行的完成时间。

请求示例

GET /?Action=DescribeInvocationResults&Version=2020-04-01&InvocationId=ivr-ycidmmvbm**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeInvocationResults",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalCount": 1,
        "InvocationResults": [
            {
                    "invocationResultId": "ivr-ycidmmvbm****",
                    "invocationId": "ivk-ycidmmvbm9l8****",
                    "commandId": "cmd-ybtvqkikdih96****",
                    "instanceId": "i-ychq95dknz5p****",
                    "invocationResultStatus": "Pending",
                    "username": "root",
                    "output": "success",             
                    "startTime": "2023-06-30T09:00:45Z",
                    "endTime": "2023-07-01T09:00:45Z",
                    "ExitCode": 0,
                    "errorCode": "TaskExecutionTimeout",
                    "errorMessage": "Task execution timeout"
                }
        ]
    }
}