Job runs

Download schema

A job run is the execution of a job definition

List all job runs with filters

GET

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/job-runs

List all job runs with filters › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all job runs with filters › query Parameters

page

integer · int32

page_size

integer · uint32

order_by

scaleway.serverless_jobs.v1alpha2.ListJobRunsRequest.OrderBy · enum

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

job_definition_id

string

project_id

string

organization_id

string

state

scaleway.serverless_jobs.v1alpha2.JobRun.State · enum

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

Default: unknown_state

states

scaleway.serverless_jobs.v1alpha2.JobRun.State[]

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

reasons

scaleway.serverless_jobs.v1alpha2.JobRun.Reason[]

Enum values:

unknown_reason

invalid_request

timeout

cancellation

technical_error

image_not_found

invalid_image

memory_usage_exceeded

List all job runs with filters › Responses

200

scaleway.serverless_jobs.v1alpha2.ListJobRunsResponse

scaleway.serverless_jobs.v1alpha2.JobRun[]

total_count

integer · uint64

GET/serverless-jobs/v1alpha2/regions/{region}/job-runs

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/serverless-jobs/v1alpha2/regions/{region}/job-runs"

Example Responses

{
  "job_runs": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "job_definition_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "started_at": "2022-03-22T12:34:56.123456Z",
      "terminated_at": "2022-03-22T12:34:56.123456Z",
      "run_duration": "2.5s",
      "state": "unknown_state",
      "reason": "unknown_reason",
      "exit_code": 0,
      "error_message": "error_message",
      "cpu_limit": 0,
      "memory_limit": 0,
      "local_storage_capacity": 0,
      "command": "command",
      "environment_variables": {
        "<environment_variableKey>": "<environment_variableKey>"
      },
      "startup_command": [
        "string"
      ],
      "args": [
        "string"
      ],
      "attempts": 0,
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Get a job run by its unique identifier

GET

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}

Get a job run by its unique identifier › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

job_run_id

string · required

UUID of the job run to get.

Get a job run by its unique identifier › Responses

200

scaleway.serverless_jobs.v1alpha2.JobRun

id

string

UUID of the job run. (UUID format)

job_definition_id

string

UUID of the job definition. (UUID format)

created_at

string · date-time

Creation date of the job run. (RFC 3339 format)

updated_at

string · date-time

Last update date of the job run. (RFC 3339 format)

started_at

string · date-time

Start date of the job run. (RFC 3339 format)

terminated_at

string · date-time

Termination date of the job run. (RFC 3339 format)

run_duration

string

Duration of the job run. (in seconds)

state

string · enum

State of the job run.

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

Default: unknown_state

reason

string · enum

Reason for failure if the job failed.

Enum values:

unknown_reason

invalid_request

timeout

cancellation

technical_error

image_not_found

invalid_image

memory_usage_exceeded

Default: unknown_reason

exit_code

integer · int32

Exit code of the job.

error_message

string

Error message if the job failed.

cpu_limit

integer · uint32

CPU limit of the job (in mvCPU).

memory_limit

integer · uint32

Memory limit of the job (in MiB).

local_storage_capacity

integer · uint32

Local storage capacity of the job (in MiB).

object

Environment variables of the job run.

startup_command

string[]

Job startup command.

args

string[]

Job arguments passed to the startup command at runtime.

attempts

integer · uint32

Number of retry attempts.

region

string

The region you want to target

GET/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "job_definition_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "started_at": "2022-03-22T12:34:56.123456Z",
  "terminated_at": "2022-03-22T12:34:56.123456Z",
  "run_duration": "2.5s",
  "state": "unknown_state",
  "reason": "unknown_reason",
  "exit_code": 0,
  "error_message": "error_message",
  "cpu_limit": 0,
  "memory_limit": 0,
  "local_storage_capacity": 0,
  "command": "command",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "startup_command": [
    "string"
  ],
  "args": [
    "string"
  ],
  "attempts": 0,
  "region": "region"
}

json

application/json

Stop a job run using its unique identifier

POST

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}/stop

Stop a job run using its unique identifier › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

job_run_id

string · required

UUID of the job run to stop.

Stop a job run using its unique identifier › Request Body

Stop a job run using its unique identifier › Responses

200

scaleway.serverless_jobs.v1alpha2.JobRun

id

string

UUID of the job run. (UUID format)

job_definition_id

string

UUID of the job definition. (UUID format)

created_at

string · date-time

Creation date of the job run. (RFC 3339 format)

updated_at

string · date-time

Last update date of the job run. (RFC 3339 format)

started_at

string · date-time

Start date of the job run. (RFC 3339 format)

terminated_at

string · date-time

Termination date of the job run. (RFC 3339 format)

run_duration

string

Duration of the job run. (in seconds)

state

string · enum

State of the job run.

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

Default: unknown_state

reason

string · enum

Reason for failure if the job failed.

Enum values:

unknown_reason

invalid_request

timeout

cancellation

technical_error

image_not_found

invalid_image

memory_usage_exceeded

Default: unknown_reason

exit_code

integer · int32

Exit code of the job.

error_message

string

Error message if the job failed.

cpu_limit

integer · uint32

CPU limit of the job (in mvCPU).

memory_limit

integer · uint32

Memory limit of the job (in MiB).

local_storage_capacity

integer · uint32

Local storage capacity of the job (in MiB).

object

Environment variables of the job run.

startup_command

string[]

Job startup command.

args

string[]

Job arguments passed to the startup command at runtime.

attempts

integer · uint32

Number of retry attempts.

region

string

The region you want to target

POST/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}/stop

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}/stop"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "job_definition_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "started_at": "2022-03-22T12:34:56.123456Z",
  "terminated_at": "2022-03-22T12:34:56.123456Z",
  "run_duration": "2.5s",
  "state": "unknown_state",
  "reason": "unknown_reason",
  "exit_code": 0,
  "error_message": "error_message",
  "cpu_limit": 0,
  "memory_limit": 0,
  "local_storage_capacity": 0,
  "command": "command",
  "environment_variables": {
    "<environment_variableKey>": "<environment_variableKey>"
  },
  "startup_command": [
    "string"
  ],
  "args": [
    "string"
  ],
  "attempts": 0,
  "region": "region"
}

json

application/json

Job definitions Secrets

List all job runs with filters

GET

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/job-runs

List all job runs with filters › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all job runs with filters › query Parameters

page

integer · int32

page_size

integer · uint32

order_by

scaleway.serverless_jobs.v1alpha2.ListJobRunsRequest.OrderBy · enum

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

job_definition_id

string

project_id

string

organization_id

string

state

scaleway.serverless_jobs.v1alpha2.JobRun.State · enum

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

Default: unknown_state

states

scaleway.serverless_jobs.v1alpha2.JobRun.State[]

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

reasons

scaleway.serverless_jobs.v1alpha2.JobRun.Reason[]

Enum values:

unknown_reason

invalid_request

timeout

cancellation

technical_error

image_not_found

invalid_image

memory_usage_exceeded

List all job runs with filters › Responses

200

scaleway.serverless_jobs.v1alpha2.ListJobRunsResponse

scaleway.serverless_jobs.v1alpha2.JobRun[]

total_count

integer · uint64

Get a job run by its unique identifier

GET

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}

Get a job run by its unique identifier › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

job_run_id

string · required

UUID of the job run to get.

Get a job run by its unique identifier › Responses

200

scaleway.serverless_jobs.v1alpha2.JobRun

id

string

UUID of the job run. (UUID format)

job_definition_id

string

UUID of the job definition. (UUID format)

created_at

string · date-time

Creation date of the job run. (RFC 3339 format)

updated_at

string · date-time

Last update date of the job run. (RFC 3339 format)

started_at

string · date-time

Start date of the job run. (RFC 3339 format)

terminated_at

string · date-time

Termination date of the job run. (RFC 3339 format)

run_duration

string

Duration of the job run. (in seconds)

state

string · enum

State of the job run.

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

Default: unknown_state

reason

string · enum

Reason for failure if the job failed.

Enum values:

unknown_reason

invalid_request

timeout

cancellation

technical_error

image_not_found

invalid_image

memory_usage_exceeded

Default: unknown_reason

exit_code

integer · int32

Exit code of the job.

error_message

string

Error message if the job failed.

cpu_limit

integer · uint32

CPU limit of the job (in mvCPU).

memory_limit

integer · uint32

Memory limit of the job (in MiB).

local_storage_capacity

integer · uint32

Local storage capacity of the job (in MiB).

object

Environment variables of the job run.

startup_command

string[]

Job startup command.

args

string[]

Job arguments passed to the startup command at runtime.

attempts

integer · uint32

Number of retry attempts.

region

string

The region you want to target

Stop a job run using its unique identifier

POST

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/job-runs/{job_run_id}/stop

Stop a job run using its unique identifier › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

job_run_id

string · required

UUID of the job run to stop.

Stop a job run using its unique identifier › Request Body

Stop a job run using its unique identifier › Responses

200

scaleway.serverless_jobs.v1alpha2.JobRun

id

string

UUID of the job run. (UUID format)

job_definition_id

string

UUID of the job definition. (UUID format)

created_at

string · date-time

Creation date of the job run. (RFC 3339 format)

updated_at

string · date-time

Last update date of the job run. (RFC 3339 format)

started_at

string · date-time

Start date of the job run. (RFC 3339 format)

terminated_at

string · date-time

Termination date of the job run. (RFC 3339 format)

run_duration

string

Duration of the job run. (in seconds)

state

string · enum

State of the job run.

Enum values:

unknown_state

initialized

validated

queued

running

succeeded

failed

interrupting

Default: unknown_state

reason

string · enum

Reason for failure if the job failed.

Enum values:

unknown_reason

invalid_request

timeout

cancellation

technical_error

image_not_found

invalid_image

memory_usage_exceeded

Default: unknown_reason

exit_code

integer · int32

Exit code of the job.

error_message

string

Error message if the job failed.

cpu_limit

integer · uint32

CPU limit of the job (in mvCPU).

memory_limit

integer · uint32

Memory limit of the job (in MiB).

local_storage_capacity

integer · uint32

Local storage capacity of the job (in MiB).

object

Environment variables of the job run.

startup_command

string[]

Job startup command.

args

string[]

Job arguments passed to the startup command at runtime.

attempts

integer · uint32

Number of retry attempts.

region

string

The region you want to target