Batch API

An API to manage the running of batch jobs on Google Cloud Platform.

Service: batch.googleapis.com

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://batch.googleapis.com

REST Resource: v1alpha.projects.locations.jobs

Methods
create POST /v1alpha/{parent=projects/*/locations/*}/jobs
Create a Job.
delete DELETE /v1alpha/{name=projects/*/locations/*/jobs/*}
Delete a Job.
get GET /v1alpha/{name=projects/*/locations/*/jobs/*}
Get a Job specified by its resource name.
list GET /v1alpha/{parent=projects/*/locations/*}/jobs
List all Jobs for a project within a region.

REST Resource: v1alpha.projects.locations.jobs.taskGroups.tasks

Methods
get GET /v1alpha/{name=projects/*/locations/*/jobs/*/taskGroups/*/tasks/*}
Return a single Task.
list GET /v1alpha/{parent=projects/*/locations/*/jobs/*/taskGroups/*}/tasks
List Tasks associated with a job.

REST Resource: v1.projects.locations.jobs

Methods
create POST /v1/{parent=projects/*/locations/*}/jobs
Create a Job.
delete DELETE /v1/{name=projects/*/locations/*/jobs/*}
Delete a Job.
get GET /v1/{name=projects/*/locations/*/jobs/*}
Get a Job specified by its resource name.
list GET /v1/{parent=projects/*/locations/*}/jobs
List all Jobs for a project within a region.

REST Resource: v1.projects.locations.jobs.taskGroups.tasks

Methods
get GET /v1/{name=projects/*/locations/*/jobs/*/taskGroups/*/tasks/*}
Return a single Task.
list GET /v1/{parent=projects/*/locations/*/jobs/*/taskGroups/*}/tasks
List Tasks associated with a job.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年07月09日 UTC.