Operations: list

Lists long-running operations that match the specified filter in the request.

Required permissions

The authenticated user must have the following IAM permissions on the bucket to use this method:

  • storage.bucketOperations.list

Request

HTTP request

GET https://storage.googleapis.com/storage/v1/b/bucket/operations

In addition to standard query parameters, the following query parameters apply to this method.

To see an example of how to include query parameters in a request, see the JSON API Overview page.

Parameters

Parameter name Value Description
Path parameters
bucket string Name of a bucket.
Optional query parameters
pageSize string The maximum number of items to return in a single response.
pageToken string

A previously-returned page token representing part of the larger set of results to view.

The pageToken is an encoded field containing the name of the last item in the returned list. In a subsequent request using the pageToken, items that come after the pageToken are shown (up to pageSize).

filter string

A filter for returning items. Items can be filtered using the following metadata:

  • createTime
  • completeTime
  • updateTime
  • type
  • requestedCancellation
  • done

The syntax requires EBNF grammar.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "storage#operations",
  "nextPageToken": string,
  "operations": [
    operations Resource
  ]
}
Property name Value Description Notes
kind string The kind of item this is. For lists of long-running operations, this is always "storage#operations".
nextPageToken string The continuation token. Provide this value as the pageToken of a subsequent request in order to return the next page of results. Note that the next page may be empty. If this is the last page of results, then no continuation token is returned. The presence of this parameter in the response should always be checked to ensure a complete listing of all the results.

The nextPageToken is the name of the last long-running operation in the returned list. In a subsequent list request using the pageToken, items that come after the token are shown (up to maxResults).
operations[] list The list of long-running operations.

For information about status and error codes returned by this API, see the reference page.