Operations

Get Operation Details

GET/v1/operations/{operation_id}

List Operations

GET/v1/operations

ModelsExpand Collapse

Operation object { id, created_at, details, 6 more }

Operation details.

id: string

Unique identifier for the Operation.

created_at: string

When the Operation was created.

formatdate-time

details: OperationDetails { changes }

Structured details about what an operation is changing.

changes: OperationChanges { from, to }

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: string or number or boolean or array of string

Previous value.

One of the following:

string

number

boolean

array of string

to: string or number or boolean or array of string

New value.

One of the following:

string

number

boolean

array of string

kind: OperationKind

Kind of Operation.

One of the following:

"vm"

"volume"

"vpc"

"firewall_rule"

"nks_cluster"

"nks_node_pool"

project_id: string

Project ID the Operation belongs to.

resource_id: string

ID of the resource that the Operation is acting on.

status: OperationStatus

Status of the Operation.

One of the following:

"pending"

"running"

"done"

"failed"

"unknown"

type: OperationType

Type of Operation.

One of the following:

"create"

"update"

"delete"

"restart"

updated_at: string

When the Operation was updated.

formatdate-time

OperationChanges = map[OperationFieldDiff { from, to } ]

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: string or number or boolean or array of string

Previous value.

One of the following:

string

number

boolean

array of string

to: string or number or boolean or array of string

New value.

One of the following:

string

number

boolean

array of string

OperationDetails object { changes }

Structured details about what an operation is changing.

changes: OperationChanges { from, to }

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: string or number or boolean or array of string

Previous value.

One of the following:

string

number

boolean

array of string

to: string or number or boolean or array of string

New value.

One of the following:

string

number

boolean

array of string

OperationFieldDiff object { from, to }

A single field’s before/after pair on an operation. Values are scalars (string, number, boolean) or string arrays.

from: string or number or boolean or array of string

Previous value.

One of the following:

string

number

boolean

array of string

to: string or number or boolean or array of string

New value.

One of the following:

string

number

boolean

array of string

OperationKind = "vm" or "volume" or "vpc" or 3 more

Kind of Operation.

One of the following:

"vm"

"volume"

"vpc"

"firewall_rule"

"nks_cluster"

"nks_node_pool"

OperationList object { items, pagination }

items: array of Operation { id, created_at, details, 6 more }

id: string

Unique identifier for the Operation.

created_at: string

When the Operation was created.

formatdate-time

details: OperationDetails { changes }

Structured details about what an operation is changing.

changes: OperationChanges { from, to }

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: string or number or boolean or array of string

Previous value.

One of the following:

string

number

boolean

array of string

to: string or number or boolean or array of string

New value.

One of the following:

string

number

boolean

array of string

kind: OperationKind

Kind of Operation.

One of the following:

"vm"

"volume"

"vpc"

"firewall_rule"

"nks_cluster"

"nks_node_pool"

project_id: string

Project ID the Operation belongs to.

resource_id: string

ID of the resource that the Operation is acting on.

status: OperationStatus

Status of the Operation.

One of the following:

"pending"

"running"

"done"

"failed"

"unknown"

type: OperationType

Type of Operation.

One of the following:

"create"

"update"

"delete"

"restart"

updated_at: string

When the Operation was updated.

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

OperationStatus = "pending" or "running" or "done" or 2 more

Status of the Operation.

One of the following:

"pending"

"running"

"done"

"failed"

"unknown"

OperationType = "create" or "update" or "delete" or "restart"

Type of Operation.

One of the following:

"create"

"update"

"delete"

"restart"