- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form projects/<project>/instanceConfigs/<instanceConfig>/operations/<operation>
. The long-running operation metadata field type metadata.type_url
describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.start_time
in descending order starting from the most recently started operation.
HTTP request
The URLs use gRPC Transcoding syntax.
Path parameters
parent
string
Required. The project of the instance configuration operations. Values are of the form projects/<project>
.
Authorization requires the following IAM
permission on the specified resource parent
:
-
spanner.instanceConfigOperations.list
Query parameters
filter
string
An expression that filters the list of returned operations.
A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <
, >
, <=
, >=
, !=
, =
, or :
. Colon :
is the contains operator. Filter rules are not case sensitive.
The following fields in the Operation are eligible for filtering:
-
name- The name of the long-running operation -
done- False if the operation is in progress, else true. -
metadata.@type- the type of metadata. For example, the type string forCreateInstanceConfigMetadataistype.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata. -
metadata.<field_name>- any field in metadata.value.metadata.@typemust be specified first, if filtering on metadata fields. -
error- Error associated with the long-running operation. -
response.@type- the type of response. -
response.<field_name>- any field in response.value.
You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
-
done:true- The operation is complete. -
(metadata.@type=\type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND\(metadata.instance_config.name:custom-config) AND\(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND\(error:*)- Return operations where:- The operation's metadata type is
CreateInstanceConfigMetadata. - The instance configuration name contains "custom-config".
- The operation started before 2021-03-28T14:50:00Z.
- The operation resulted in an error.
- The operation's metadata type is
pageSize
integer
Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken
string
If non-empty, pageToken
should contain a nextPageToken
from a previous ListInstanceConfigOperationsResponse
to the same parent
and with the same filter
.
Request body
The request body must be empty.
Response body
The response for instanceConfigOperations.list
.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"operations"
:
[
{
object (
|
| Fields | |
|---|---|
operations[]
|
The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the name of the instance configuration. The operation's metadata field type |
nextPageToken
|
|
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/spanner.admin -
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
