List Operations
const url = 'https://example.com/topology/v1/operations';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/topology/v1/operationsReturns a paginated list of operations, optionally filtered by resource.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Page Size
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
A page token, received from a previous ListOperations call.
Provide this to retrieve the subsequent page. When paginating,
all other parameters provided to ListOperations must match the call
that provided the page token.
AIP-160 filter expression. Filterable fields: end_time, errors.code, errors.description, errors.reason, id, insert_time, operation_type, principal_id, progress, resource_id, resource_type, scope_id, scope_type, start_time, status, warnings.code, warnings.description.
AIP-132 order_by expression. Sortable fields: end_time, insert_time, operation_type, progress, resource_type, start_time, status.
AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).
Responses
Section titled “ Responses ”OK
ListTopologyOperationsResponse
Response message for ListOperations.
object
Operations
The list of operations.
Topology Operation
An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).
object
Operation ID
Unique identifier for this operation.
Resource ID
The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.
Resource Type
The type of resource (e.g., “com.qibdo.cloud.topology:zone”).
Operation Type
The kind of mutation that was requested.
Status
Current lifecycle state of the operation.
Insert Time
When the operation was first created.
Start Time
When the operation started executing.
End Time
When the operation completed (either successfully or with errors).
Errors
Business rule errors encountered during the operation.
Operation Error
A structured error returned inside an operation when a business rule fails.
object
Error Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the error.
Reason
Machine-readable error identifier in UPPER_SNAKE form — the same dispatch
key google.rpc.ErrorInfo.reason carries on the synchronous error plane.
Warnings
Non-fatal notices about the operation.
Operation Warning
A non-fatal notice attached to an operation.
object
Warning Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the warning.
Progress
Percentage of completion (0-100).
Scope Type
The category of scope the operation ran in or was triggered from. TOPOLOGY_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.
Scope ID
The resource this operation was scoped to — for example, when scope_type is TOPOLOGY_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for TOPOLOGY_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.
Principal ID
Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.
Trace ID
W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.
Next Page Token
A token, which can be sent as page_token to retrieve the next page.
If this field is empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "operations": [ { "operation_type": "TOPOLOGY_OPERATION_TYPE_UNSPECIFIED", "status": "TOPOLOGY_OPERATION_STATUS_UNSPECIFIED", "scope_type": "TOPOLOGY_SCOPE_TYPE_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
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
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
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.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}