Method: projects.locations.jobs.cancel

Cancels a batch job for a given project.

IAM Permissions:

Requires storagebatchoperations.jobs.cancel IAM permission on the project.

HTTP request

POST https://storagebatchoperations.googleapis.com/v1/{name=projects/*/locations/global/jobs/*}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the job to cancel.

Format: projects/{projectId}/locations/global/jobs/{jobId}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestId": string
}
Fields
requestId

string

Optional. A unique identifier for your request. Specify the request ID, if you need to retry the request. If you retry the request with the same ID within 60 minutes, the server ignores the request if it has already completed the original request.

For example, if your initial request times out and you retry the request using the same request ID, the server recognizes the original request and does not process the new request.

The request ID must be a valid UUID and cannot be a zero UUID (00000000-0000-0000-0000-000000000000).

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.