ListJobInstances - 作业实例列表--E-MapReduce-火山引擎

文档中心

立即注册

导航

ListJobInstances - 作业实例列表

最近更新时间：2025.01.16 16:21:53首次发布时间：2025.01.16 15:54:37

查看作业实例列表。

使用场景

调用 ListJobInstances，查看作业实例列表。

注意事项

已拥有火山引擎账号并开通 EMR 权限。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Version=2024-06-13&Action=ListJobInstances

请求参数

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

字段	类型	是否必填	示例值	描述
JobInstanceKeyword	String	否	"preprocess" "spark-123"	查询关键词，在执行查询时，会查找该用户所有名称或 ID 包含该关键词的作业实例说明若不提供，则查询满足其它条件的所有作业实例。
JobDefinitionIds	Array of String	否	["jobdef-xxx"]	根据作业定义 ID（列表）进行匹配查询
JobDefinitionKeyword	String	否	"preprocess" "spark-123"	查询关键词，在执行查询时，会查找该用户所有名称或 ID 包含该关键词的作业定义说明若不提供，则查询满足其它条件的所有作业实例。
JobTypes	Array of String	否	["Ray Job"] ["Spark JAR", "Ray Job"]	根据作业类型进行筛选。可多选
ExecutionEngines	Array of String	否	["Ray Job"]	根据执行引擎进行筛选。可多选
JobInstanceStates	Array of String	否	["RUNNING"] ["FAILED", "SUCCEEDED"]	根据作业实例状态进行筛选。可多选
SubmitTimeInterval	SubmitTimeInterval	否	参考下文	提交时间的区间。用于根据提交时间的区间做筛选。筛选时，将区间视为“左闭右闭”区间
ResourceTypes	Array of String	否	["EMR on VKE"]	根据资源类型进行筛选。可多选
ResourceKeyword	String	否	"测试集群" "emr-"	查询关键词，在执行查询时，会查找该用户所有“资源名称或资源 ID 包含该关键词”的资源上的作业说明若不提供，则查询满足其它条件的所有作业。
Submitters	Array of String	否	["user"]	根据作业实例提交人进行筛选。可多选
SortBy	Array of SortBySpec	否	参考下文	排序规则注意有多个 SortBySpec，其排列顺序代表用于排序的属性的排序优先级——先用最高优先级的属性来排序，若有并列排名，则针对并列排名的记录，按照“次一级优先级的属性”来排序，依此类推，直到不存在并列排名的记录，或者所有 SortBySpec 都用完。
MaxResults	Integer	否	10	单页最大返回结果，1-100，默认为 10
NextToken	Integer	否	0	分页查询下一页 token，默认 0

SubmitTimeInterval 类型的字段及说明如下：

字段	类型	是否必填	示例值	描述
BeginTimeMs	Long	否	1717200000000	提交时间的区间的开始时间点单位：毫秒说明若不提供，则按 0 处理。
EndTimeMs	Long	否	1717203600000	提交时间的区间的结束时间点单位：毫秒说明若不提供，则按 MAX 处理。

SortBySpec 类型的字段及说明如下：

字段	类型	是否必填	示例值	描述
AttributeName	String	是	"SubmitTime" "EndTime"	用于排序的属性名称
SortDirection	String	否	"ASC" "DESC"	排序方向：升序、降序（ASC, DESC 字样，大小写不敏感。）说明若不提供，则按 ASC 处理。

请求示例

{
    "JobInstanceKeyword": "spark-123",
    "JobDefinitionKeyword": "spark-123",
    "JobTypes": ["SparkSQL"],
    "JobInstanceStates": ["SUCCEEDED", "FAILED"],
    "SubmitTimeInterval":
    {
        "BeginTimeMs": 1717200000000,
        "EndTimeMs": 1717203600000
    }
    "ResourceTypes": ["EMR on VKE"],
    "ResourceIds": ["emr-xxxxxx"],
    "Submitters": ["user"],
    "SortBy":
    [
        {
            "AttributeName": "SubmitTime",
            "SortDirection": "DESC"
        }
    ],
    "MaxResults": 10,
    "NextToken": 0
}

返回示例

{    
    "Result": {
        "Items": [
            {
                "JobInstanceId": "application-xxxxxx",
                "JobInstanceName": "data_preprocess",
                "JobDefinitionId": "jobdef-xxxxxx",
                "JobDefinitionName": "data_preprocess_def",
                "JobType": "Spark JAR",
                "ExecutionEngine": "Spark",
                "JobInstanceState": "RUNNING",
                "ResourceType": "EMR on VKE",
                "ResourceId": "emr-xxxxxx",
                "ResourceName": "onvke-cluster1",
                "AllocatedCpuVirtualCoreNum": 100,
                "AllocatedMemoryGiB": 100,
                "Submitter": "user",
                "SubmitTimeMs": 1717201800000,
                "EndTimeMs": 1717201860000,
                "DurationTimeMs": 60000,
                "WebUI": {
                    "Name": "Spark UI",
                    "Address": "http://xxx",
                    "Accessible": true
                },
                "Killable": true,
                "AccountId": 00000000
            },
            ...
        ],
        "TotalCount": 1,
        "NextToken": 1,
        "MaxResults": 10
    }
}

错误码

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