run a job

POST 
/metalakes/:metalake/jobs/runs

Runs a job based on the specified job template in the specified metalake

Request

Path Parameters

metalake stringrequired

The name of the metalake

application/json

Body

jobTemplateName stringrequired

The name of the job template to run

jobConf

object

The job configuration for the job run

property name* string

Responses

200

Returns the empty response with status code 0

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

job

object

A job object

jobId stringrequired

The unique identifier of the job

jobTemplateName stringrequired

The name of the job template used to create the job

status stringrequired

Possible values: [queued, started, failed, succeeded, cancelling, canceled]

The status of the job

audit

object

required

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

Example (from schema)

{
  "code": 0,
  "job": {
    "jobId": "string",
    "jobTemplateName": "string",
    "status": "queued",
    "audit": {
      "creator": "string",
      "createTime": "2024-07-29T15:51:28.071Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-07-29T15:51:28.071Z"
    }
  }
}

404

Not Found - The specified job template does not exist in the specified metalake

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

JobTemplateAlreadyExistsException

{
  "code": 1003,
  "type": "NoSuchJobTemplateException",
  "message": "Failed to operate job template(s) [my_job] operation [GET] under metalake [my_test_metalake], reason [NoSuchJobTemplateException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchJobTemplateException: Job template xxx does not exist",
    "..."
  ]
}

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...