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

文档中心

立即注册

导航

云服务器

DescribeInvocationInstances

最近更新时间：2024.11.19 10:09:07首次发布时间：2023.09.04 15:43:19

调用DescribeInvocationInstances接口，查询批量作业执行对象列表。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeInvocationInstances	要执行的操作，取值：DescribeInvocationInstances。
Version	String	是	2020-04-01	接口的版本，取值：2020-04-01。
InvocationId	String	是	ivk-hz0jdfwd9f****	任务ID，您可以通过DescribeInvocations接口查询获取。
InstanceId	String	否	i-bp1i7gg30r52z2em****	实例ID。
PageNumber	Integer	否	1	当前页码。起始值：1。默认值：1。
PageSize	Integer	否	10	分页查询时设置的每页行数。取值范围：1~100。默认值：10。

返回数据

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

InvocationInstance 结构

名称	类型	示例值	描述
InvocationId	String	ivk-ycidmmvbm9l8j****	作业ID。
InstanceId	String	i-ybz88d9pstgh9****	实例ID。

请求示例

GET /?Action=DescribeInvocationInstances&Version=2020-04-01&InvocationId=ivk-2a745b412b4601b8d**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeInvocationInstances",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalCount": 1,
        "InvocationInstances": [
          {
                "InvocationId": "ivk-2a745b412b4601b8d****",
                "InstanceId": "i-ybz88d9pstgh9****"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	MissingParameter.InvocationId	The required InvocationId is not supplied.	作业 ID 不能为空。