DescribeInvocationResults--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeInvocationResults

最近更新时间：2024.06.13 14:26:07首次发布时间：2023.09.04 15:43:19

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeInvocationResults	要执行的操作，取值：DescribeInvocationResults
Version	String	是	2020-04-01	接口的版本，取值：2020-04-01。
InvocationId	String	是	ivk-ycidmmvbm9l8j***	作业ID，您可以调用DescribeInvocations接口查询获取。
InstanceId	String	否	i-bp1i7gg30r52z2em****	实例ID。
CommandId	String	否	cmd-hz0jdfwcsr****	命令ID。
InvocationResultStatus	String	否	Running	单台实例执行命令的状态，取值： Pending：初始状态，命令正在等待调度执行。 Running：命令运行中。 Success：命令执行完成，执行成功。 Failed：命令执行完成，执行失败。 Timeout：命令执行超时。
PageNumber	Integer	否	1	当前页码。起始值：1。默认值：1。
PageSize	Integer	否	1	分页查询时设置的每页行数。取值范围：1~100。默认值：10。

返回数据

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

InvocationResult 结构

名称	类型	示例值	描述
InvocationResultId	String	ivr-ycidmmvbm****	作业执行结果ID。
InvocationId	String	ivk-ycidmmvbm9l8j****	作业ID。
CommandId	String	cmd-ybtvqkikdih96z8****	命令ID。
InstanceId	String	i-ychq95dknz5pk****	实例ID。
InvocationResultStatus	String	Pending	单台实例的命令进度状态。
Username	String	root	在ECS实例中执行命令的用户名称。
Output	String	success	经过Base64编码的命令执行后输出信息。
ExitCode	Integer	0	脚本执行后的退出状态码。
ErrorCode	String	TaskExecutionTimeout	命令执行失败的错误码。取值： TaskDeliveryTimeout：表示命令下发超时。 TaskExecutionTimeout：表示命令执行超时。 TaskExecutionFailed：表示命令执行失败。
ErrorMessgae	String	Task execution timeout	命令执行失败的错误信息。
StartTime	String	2023-06-30T09:00:45Z	命令在实例中开始执行的时间。
EndTime	String	2023-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",
                    "ErrorMessgae": "Task execution timeout"
                }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。