Compute Cloud API, REST: Maintenance.List

Field

Description

cloudId

string

Cloud ID for the resources.

The maximum string length in characters is 50.

Includes only one of the fields cloudId, folderId, resourceId.

Container specifies the resources for which to list maintenances. (Required)

folderId

string

Folder ID for the resources.

The maximum string length in characters is 50.

Includes only one of the fields cloudId, folderId, resourceId.

Container specifies the resources for which to list maintenances. (Required)

resourceId

string

Resource ID of the target resource.

The maximum string length in characters is 50.

Includes only one of the fields cloudId, folderId, resourceId.

Container specifies the resources for which to list maintenances. (Required)

pageSize

string (int64)

The maximum number of maintenances to return per response.

The maximum value is 1000.

pageToken

string

Token to retrieve the next page of results. Omitted on the first request.

The maximum string length in characters is 500.

orderBy

string

By which field the listing should be ordered and in which direction,
format is "created_at desc". The default sorting order is ascending.
Supported fields: ["created_at", "start_scheduled_at", "started_at"].

The maximum string length in characters is 100.

filter

string

Filter list by various fields.
Supported fields: ["status", "resource_type", "resource_id"]

The maximum string length in characters is 100.

Field

Description

maintenances[]

Maintenance

List of maintenances.

nextPageToken

string

Token to retrieve the next page of results.

Field

Description

id

string

ID of the maintenance.

resourcePath[]

Resource

Full path to the resource affected by maintenance,
represented as a hierarchy from specific resource to top-level container.
Example for a Compute instance with ID "I" in folder "F" and cloud "C":
resource_path = [
{ "compute.instance", "I" },
{ "resource-manager.folder", "F" },
{ "resource-manager.cloud", "C" }
]

description

string

Describes action to be performed.

details[]

Detail

Service-specific details.

status

enum (Status)

Status of the maintenance.

• SCHEDULED: Maintenance is scheduled for a future time.
• RUNNING: Maintenance is currently running.
• SUCCEEDED: Maintenance completed successfully.
• CANCELLED: Maintenance is cancelled and will not run.

createdAt

string (date-time)

The creation time of the maintenance.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

startScheduledAt

string (date-time)

The time when the maintenance was scheduled to start.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

completionScheduledAt

string (date-time)

The time when the maintenance is estimated to complete. Optional.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

maxStartScheduledAt

string (date-time)

Latest time the maintenance can be postponed to.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

startedAt

string (date-time)

The time time when the maintenance has actually started.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

succeededAt

string (date-time)

The time time when the maintenance has actually completed successfully.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

cancelledAt

string (date-time)

The time time when the maintenance has actually been cancelled.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

userControllable

boolean

Indicates whether the user can control (reschedule) the maintenance.

Field

Description

id

string

ID of the resource

type

string

The type of the resource, e.g. resource-manager.cloud, resource-manager.folder, compute.instance, etc.

Field

Description

key

string

Unique key (service-specific).

value

string

Description (service-specific).