DescribeInvocationResults - 查看命令执行结果--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeInvocationResults - 查看命令执行结果

最近更新时间：2025.01.02 14:37:13首次发布时间：2023.09.04 15:43:19

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

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	分页查询时设置的每页行数。
TotalCount	Integer	100	执行结果总个数。
InvocationResults	Array of Object	--	符合条件的命令执行结果信息。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023083016*****",
        "Action": "DescribeInvocationResults",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageSize": 10,
        "PageNumber": 1,
        "TotalCount": 1,
        "InvocationResults": [
            {
                "InvocationResultId": "ivr-ycmppwq****",
                "InvocationId": "ivk-ycmpp*****",
                "CommandId": "cmd-ycmpnj****",
                "InstanceId": "i-ycmd005****",
                "InvocationResultStatus": "Success",
                "Username": "root",
                "Output": "aGVsbG8gd29ybGQh",
                "ExitCode": 0,
                "StartTime": "2022-08-29T09:10:16Z",
                "EndTime": "2022-08-29T09:10:16Z",
                "ErrorCode": "",
                "ErrorMessage": ""
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	用户ID不能为空。
400	MissingParameter.InvocationId	The required InvocationId is not supplied.	作业 ID 不能为空。
400	InvalidInvocationResultStatus.Malformed	The specified InvocationResultStatus is malformed.	指定的作业执行结果状态不合法。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。