调用ListSparkJob用于翻页提取某个数据湖分析Spark虚拟集群的历史作业详情信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListSparkJob |
系统规定参数。取值:ListSparkJob。 |
PageNumber | Integer | 是 | 1 |
指定需要查询的页码号,用于遍历全部数据,页码的编码从1开始。 |
PageSize | Integer | 是 | 10 |
每页返回的作业的个数。 |
VcName | String | 是 | MySparkCluster |
执行Spark作业的虚拟集群名称。 |
Condition | Json | 否 | { "createTime":"2020-12-28 09:00:00", "jobName":"SparkPi" } |
提取Spark虚拟集群的历史作业详情信息的过滤条件,不填写表示没有过滤条件。 |
Condition是一个JSON格式的字符串,目前支持如下参数。
- status:Spark作业的状态,取值如下。
- starting:提交中。
- running:运行中。
- success:成功。
- error:运行失败。
- killed:被取消。
- unknown:未知状态。
- dead:启动失败。
- createTime:代表筛选指定时间之后提交的作业,格式为yyyy-mm-dd HH:mm:ss,指定该参数的时候,同时需要指定timeZone。
- timeZone:createTime时间串所在的时区,例如 Asia/Shanghai。
- jobId:Spark作业的ID。
- jobName:Spark作业的名称,支持局部匹配。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E18B0634-F003-486A-90B9-4AA6932DA3AA |
本次请求的唯一编码。 |
DataResult | Struct |
虚拟集群的历史作业结果列表。 |
|
JobList | Array of Data |
历史作业详情数组。 |
|
CreateTime | String | 2020-10-27 17:51:05 |
创建Spark作业的时间点,时区为该集群所在的地域的时区。 |
CreateTimeValue | String | 1603792267000 |
创建Spark作业的毫秒级时间戳。 |
Detail | String | {"args":["100"],"name":...} |
描述此作业的JSON格式的字符串。 |
DriverResourceSpec | String | small |
作业所申请的Driver的实例规格。 |
ExecutorInstances | String | 100 |
作业所申请的Executor的数量。 |
ExecutorResourceSpec | String | small |
作业所申请的Executor的规格。 |
JobId | String | j202010271750hangzhouf742a4330000950 |
Spark作业的ID。 |
JobName | String | SparkPi |
Spark作业的名称。 |
SparkUI | String | https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx |
Spark作业的UI,具体请参考文档Spark UI。 |
Status | String | running |
作业的状态码。 |
SubmitTime | String | 2020-10-27 17:51:05 |
提交作业的时间,时区为该集群所在的地域的时区。 |
SubmitTimeValue | String | 1603792267000 |
提交作业的毫秒级时间戳。 |
UpdateTime | String | 2020-10-27 17:51:05 |
最后一次更新作业状态的时间,时区为该集群所在的地域的时区。 |
UpdateTimeValue | String | 1603792267000 |
最后一次更新作业状态的毫秒级时间戳。 |
VcName | String | MyCluster |
执行作业的虚拟集群名称。 |
PageNumber | String | 1 |
当前请求返回的页码。 |
PageSize | String | 10 |
当前请求返回的每页作业数量。 |
TotalCount | String | 4998 |
当前可查询的历史作业的总数。 |
状态码 |
语义 |
---|---|
starting |
启动中,作业尚未执行。 |
running |
作业在执行中。 |
error |
作业中的程序执行失败,抛出了Exception。 |
dead |
作业因为资源问题等问题失败。 |
killed |
作业在执行中被取消。 |
success |
作业执行成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListSparkJob
&PageNumber=1
&PageSize=10
&VcName=MySparkCluster
&<公共请求参数>
正常返回示例
XML
格式
<DataResult>
<TotalCount>4998</TotalCount>
<PageSize>2</PageSize>
<PageNumber>1</PageNumber>
<JobList>
<ExecutorInstances>2</ExecutorInstances>
<Status>success</Status>
<VcName>MyCluster</VcName>
<SparkUI>https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx</SparkUI>
<DriverResourceSpec>small</DriverResourceSpec>
<CreateTime>2020-10-27 17:51:07</CreateTime>
<JobName>localFile</JobName>
<ExecutorResourceSpec>small</ExecutorResourceSpec>
<SubmitTime>2020-10-27 17:50:43</SubmitTime>
<CreateTimeValue>1603792267000</CreateTimeValue>
<UpdateTimeValue>1603792302000</UpdateTimeValue>
<SubmitTimeValue>1603792243000</SubmitTimeValue>
<UpdateTime>2020-10-27 17:51:42</UpdateTime>
<Detail>{"args":["100"],"name"f}</Detail>
<JobId>j202010271750hangzhouf742a4330000950</JobId>
</JobList>
<JobList>
<ExecutorInstances>2</ExecutorInstances>
<Status>error</Status>
<VcName>MyCluster</VcName>
<SparkUI>https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx</SparkUI>
<DriverResourceSpec>small</DriverResourceSpec>
<CreateTime>2020-10-27 17:51:05</CreateTime>
<JobName>localFile</JobName>
<ExecutorResourceSpec>small</ExecutorResourceSpec>
<SubmitTime>2020-10-27 17:50:39</SubmitTime>
<CreateTimeValue>1603792265000</CreateTimeValue>
<UpdateTimeValue>1603792300000</UpdateTimeValue>
<SubmitTimeValue>1603792239000</SubmitTimeValue>
<UpdateTime>2020-10-27 17:51:40</UpdateTime>
<Detail>{"args":["100"],"name"f}</Detail>
<JobId>j202010271750hangzhouf742a4330000949</JobId>
</JobList>
</DataResult>
<RequestId>E18B0634-F003-486A-90B9-4AA6932DA3AA</RequestId>
JSON
格式
{
"DataResult": {
"TotalCount": 4998,
"PageSize": 2,
"PageNumber": 1,
"JobList": [
{
"ExecutorInstances": 2,
"Status": "success",
"VcName": "MyCluster",
"SparkUI": "https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx",
"DriverResourceSpec": "small",
"CreateTime": "2020-10-27 17:51:07",
"JobName": "localFile",
"ExecutorResourceSpec": "small",
"SubmitTime": "2020-10-27 17:50:43",
"CreateTimeValue": 1603792267000,
"UpdateTimeValue": 1603792302000,
"SubmitTimeValue": 1603792243000,
"UpdateTime": "2020-10-27 17:51:42",
"Detail": "{\"args\":[\"100\"],\"name\"f}",
"JobId": "j202010271750hangzhouf742a4330000950"
},
{
"ExecutorInstances": 2,
"Status": "error",
"VcName": "MyCluster",
"SparkUI": "https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx",
"DriverResourceSpec": "small",
"CreateTime": "2020-10-27 17:51:05",
"JobName": "localFile",
"ExecutorResourceSpec": "small",
"SubmitTime": "2020-10-27 17:50:39",
"CreateTimeValue": 1603792265000,
"UpdateTimeValue": 1603792300000,
"SubmitTimeValue": 1603792239000,
"UpdateTime": "2020-10-27 17:51:40",
"Detail": "{\"args\":[\"100\"],\"name\"f}",
"JobId": "j202010271750hangzhouf742a4330000949"
}
]
},
"RequestId": "E18B0634-F003-486A-90B9-4AA6932DA3AA"
}
错误码
访问错误中心查看更多错误码。