ApplyPendingMaintenanceAction - 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.

ApplyPendingMaintenanceAction

Der Typ der ausstehenden Wartungsaktion, die auf die Ressource angewendet werden soll.

Anforderungssyntax

POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

applyAction

Die ausstehende Wartungsaktion, die auf die Ressource angewendet werden soll.

Gültige Aktionen sind:

  • ENGINE_UPDATE

  • ENGINE_UPGRADE

  • SECURITY_UPDATE

  • OS_UPDATE

  • MASTER_USER_PASSWORD_UPDATE

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Ja

optInType

Ein Wert, der die Art der Opt-In-Anfrage angibt oder eine Opt-In-Anfrage rückgängig macht. Eine Opt-in-Anfrage vom Typ IMMEDIATE kann nicht rückgängig gemacht werden.

Typ: Zeichenfolge

Zulässige Werte: IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN

Erforderlich: Ja

resourceArn

Der Amazon DocumentDB Amazon Resource Name (ARN) der Ressource, für die die ausstehende Wartungsaktion gilt.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Ja

applyOn

Ein bestimmtes Datum, an dem die ausstehende Wartungsmaßnahme angewendet werden soll. Erforderlich, wenn opt-in-type ein APPLY_ON ist. Format: yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "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.

resourcePendingMaintenanceAction

Die Ausgabe der ausstehenden Wartungsaktion, die gerade ausgeführt wird.

Typ: ResourcePendingMaintenanceAction 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.

message

Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.

HTTP Status Code: 403

ConflictException

Es gab einen Zugriffskonflikt.

resourceId

Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.

resourceType

Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.

HTTP-Statuscode: 409

InternalServerException

Es ist ein interner Serverfehler aufgetreten.

HTTP Status Code: 500

ResourceNotFoundException

Die angegebene Ressource konnte nicht gefunden werden.

message

Eine Fehlermeldung, die den Fehler beschreibt.

resourceId

Die ID der Ressource, die nicht gefunden werden konnte.

resourceType

Der Typ der Ressource, die nicht gefunden werden konnte.

HTTP Status Code: 404

ThrottlingException

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

retryAfterSeconds

Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.

HTTP-Statuscode: 429

ValidationException

Eine Struktur, die eine Validierungsausnahme definiert.

fieldList

Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.

message

Eine Fehlermeldung, die die Validierungsausnahme beschreibt.

reason

Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von unknownOperation cannotParsefieldValidationFailed,, oderother).

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

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