Queries the detailed information about historical jobs of a Spark virtual cluster (VC) in Data Lake Analytics in pages.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListSparkJob

The operation that you want to perform. Set the value to ListSparkJob.

PageNumber Integer Yes 1

The number of the page to return, which is used to traverse all data. Pages start from page 1.

PageSize Integer Yes 10

The number of entries to return on each page.

VcName String Yes MySparkCluster

The name of the VC.

Response parameters

Parameter Type Example Description
RequestId String E18B0634-F003-486A-90B9-4AA6932DA3AA

The unique ID of the request.

DataResult Struct

The result set of historical jobs of the VC.

JobList Array of Data

The array of historical jobs.

CreateTime String 2020-10-27 17:51:05

The time when the Spark job was created. The time zone of the region in which the VC resides is used.

CreateTimeValue String 1603792267000

The timestamp when the Spark job was created, in milliseconds.

Detail String {"args":["100"],"name":...}

The JSON string that describes the job.

DriverResourceSpec String small

The specifications of the driver that the job applies for.

ExecutorInstances String 100

The number of executors that the job applies for.

ExecutorResourceSpec String small

The specifications of executors that the job applies for.

JobId String j202010271750hangzhouf742a4330000950

The ID of the Spark job.

JobName String SparkPi

The name of the Spark job.

SparkUI String https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx

The UI for the Spark job. For more information about the related configurations, see Configure the Spark UI.

Status String running

The status code of the job.

SubmitTime String 2020-10-27 17:51:05

The time when the job was submitted. The time zone of the region in which the VC resides is used.

SubmitTimeValue String 1603792267000

The timestamp when the job was submitted, in milliseconds.

UpdateTime String 2020-10-27 17:51:05

The time when the job status was last updated. The time zone of the region in which the VC resides is used.

UpdateTimeValue String 1603792267000

The timestamp when the job was last updated, in milliseconds.

VcName String MyCluster

The name of the VC on which the job is run.

PageNumber String 1

The number of the page to return.

PageSize String 10

The number of entries to return on each page.

TotalCount String 4998

The total number of historical jobs that can be queried.

The following table describes the job status code.

Status code

Description

starting

The job is starting and has not been run.

running

The job is being run.

error

The execution of a program in the job failed and an exception is returned.

dead

The job failed due to issues such as insufficient resources.

killed

The job is canceled during execution.

success

The job succeeds.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListSparkJob
&PageNumber=1
&PageSize=10
&VcName=MySparkCluster
&<Common request parameters>

Sample success responses

XML format

<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 format

{
  "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"
}

Error codes

For a list of error codes, visit the API Error Center.