Modifica una risorsa AppMirror
PUT /accounts/{account_id}/k8s/v1/appMirrors/{appMirror_id}
Sostituisce l'intera risorsa memorizzata con il corpo della richiesta JSON fornito, preservando i valori chiave non modificabili dall'utente.
Effetti collaterali
-
Vari effetti collaterali basati su desiredState.
Parametri
| Nome | Tipo | In | Obbligatorio | Descrizione |
|---|---|---|---|---|
ID account |
stringa |
percorso |
Vero |
ID della risorsa account contenitore
|
appMirror_id |
stringa |
percorso |
Vero |
ID della collezione appMirror da elencare |
Corpo della richiesta
Sostituisce l'intera risorsa memorizzata con il corpo della richiesta JSON fornito, preservando i valori chiave non modificabili dall'utente.
Effetti collaterali
-
Vari effetti collaterali basati su desiredState.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
Tipo di media della risorsa. I valori definiti sono:
|
versione |
stringa |
Vero |
Versione della risorsa. I valori definiti sono:
|
id |
stringa |
Falso |
Identificatore univoco globale della risorsa. I valori definiti sono:
|
ID applicazione sorgente |
stringa |
Falso |
Identificativo dell'applicazione sorgente. Aggiornato solo quando si scambia l'ID dell'applicazione sorgente con l'ID dell'applicazione destinazione. I valori definiti sono:
|
sourceClusterID |
stringa |
Falso |
Identificativo del cluster gestito che ospita l'applicazione di origine. Questo campo è di sola lettura e viene determinato in base al cluster host dell'applicazione di origine. Se fornito in un aggiornamento, deve corrispondere all'ID del cluster dell'applicazione di origine, quindi può cambiare solo quando si scambia sourceAppID con destinationAppID. I valori definiti sono:
|
destinationAppID |
stringa |
Falso |
Identificativo dell'applicazione di destinazione. Non può essere fornito in fase di creazione perché verrà generato un nuovo ID app durante l'inizializzazione della relazione. Può essere aggiornato solo quando si scambia sourceAppID con destinationAppID. I valori definiti sono:
|
destinationClusterID |
stringa |
Falso |
Identificativo del cluster gestito che ospiterà l'applicazione di destinazione. Deve essere fornito in fase di creazione perché determina su quale cluster verrà creata l'applicazione di destinazione. Se fornito in fase di aggiornamento, deve corrispondere all'ID del cluster di destinazione, quindi può cambiare solo quando si scambia sourceAppID con destinationAppID. I valori definiti sono:
|
namespaceMapping |
vettore["namespaceMapping"] |
Falso |
Lo spazio dei nomi o gli spazi dei nomi da utilizzare durante la creazione dell'applicazione di destinazione, corrispondenti agli spazi dei nomi dell'applicazione di origine. Ogni oggetto JSON contiene i campi "clusterID" e "namespaces", dove il valore di "clusterID" è l'ID stringa JSON del cluster di origine o di destinazione, e il valore di "namespaces" è un array JSON di stringhe JSON. Deve esserci esattamente un oggetto JSON per ogni cluster e gli spazi dei nomi saranno correlati tramite indice. Se non specificato, verrà utilizzato lo stesso spazio dei nomi del cluster di origine nel cluster di destinazione. I valori definiti sono:
|
storageClasses |
vettore["storageClasses"] |
Falso |
La classe di archiviazione da utilizzare sul cluster di destinazione durante la creazione di nuove Persistent Volume Claims (PVC). Ogni oggetto JSON contiene i campi "clusterID" e "storageClassName", dove il valore "clusterID" è l'ID stringa JSON del cluster di origine o del cluster di destinazione, e "storageClassName" è la classe di archiviazione da utilizzare durante la creazione di PVC su quel cluster. Se non specificato o se il valore è mancante per un cluster, verrà utilizzata la classe di archiviazione predefinita per quel cluster. I valori definiti sono:
|
stato |
stringa |
Falso |
Lo stato della relazione. I valori definiti sono:
|
stateTransitions |
vettore["tipo_transizione_stato_astra"] |
Falso |
Transizioni di stato consentite. Per questa risorsa sono possibili le seguenti transizioni di stato:
|
stateDesired |
stringa |
Falso |
Lo stato desiderato per la relazione. Al momento della creazione, l'unico valore valido è "established". I valori definiti sono:
|
stateAllowed |
array[string] |
Falso |
Stati che possono essere richiesti in un determinato stato. I seguenti stati possono essere richiesti in ciascuno stato definito:
|
stateDetails |
vettore["type_astra_stateDetail"] |
Falso |
Ulteriori dettagli sullo stato attuale, incluso il motivo per cui è stato raggiunto tale stato. Se non sono disponibili dettagli, questo array sarà vuoto. I valori definiti sono:
|
transferState |
stringa |
Falso |
Stato del trasferimento snapshot corrente o più recente. I valori definiti sono:
|
transferStateTransitions |
vettore["tipo_transizione_stato_astra"] |
Falso |
Transizioni di stato consentite da un dato stato definito. Per questa risorsa sono possibili le seguenti transizioni di stato:
|
transferStateDetails |
vettore["type_astra_stateDetail"] |
Falso |
Ulteriori dettagli sullo stato attuale, incluso il motivo per cui è stato raggiunto tale stato. Se non sono disponibili dettagli, questo array sarà vuoto. I valori definiti sono:
|
healthState |
stringa |
Falso |
Stato di salute della risorsa. I valori definiti sono:
|
healthStateTransitions |
vettore["tipo_transizione_stato_astra"] |
Falso |
Transizioni di stato consentite da un dato stato definito. Per questa risorsa sono possibili le seguenti transizioni di stato:
|
healthStateDetails |
vettore["type_astra_stateDetail"] |
Falso |
Ulteriori dettagli sullo stato attuale, incluso il motivo per cui è stato raggiunto tale stato. Se non sono disponibili dettagli, questo array sarà vuoto. I valori definiti sono:
|
metadati |
Falso |
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
|
Esempio di richiesta
{
"type": "application/astra-appMirror",
"version": "1.1",
"stateDesired": "failedOver"
}
Risposta
Status: 204, Indicates if the appMirror resource was updated.
Risposta
Status: 401, Unauthorized
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Risposta
Status: 400, Bad request
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidFields |
vettore["invalidFields"] |
Falso |
Elenco dei campi non validi del corpo della richiesta |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Risposta
Status: 409, Conflict
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidFields |
vettore["invalidFields"] |
Falso |
Elenco dei campi non validi del corpo della richiesta |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
Risposta
Status: 403, Forbidden
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Errore
Status: 404, Not found
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Esempio di risposta di errore
{
"type": "https://astra.netapp.io/problems/1",
"title": "Resource not found",
"detail": "The resource specified in the request URI wasn't found.",
"status": "404"
}
Definizioni
Vedi definizioni
namespaceMapping
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
clusterID |
stringa |
Falso |
Identificatore del cluster per il quale sono specificati i namespace. I valori definiti sono:
|
spazi dei nomi |
array[string] |
Falso |
Elenco degli spazi dei nomi da utilizzare sul cluster. Correlato con l'altro elenco di spazi dei nomi del cluster tramite indice. I valori definiti sono:
|
ruolo |
stringa |
Falso |
Il ruolo iniziale per questa definizione di namespace. Questo parametro è facoltativo, tranne quando viene utilizzata una configurazione di replica dello stesso cluster. I valori definiti sono:
|
storageClasses
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
clusterID |
stringa |
Falso |
Identificatore del cluster per il quale è specificata la classe di archiviazione. I valori definiti sono:
|
storageClassName |
stringa |
Falso |
Nome della classe di archiviazione da utilizzare durante la creazione di PVC sul cluster specificato in "clusterID". I valori definiti sono:
|
ruolo |
stringa |
Falso |
Il ruolo iniziale per la definizione di questa classe di archiviazione. Questo parametro è facoltativo, tranne quando viene utilizzata una configurazione di replica nello stesso cluster. I valori definiti sono:
|
tipo_transizione_stato_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
da |
stringa |
Vero |
|
a |
array[string] |
Vero |
additionalDetails
type_astra_stateDetail
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
additionalDetails |
Falso |
etichetta tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
|
valore |
stringa |
Vero |
aggiornamento dei metadati di tipo Astra
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
-
Conforme allo schema dei metadati Astra. Se non specificato in fase di creazione, verrà creato un oggetto metadati senza etichette. Se non specificato in fase di aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
etichette |
vettore["etichetta tipo_astra"] |
Falso |
|
CreationTimestamp |
stringa |
Falso |
|
ModificationTimestamp |
stringa |
Falso |
|
CreatedBy |
stringa |
Falso |
|
modifiedBy |
stringa |
Falso |
invalidParams
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del parametro di query non valido |
motivo |
stringa |
Vero |
Motivo per cui il parametro di query non è valido |
invalidFields
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del campo del corpo della richiesta non valido |
motivo |
stringa |
Vero |
Motivo per cui il campo del corpo della richiesta non è valido |