Batch API
It provides methods to create and list batch jobs, manage their long-running operations (including get, list, cancel, and delete), report agent state, and retrieve tasks and supported locations for the service.
Latency
280ms p95
Uptime
100.0% 30d
Playground
Verified
live
Endpoints
/v1/{name}/operations
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
/v1/{name}
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
/v1/{name}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
/v1/{name}/locations
Lists information about the supported locations for this service.
/v1/{name}:cancel
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
/v1/{parent}/jobs
List all Jobs for a project within a region.
/v1/{parent}/jobs
Create a Job.
/v1/{parent}/state:report
Report agent's state, e.g. agent status and tasks information
/v1/{parent}/tasks
List Tasks associated with a job.
9 endpoints auto-detected
Authentication
This API requires authentication: OAuth.
curl -X GET \
"https://batch.googleapis.com/v1/{name}/operations"batch.googleapis.com · HTTPS only