View a markdown version of this page

UpdateCluster - Amazon DocumentDB

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

UpdateCluster

Modifica un cluster elastico. Ciò include l'aggiornamento del nome utente/della password dell'amministratore, l'aggiornamento della versione dell'API e la configurazione di una finestra di backup e di manutenzione

Sintassi della richiesta

PUT /cluster/clusterArn HTTP/1.1 Content-type: application/json { "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] }

Parametri della richiesta URI

La richiesta utilizza i seguenti parametri URI.

clusterArn

L'identificatore ARN del cluster elastico.

Obbligatorio: sì

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

adminUserPassword

La password associata all'amministratore del cluster elastico. Questa password può contenere qualsiasi carattere ASCII stampabile, eccetto la barra (/), le virgolette (") o il simbolo chiocciola (@).

Vincoli: deve contenere da 8 a 100 caratteri.

▬Tipo: stringa

Obbligatorio: no

authType

Il tipo di autenticazione utilizzato per determinare dove recuperare la password utilizzata per accedere al cluster elastico. I tipi validi sono PLAIN_TEXT oSECRET_ARN.

Tipo: String

Valori validi: PLAIN_TEXT | SECRET_ARN

Campo obbligatorio: no

backupRetentionPeriod

Il numero di giorni per i quali vengono conservate le istantanee automatiche.

Tipo: Integer

Obbligatorio: no

clientToken

Il token client per il cluster elastico.

▬Tipo: stringa

Obbligatorio: no

preferredBackupWindow

L'intervallo di tempo giornaliero durante il quale vengono creati i backup automatici, se i backup automatici sono abilitati, come determinato da. backupRetentionPeriod

▬Tipo: stringa

Obbligatorio: no

preferredMaintenanceWindow

Intervallo temporale settimanale nel fuso orario UTC (Universal Coordinated Time) durante il quale può verificarsi la manutenzione dei sistemi.

Format: ddd:hh24:mi-ddd:hh24:mi

Impostazione predefinita: una finestra di 30 minuti selezionata a caso da un intervallo di tempo di 8 ore per ciascuna Regione AWS, che si verifica in un giorno casuale della settimana.

Giorni validi: lun, mar, mer, gio, ven, sab, dom

Vincoli: finestra di un minimo di 30 minuti.

▬Tipo: stringa

Obbligatorio: no

shardCapacity

Il numero di v CPUs assegnato a ogni shard di cluster elastico. Il massimo è 64. I valori consentiti sono 2, 4, 8, 16, 32, 64.

Tipo: Integer

Obbligatorio: no

shardCount

Il numero di shard assegnati al cluster elastico. Il massimo è 32.

Tipo: Integer

Obbligatorio: no

shardInstanceCount

Il numero di istanze di replica che si applicano a tutti gli shard del cluster elastico. shardInstanceCountIl valore 1 indica che esiste un'istanza di writer e tutte le istanze aggiuntive sono repliche che possono essere utilizzate per le letture e per migliorare la disponibilità.

Tipo: Integer

Obbligatorio: no

subnetIds

La sottorete Amazon EC2 IDs per il cluster elastico.

Tipo: array di stringhe

Obbligatorio: no

vpcSecurityGroupIds

Un elenco di gruppi di sicurezza VPC EC2 da associare al cluster elastico.

Tipo: array di stringhe

Obbligatorio: no

Sintassi della risposta

HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } }

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

cluster

Restituisce informazioni sul cluster elastico aggiornato.

Tipo: oggetto Cluster

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Tipi di errore comuni.

AccessDeniedException

Un'eccezione che si verifica quando non ci sono autorizzazioni sufficienti per eseguire un'azione.

message

Un messaggio di errore che spiega perché l'accesso è stato negato.

Codice di stato HTTP: 403

ConflictException

C'è stato un conflitto di accesso.

resourceId

L'ID della risorsa in cui si è verificato un conflitto di accesso.

resourceType

Il tipo di risorsa in cui si è verificato un conflitto di accesso.

Codice di stato HTTP: 409

InternalServerException

Si è verificato un errore interno del server.

Codice di stato HTTP: 500

ResourceNotFoundException

Impossibile trovare la risorsa specificata.

message

Un messaggio di errore che descrive l'errore.

resourceId

L'ID della risorsa che non è stato possibile individuare.

resourceType

Il tipo di risorsa che non è stato possibile trovare.

Codice di stato HTTP: 404

ThrottlingException

ThrottlingException verrà generata quando la richiesta è stata rifiutata a causa della limitazione della richiesta.

retryAfterSeconds

Il numero di secondi di attesa prima di ritentare l'operazione.

Codice di stato HTTP: 429

ValidationException

Una struttura che definisce un'eccezione di convalida.

fieldList

Un elenco dei campi in cui si è verificata l'eccezione di convalida.

message

Un messaggio di errore che descrive l'eccezione di convalida.

reason

Il motivo per cui si è verificata l'eccezione di convalida (uno traunknownOperation, cannotParsefieldValidationFailed, o). other

Codice di stato HTTP: 400

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue: