List Operations

GET

/observability/v1/operations

curl --request GET \
  --url https://example.com/observability/v1/operations

Returns a page of operations filtered by an AIP-160 expression and ordered per AIP-132.

Parameters

Query Parameters

page_size

integer format: int32

The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 20 operations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

A page token, received from a previous ListOperations call.

filter

string

AIP-160 filter expression.

order_by

string

AIP-132 order_by expression.

Responses

200

OK

Media type application/json

ListObservabilityOperationsResponse

Response for ListOperations. Keyset pagination intentionally omits total_size (AIP-158).

object

operations

The list of operations.

Array<object>

ObservabilityOperation

Tracks the synchronous result of an observability config-plane command (retention, sink, or ingestion mutation). Engine-neutral — operations carry no engine axis.

object

id

The unique operation identifier.

stringOutput only

resource_id

The id of the affected resource.

stringOutput only

resource_type

The type of resource the operation acted upon (URN).

stringOutput only

operation_type

The operation type (CREATE, UPDATE, DELETE).

string format: enum Output only

Allowed values: OBSERVABILITY_OPERATION_TYPE_UNSPECIFIED OBSERVABILITY_OPERATION_TYPE_CREATE OBSERVABILITY_OPERATION_TYPE_UPDATE OBSERVABILITY_OPERATION_TYPE_DELETE

status

The operation status (DONE for synchronous config mutations).

string format: enum Output only

Allowed values: OBSERVABILITY_OPERATION_STATUS_UNSPECIFIED OBSERVABILITY_OPERATION_STATUS_PENDING OBSERVABILITY_OPERATION_STATUS_RUNNING OBSERVABILITY_OPERATION_STATUS_DONE OBSERVABILITY_OPERATION_STATUS_ERROR

insert_time

When the operation was recorded.

string format: date-time Output only

start_time

When execution started.

string format: date-time Output only

end_time

When execution completed.

string format: date-time Output only

progress

Progress percentage (0–100).

integer format: int32 Output only

next_page_token

A token to retrieve the next page; empty when there are no further pages.

string

Example

{
  "operations": [
    {
      "operation_type": "OBSERVABILITY_OPERATION_TYPE_UNSPECIFIED",
      "status": "OBSERVABILITY_OPERATION_STATUS_UNSPECIFIED"
    }
  ]
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}