UpdateCluster - Amazon DocumentDB
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

UpdateCluster

Ändert einen elastischen Cluster. Dazu gehören die Aktualisierung von Admin-Benutzername/Passwort, die Aktualisierung der API-Version und die Einrichtung eines Backup-Fensters und eines Wartungsfensters

Anforderungssyntax

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" ]
}

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

clusterArn

Die ARN-ID des elastischen Clusters.

Erforderlich: Ja

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

adminUserPassword

Das dem Elastic Cluster-Administrator zugeordnete Passwort. Dieses Passwort kann alle druckbaren ASCII-Zeichen, außer Schrägstrich (/), doppeltes Anführungszeichen (") oder das "At"-Zeichen (@), enthalten.

Einschränkungen: Muss 8 bis 100 Zeichen enthalten.

Typ: Zeichenfolge

Erforderlich: Nein

authType

Der Authentifizierungstyp, der verwendet wird, um zu bestimmen, wo das für den Zugriff auf den Elastic Cluster verwendete Passwort abgerufen werden soll. Gültige Typen sind PLAIN_TEXT oderSECRET_ARN.

Typ: Zeichenfolge

Zulässige Werte: PLAIN_TEXT | SECRET_ARN

Erforderlich: Nein

backupRetentionPeriod

Die Anzahl der Tage, für die automatische Snapshots aufbewahrt werden.

Typ: Ganzzahl

Erforderlich: Nein

clientToken

Das Client-Token für den Elastic Cluster.

Typ: Zeichenfolge

Erforderlich: Nein

preferredBackupWindow

Der tägliche Zeitraum, in dem automatische Backups erstellt werden, wenn automatische Backups aktiviert sind, wie durch den bestimmtbackupRetentionPeriod.

Typ: Zeichenfolge

Erforderlich: Nein

preferredMaintenanceWindow

Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in UTC (Universal Coordinated Time).

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

Standard: Ein 30-Minuten-Fenster, das nach dem Zufallsprinzip aus einem Zeitblock von jeweils AWS-Region 8 Stunden ausgewählt wird und an einem zufälligen Wochentag stattfindet.

Gültige Tage: Mo, Di, Mi, Do, Fr, Sa, So

Einschränkungen: mindestens 30-Minuten-Zeitfenster.

Typ: Zeichenfolge

Erforderlich: Nein

shardCapacity

Die Anzahl der vCPUs, die jedem elastischen Cluster-Shard zugewiesen sind. Das Maximum ist 64. Zulässige Werte sind 2, 4, 8, 16, 32, 64.

Typ: Ganzzahl

Erforderlich: Nein

shardCount

Die Anzahl der Shards, die dem elastischen Cluster zugewiesen sind. Das Maximum ist 32.

Typ: Ganzzahl

Erforderlich: Nein

shardInstanceCount

Die Anzahl der Replikatinstanzen, die für alle Shards im Elastic Cluster gelten. Ein shardInstanceCount Wert von 1 bedeutet, dass es eine Writer-Instance gibt, und alle weiteren Instances sind Replikate, die für Lesevorgänge und zur Verbesserung der Verfügbarkeit verwendet werden können.

Typ: Ganzzahl

Erforderlich: Nein

subnetIds

Die Amazon EC2-Subnetz-IDs für den Elastic Cluster.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

vpcSecurityGroupIds

Eine Liste von EC2-VPC-Sicherheitsgruppen, die dem Elastic Cluster zugeordnet werden sollen.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

Antwortsyntax

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" ]
   }
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

cluster

Gibt Informationen über den aktualisierten Elastic Cluster zurück.

Typ: Cluster Objekt

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

AccessDeniedException

Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.

HTTP Status Code: 403

ConflictException

Es gab einen Zugriffskonflikt.

HTTP-Statuscode: 409

InternalServerException

Es ist ein interner Serverfehler aufgetreten.

HTTP Status Code: 500

ResourceNotFoundException

Die angegebene Ressource konnte nicht gefunden werden.

HTTP Status Code: 404

ThrottlingException

ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Anforderungsdrosselung abgelehnt wurde.

HTTP-Statuscode: 429

ValidationException

Eine Struktur, die eine Validierungsausnahme definiert.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: