Operations

Get Operation Details

client.operations.get(, ?): Operation { id, created_at, details, 6 more }

GET/v1/operations/{operation_id}

List Operations

client.operations.list(, ?): Cursor<Operation { id, created_at, details, 6 more } >

GET/v1/operations

ModelsExpand Collapse

Operation { 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 } | null

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 | number | boolean | Array<string>

Previous value.

One of the following:

string

number

boolean

Array<string>

to: string | number | boolean | Array<string>

New value.

One of the following:

string

number

boolean

Array<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 = Record<string, OperationFieldDiff { from, to } >

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

from: string | number | boolean | Array<string>

Previous value.

One of the following:

string

number

boolean

Array<string>

to: string | number | boolean | Array<string>

New value.

One of the following:

string

number

boolean

Array<string>

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 | number | boolean | Array<string>

Previous value.

One of the following:

string

number

boolean

Array<string>

to: string | number | boolean | Array<string>

New value.

One of the following:

string

number

boolean

Array<string>

OperationFieldDiff { from, to }

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

from: string | number | boolean | Array<string>

Previous value.

One of the following:

string

number

boolean

Array<string>

to: string | number | boolean | Array<string>

New value.

One of the following:

string

number

boolean

Array<string>

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

Kind of Operation.

One of the following:

"vm"

"volume"

"vpc"

"firewall_rule"

"nks_cluster"

"nks_node_pool"

OperationList { items, pagination }

items: Array<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 } | null

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 | number | boolean | Array<string>

Previous value.

One of the following:

string

number

boolean

Array<string>

to: string | number | boolean | Array<string>

New value.

One of the following:

string

number

boolean

Array<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 | null

previous_cursor: string | null

total_count: number

minimum0

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

Status of the Operation.

One of the following:

"pending"

"running"

"done"

"failed"

"unknown"

OperationType = "create" | "update" | "delete" | "restart"

Type of Operation.

One of the following:

"create"

"update"

"delete"

"restart"