REST Resource: projects.locations.units

Risorsa: Unit

Un'unità di deployment che ha il suo ciclo di vita tramite un'API CRUD che utilizza un motore di attivazione sottostante (ad es. basato su Terraform, Helm o un'implementazione personalizzata fornita da un producer di servizi). Un componente di base di un tenant SaaS.

Rappresentazione JSON
{
  "name": string,
  "unitKind": string,
  "release": string,
  "tenant": string,
  "ongoingOperations": [
    string
  ],
  "pendingOperations": [
    string
  ],
  "scheduledOperations": [
    string
  ],
  "dependents": [
    {
      object (UnitDependency)
    }
  ],
  "dependencies": [
    {
      object (UnitDependency)
    }
  ],
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "outputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "maintenance": {
    object (MaintenanceSettings)
  },
  "state": enum (UnitState),
  "conditions": [
    {
      object (UnitCondition)
    }
  ],
  "managementMode": enum (ManagementMode),
  "systemManagedState": enum (SystemManagedState),
  "systemCleanupAt": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Campi
name

string

Identificatore. Il nome della risorsa (URI completo della risorsa) che segue lo schema di denominazione standard:

"projects/{project}/locations/{location}/units/{unit}"

unitKind

string

Facoltativo. Riferimento al tipo di unità a cui appartiene questa unità. Immutabile una volta impostato.

release

string

Facoltativo. Solo output. L'oggetto Release corrente per questa unità.

tenant

string

Facoltativo. Riferimento alla risorsa Tenant SaaS a cui appartiene questa unità. Ad esempio, indica le policy di manutenzione da utilizzare per pianificare gli aggiornamenti futuri su un'unità. (facoltativo e non modificabile una volta creato)

ongoingOperations[]

string

Facoltativo. Solo output. Elenco delle operazioni unità simultanee che operano su questa unità.

pendingOperations[]

string

Facoltativo. Solo output. Elenco delle UnitOperation in attesa (da eseguire) per questa unità.

scheduledOperations[]

string

Facoltativo. Solo output. Elenco delle UnitOperation pianificate per questa unità.

dependents[]

object (UnitDependency)

Facoltativo. Solo output. Elenco delle unità che dipendono da questa unità. L'unità può essere deprovisioning solo se questo elenco è vuoto. Massimo 1000.

dependencies[]

object (UnitDependency)

Facoltativo. Solo output. Insieme di dipendenze per questa unità. Massimo 10.

inputVariables[]

object (UnitVariable)

Facoltativo. Solo output. Indica le variabili di input correnti implementate dall'unità

outputVariables[]

object (UnitVariable)

Facoltativo. Solo output. Set di coppie chiave/valore corrispondenti alle variabili di output dell'esecuzione dei modelli di attuazione. Le variabili vengono dichiarate nelle configurazioni di attivazione (ad es.nel grafico Helm o in Terraform) e i valori vengono recuperati e restituiti dal motore di attivazione al termine dell'esecuzione.

maintenance

object (MaintenanceSettings)

Facoltativo. Acquisisce le direttive richieste per eseguire la manutenzione futura dell'unità. Ciò include una richiesta all'unità di saltare la manutenzione per un periodo di tempo e rimanere bloccata sulla release attuale, nonché controlli per posticipare la manutenzione pianificata in futuro.

state

enum (UnitState)

Facoltativo. Solo output. Stato attuale del ciclo di vita della risorsa (ad es. se è in fase di creazione o pronta all'uso).

conditions[]

object (UnitCondition)

Facoltativo. Solo output. Un insieme di condizioni che indicano le varie condizioni che questa risorsa può avere.

managementMode

enum (ManagementMode)

Facoltativo. Immutabile. Indica se il ciclo di vita dell'unità è controllato dall'utente o dal sistema. Immutabile una volta creato.

systemManagedState

enum (SystemManagedState)

Facoltativo. Solo output. Indica lo stato gestito dal sistema dell'unità.

systemCleanupAt

string (Timestamp format)

Facoltativo. Solo output. Se impostata, indica l'ora in cui il sistema inizierà a rimuovere l'unità.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Facoltativo. Le etichette sulla risorsa, che possono essere utilizzate per la categorizzazione, simili alle etichette delle risorse Kubernetes.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

annotations

map (key: string, value: string)

Facoltativo. Le annotazioni sono una mappa chiave-valore non strutturata archiviata con una risorsa che può essere impostata da strumenti esterni per archiviare e recuperare metadati arbitrari. Non sono interrogabili e devono essere conservati durante la modifica degli oggetti.

Scopri di più: https://kubernetes.io/docs/user-guide/annotations

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

uid

string

Solo output. Identificatore unico della risorsa. L'UID è unico nello spazio e nel tempo per questa risorsa nell'ambito del servizio. Viene tipicamente generato dal server durante la creazione di una risorsa e non deve essere modificato. L'UID viene utilizzato per identificare in modo unico le risorse quando i nomi risorsa vengono riutilizzati. Deve essere un UUID4.

etag

string

Solo output. Valore opaco che identifica in modo unico una versione o generazione di una risorsa. Può essere usato per confermare che client e server concordano nell'ordine di una risorsa in fase di scrittura.

createTime

string (Timestamp format)

Solo output. Timestamp di creazione della risorsa.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento della risorsa. Qualsiasi modifica apportata alla risorsa dagli utenti deve aggiornare questo valore. Le modifiche a una risorsa apportate dal servizio devono aggiornare questo valore.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

satisfiesPzs

boolean

Solo output. Indica se la località della risorsa soddisfa i vincoli di separazione delle zone. Questa opzione è disattivata per impostazione predefinita.

satisfiesPzi

boolean

Solo output. Indica se la località della risorsa soddisfa i vincoli di isolamento delle zone. Questa opzione è disattivata per impostazione predefinita.

UnitDependency

Insieme di dipendenze per questa unità. Massimo 10.

Rappresentazione JSON
{
  "alias": string,
  "unit": string
}
Campi
alias

string

Solo output. Alias per il nome della dipendenza.

unit

string

Solo output. Un riferimento all'oggetto Unit.

MaintenanceSettings

Acquisisce le direttive richieste per eseguire la manutenzione futura dell'unità. Ciò include una richiesta all'unità di saltare la manutenzione per un periodo di tempo e rimanere bloccata sulla release attuale, nonché controlli per posticipare la manutenzione pianificata in futuro.

Rappresentazione JSON
{
  "pinnedUntilTime": string
}
Campi
pinnedUntilTime

string (Timestamp format)

Facoltativo. Se presente, fissa la data di release dell'unità fino alla data/ora specificata, ad esempio le modifiche al campo della release verranno rifiutate. Le implementazioni devono e rispetteranno questa impostazione, dato che non richiederanno un upgrade.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

UnitState

UnitState annota lo stato attuale dell'unità stessa.

Enum
UNIT_STATE_UNSPECIFIED Stato non specificato.
UNIT_STATE_NOT_PROVISIONED L'unità non è sottoposta a provisioning.
UNIT_STATE_PROVISIONING Il provisioning dell'unità è in corso.
UNIT_STATE_UPDATING L'unità è in fase di aggiornamento. In genere, questo accade quando un'unità viene aggiornata a una nuova release o quando alcune delle variabili di input dell'unità vengono modificate. Alcuni tipi di aggiornamenti potrebbero rendere inutilizzabile l'unità mentre è in corso l'aggiornamento.
UNIT_STATE_DEPROVISIONING L'unità è in fase di eliminazione.
UNIT_STATE_READY L'unità è stata sottoposta al provisioning ed è pronta all'uso
UNIT_STATE_ERROR L'unità presenta un errore quando non è pronta e si verifica un errore durante un'operazione

UnitCondition

UnitCondition descrive lo stato di un'unità. UnitCondition sono singoli componenti che contribuiscono a uno stato generale.

Rappresentazione JSON
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Campi
status

enum (Status)

Obbligatorio. Stato della condizione.

type

enum (Type)

Obbligatorio. Il tipo di condizione.

lastTransitionTime

string (Timestamp format)

Obbligatorio. L'ultima volta che la condizione è passata da uno stato all'altro.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

message

string

Obbligatorio. Messaggio leggibile che indica i dettagli dell'ultima transizione.

reason

string

Obbligatorio. Breve motivo dell'ultima transizione della condizione.

Stato

Enumerazione degli stati delle condizioni.

Enum
STATUS_UNSPECIFIED Lo stato della condizione non è specificato.
STATUS_UNKNOWN Condizione sconosciuta.
STATUS_TRUE La condizione è vera.
STATUS_FALSE La condizione è false.

Tipo

Enumerazione dei tipi di condizioni.

Enum
TYPE_UNSPECIFIED Il tipo di condizione non è specificato.
TYPE_READY Il tipo di condizione è pronto.
TYPE_UPDATING Il tipo di condizione è in fase di aggiornamento.
TYPE_PROVISIONED Il tipo di condizione viene sottoposto al provisioning.
TYPE_OPERATION_ERROR Il tipo di condizione è operationError. True quando l'ultima operazione sull'unità non va a buon fine con un errore non ignorabile.

ManagementMode

ManagementMode descrive chi è responsabile della gestione dell'unità.

Enum
MANAGEMENT_MODE_UNSPECIFIED
MANAGEMENT_MODE_USER Il ciclo di vita dell'unità è gestito dall'utente.
MANAGEMENT_MODE_SYSTEM Il sistema deciderà quando eseguire il deprovisioning ed eliminare l'unità. L'utente può comunque eseguire il deprovisioning o eliminare l'unità manualmente.

SystemManagedState

Enum
SYSTEM_MANAGED_STATE_UNSPECIFIED
SYSTEM_MANAGED_STATE_ACTIVE L'unità ha dipendenti allegati.
SYSTEM_MANAGED_STATE_INACTIVE L'unità non ha dipendenze allegate, ma l'allegato è consentito.
SYSTEM_MANAGED_STATE_DECOMMISSIONED L'unità non ha dipendenze allegate e l'allegato non è consentito.

Metodi

create

Crea una nuova unità.

delete

Eliminare una singola unità.

get

Recupera una singola unità.

list

Recupera una raccolta di unità.

patch

Aggiorna una singola unità.