Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

List Network Operations

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

Returns a paginated list of operations, optionally filtered by resource.

page_size
integer format: int32

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
string

Page Token

A page token, received from a previous ListNetworkOperations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListNetworkOperations must match the call that provided the page token.

filter
string

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.

order_by
string

AIP-132 order_by expression. Sortable fields: end_time, insert_time, operation_type, progress, resource_type, start_time, status.

skip
string

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).

OK

Media type application/json

ListNetworkOperationsResponse

Response message for ListNetworkOperations.

object
operations

Operations

The list of operations.

Array<object>

Network Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object
id

Operation ID

Unique identifier for this operation.

stringOutput only
resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only
resource_type

Resource Type

The type of resource (e.g., “com.qibdo.cloud.network:vpc”).

stringOutput only
operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only
Allowed values: NETWORK_OPERATION_TYPE_UNSPECIFIED NETWORK_OPERATION_TYPE_CREATE NETWORK_OPERATION_TYPE_UPDATE NETWORK_OPERATION_TYPE_DELETE
status

Status

Current lifecycle state of the operation.

string format: enum Output only
Allowed values: NETWORK_OPERATION_STATUS_UNSPECIFIED NETWORK_OPERATION_STATUS_PENDING NETWORK_OPERATION_STATUS_RUNNING NETWORK_OPERATION_STATUS_DONE NETWORK_OPERATION_STATUS_ERROR
insert_time

Insert Time

When the operation was first created.

string format: date-time Output only
start_time

Start Time

When the operation started executing.

string format: date-time Output only
end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only
errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Network Operation Error

A structured error returned inside an operation when a business rule fails.

object
code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the error.

stringOutput only
reason

Reason

Machine-readable error identifier in UPPER_SNAKE form — the same dispatch key google.rpc.ErrorInfo.reason carries on the synchronous error plane.

stringOutput only
warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Network Operation Warning

A non-fatal notice attached to an operation.

object
code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only
description

Description

Human-readable explanation of the warning.

stringOutput only
progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only
scope_type

Scope Type

The category of scope the operation ran in or was triggered from. NETWORK_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.

string format: enum Output only
Allowed values: NETWORK_SCOPE_TYPE_UNSPECIFIED NETWORK_SCOPE_TYPE_PLATFORM NETWORK_SCOPE_TYPE_ORGANISATION NETWORK_SCOPE_TYPE_WORKSPACE NETWORK_SCOPE_TYPE_GROUP
scope_id

Scope ID

The resource this operation was scoped to — for example, when scope_type is NETWORK_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for NETWORK_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.

stringOutput only
principal_id

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.

stringOutput only
trace_id

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.

stringOutput only
next_page_token

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.

string
total_size

Exact count of resources matching the request’s filter and scope (both pagination modes).

string
Example
{
"operations": [
{
"operation_type": "NETWORK_OPERATION_TYPE_UNSPECIFIED",
"status": "NETWORK_OPERATION_STATUS_UNSPECIFIED",
"scope_type": "NETWORK_SCOPE_TYPE_UNSPECIFIED"
}
]
}

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"
}
]
}