REST Resource: projects.locations.units

Ressource : Unit

Unité de déploiement dont le cycle de vie est géré par une API CRUD à l'aide d'un moteur d'actionnement sous-jacent (par exemple, basé sur Terraform, Helm ou une implémentation personnalisée fournie par un producteur de services). Élément de base d'un locataire SaaS.

Représentation 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
}
Champs
name

string

Identifiant. Nom de la ressource (URI complet de la ressource) suivant le schéma de dénomination standard :

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

string

Facultatif. Référence à UnitKind auquel cette unité appartient. Immuable une fois défini.
release

string

Facultatif. Uniquement en sortie. Objet Release actuel pour cette unité.
tenant

string

Facultatif. Référence à la ressource de locataire SaaS à laquelle appartient cette unité. Par exemple, cela permet d'informer les règles de maintenance à utiliser pour planifier les futures mises à jour d'une unité. (facultatif et immuable une fois créé)
ongoingOperations[]

string

Facultatif. Uniquement en sortie. Liste des UnitOperations simultanées qui fonctionnent sur cette unité.
pendingOperations[]

string

Facultatif. Uniquement en sortie. Liste des UnitOperations en attente (à exécuter) pour cette unité.
scheduledOperations[]

string

Facultatif. Uniquement en sortie. Liste des UnitOperations planifiées pour cette unité.
dependents[]

object (UnitDependency)

Facultatif. Uniquement en sortie. Liste des unités qui dépendent de cette unité. L'unité ne peut être désactivée que si cette liste est vide. 1 000 au maximum.
dependencies[]

object (UnitDependency)

Facultatif. Uniquement en sortie. Ensemble de dépendances pour cette unité. 10 maximum.
inputVariables[]

object (UnitVariable)

Facultatif. Uniquement en sortie. Indique les variables d'entrée actuelles déployées par l'unité.
outputVariables[]

object (UnitVariable)

Facultatif. Uniquement en sortie. Ensemble de paires clé/valeur correspondant aux variables de sortie de l'exécution des modèles d'actionnement. Les variables sont déclarées dans les configurations d'actionnement (par exemple, dans un graphique Helm ou Terraform). Les valeurs sont récupérées et renvoyées par le moteur d'actionnement à la fin de l'exécution.
maintenance

object (MaintenanceSettings)

Facultatif. Capture les directives demandées pour effectuer la maintenance future de l'unité. Cela inclut une demande pour que l'appareil ignore la maintenance pendant une période donnée et reste épinglé à sa version actuelle, ainsi que des commandes permettant de reporter la maintenance prévue à l'avenir.
state

enum (UnitState)

Facultatif. Uniquement en sortie. État actuel du cycle de vie de la ressource (par exemple, si elle est en cours de création ou prête à être utilisée).
conditions[]

object (UnitCondition)

Facultatif. Uniquement en sortie. Ensemble de conditions indiquant les différentes conditions que cette ressource peut avoir.
managementMode

enum (ManagementMode)

Facultatif. Immuable. Indique si le cycle de vie de l'unité est contrôlé par l'utilisateur ou par le système. Immuable une fois créé.
systemManagedState

enum (SystemManagedState)

Facultatif. Uniquement en sortie. Indique l'état géré par le système de l'unité.
systemCleanupAt

string (Timestamp format)

Facultatif. Uniquement en sortie. Si cette valeur est définie, elle indique l'heure à laquelle le système commencera à supprimer l'unité.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Facultatif. Libellés de la ressource, qui peuvent être utilisés pour la catégorisation. Ils sont semblables aux libellés de ressources Kubernetes.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Facultatif. Les annotations sont un mappage clé-valeur non structuré stocké avec une ressource. Elles peuvent être définies par des outils externes pour stocker et récupérer des métadonnées arbitraires. Elles ne peuvent pas faire l'objet de requêtes et doivent être conservées lors de la modification d'objets.

Pour en savoir plus, consultez https://kubernetes.io/docs/user-guide/annotations.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Uniquement en sortie. Identifiant unique de la ressource. L'UID est unique dans le temps et l'espace pour cette ressource dans le cadre du service. Il est habituellement généré par le serveur lors de la création réussie d'une ressource et ne doit pas être modifié. L'UID permet d'identifier de manière unique les ressources avec réutilisation du nom. Il doit être un UUID4.
etag

string

Uniquement en sortie. Valeur opaque qui identifie de manière unique la version ou la génération d'une ressource. Cet identifiant permet de confirmer que le client et le serveur sont d'accord sur l'ordre d'écriture d'une ressource.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de la ressource.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de la ressource. Toute modification de la ressource par les utilisateurs doit actualiser cette valeur. Les modifications d'une ressource par le service doivent actualiser cette valeur.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
satisfiesPzs

boolean

Uniquement en sortie. Indique si l'emplacement de la ressource respecte les contraintes de séparation des zones. Par défaut, cette valeur est définie sur "false".
satisfiesPzi

boolean

Uniquement en sortie. Indique si l'emplacement de la ressource respecte les contraintes d'isolement des zones. Par défaut, cette valeur est définie sur "false".

UnitDependency

Ensemble de dépendances pour cette unité. 10 maximum.

Représentation JSON 
{
  "alias": string,
  "unit": string
}
Champs
alias

string

Uniquement en sortie. Alias pour le nom de la dépendance.
unit

string

Uniquement en sortie. Référence à l'objet Unit.

MaintenanceSettings

Capture les directives demandées pour effectuer la maintenance future de l'unité. Cela inclut une demande pour que l'appareil ignore la maintenance pendant une période donnée et reste épinglé à sa version actuelle, ainsi que des commandes permettant de reporter la maintenance prévue à l'avenir.

Représentation JSON 
{
  "pinnedUntilTime": string
}
Champs
pinnedUntilTime

string (Timestamp format)

Facultatif. Si cette option est sélectionnée, la version présente sur l'unité est figée jusqu'à l'heure indiquée. Autrement dit, toute modification du champ "Version" sera refusée. Les déploiements respecteront également cette option en ne demandant pas de mise à niveau.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

UnitState

UnitState indique l'état actuel de l'unité elle-même.

Enums
UNIT_STATE_UNSPECIFIED État non spécifié.
UNIT_STATE_NOT_PROVISIONED L'unité n'est pas provisionnée.
UNIT_STATE_PROVISIONING L'unité est en cours de provisionnement.
UNIT_STATE_UPDATING L'unité est en cours de mise à jour. Cela se produit généralement lorsqu'une unité est mise à niveau vers une nouvelle version ou que certaines variables d'entrée de l'unité sont modifiées. Certains types de mises à jour peuvent rendre l'appareil inutilisable pendant leur installation.
UNIT_STATE_DEPROVISIONING L'unité est en cours de suppression.
UNIT_STATE_READY L'unité a été provisionnée et est prête à être utilisée.
UNIT_STATE_ERROR L'unité présente une erreur lorsqu'elle n'est pas prête et qu'une opération d'erreur est en cours.

UnitCondition

UnitCondition décrit l'état d'une unité. UnitCondition désigne les composants individuels qui contribuent à un état global.

Représentation JSON 
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Champs
status

enum (Status)

Obligatoire. État de la condition.
type

enum (Type)

Obligatoire. Type de la condition.
lastTransitionTime

string (Timestamp format)

Obligatoire. Dernière transition de la condition d'un état à un autre.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
message

string

Obligatoire. Message lisible par l'humain indiquant des détails sur la dernière transition.
reason

string

Obligatoire. Brève raison de la dernière transition de la condition.

État

Énumération des états de condition.

Enums
STATUS_UNSPECIFIED L'état de la condition n'est pas spécifié.
STATUS_UNKNOWN L'état est inconnu.
STATUS_TRUE La condition est vraie.
STATUS_FALSE La condition est "false" (faux).

Type

Énumération des types de conditions.

Enums
TYPE_UNSPECIFIED Le type de condition n'est pas spécifié.
TYPE_READY Le type de condition est prêt.
TYPE_UPDATING Le type de condition est en cours de mise à jour.
TYPE_PROVISIONED Le type de condition est provisionné.
TYPE_OPERATION_ERROR Le type de condition est "operationError". True lorsque la dernière opération d'unité échoue avec une erreur non ignorée.

ManagementMode

ManagementMode indique qui est responsable de la gestion de l'unité.

Enums
MANAGEMENT_MODE_UNSPECIFIED
MANAGEMENT_MODE_USER Le cycle de vie de l'unité est géré par l'utilisateur.
MANAGEMENT_MODE_SYSTEM Le système décidera quand annuler la gestion et supprimer l'unité. L'utilisateur peut toujours désactiver ou supprimer manuellement l'unité.

SystemManagedState

Enums
SYSTEM_MANAGED_STATE_UNSPECIFIED
SYSTEM_MANAGED_STATE_ACTIVE Des unités dépendantes sont associées à l'unité.
SYSTEM_MANAGED_STATE_INACTIVE L'unité n'a aucune dépendance associée, mais les pièces jointes sont autorisées.
SYSTEM_MANAGED_STATE_DECOMMISSIONED L'unité n'a aucune dépendance associée et les pièces jointes ne sont pas autorisées.

Méthodes

create

 Créez une unité.

delete

 Supprimez une seule unité.

get

 Récupérer une seule unité.

list

 Récupérez une collection d'unités.

patch

 Mettez à jour une seule unité.