Managed Service for Gitlab API, REST: Instance.Get

Field

Description

instanceId

string

Required field. ID of the GitLab instance to return

The maximum string length in characters is 50.

Field

Description

id

string

Unique instance ID.

folderId

string

Folder ID where instance resides.

createdAt

string (date-time)

Creation timestamp.

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

updatedAt

string (date-time)

Last update timestamp.

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

name

string

Human-readable name.

description

string

Instance description.

labels

object (map<string, string>)

Resource labels as key-value pairs.

resourcePresetId

string

Resource preset ID.

diskSize

string (int64)

Disk size in bytes.

status

enum (Status)

Current instance status.

• CREATING: Instance is being created.
• RUNNING: Instance is running normally.
• UPDATING: Instance is being updated.
• ERROR: Instance is in error state.
• DELETING: Instance is being deleted.
• BACKUP_CREATING: Backup is being created.
• BACKUP_RESTORING: Backup is being restored.
• STARTING: Instance is starting.
• STOPPING: Instance is stopping.
• STOPPED: Instance is stopped.
• BACKGROUND_MIGRATIONS: Background migrations in progress.
• OBJECT_STORAGE_MIGRATIONS: Object storage migrations in progress.
• SNAPSHOT_RESTORING: Snapshot is being restored.

adminLogin

string

Admin username.

adminEmail

string

Admin email.

domain

string

Instance domain.

subnetId

string

Subnet ID.

plannedOperation

MaintenanceOperation

Planned maintenance operation.

backupRetainPeriodDays

string (int64)

How long to keep backups (days).

maintenanceDeleteUntagged

boolean

Delete untagged resources during maintenance.

deletionProtection

boolean

Protect from accidental deletion.

approvalRulesId

string

Approval rules ID.

The maximum string length in characters is 30.

gitlabVersion

string

GitLab version of the instance.

Field

Description

info

string

The description of the operation.

The maximum string length in characters is 256.

delayedUntil

string (date-time)

Delay time for the maintenance operation.

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

latestMaintenanceTime

string (date-time)

Time of the last maintenance window.

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

nextMaintenanceWindowTime

string (date-time)

Time of the next maintenance window.

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