Ein Zertifikat ändern
PUT /accounts/{account_id}/core/v1/certificates/{certificate_id}
Ersetzt die gesamte gespeicherte Ressource durch den bereitgestellten JSON-Anfragetext.
Nebenwirkungen
-
Ein aktualisiertes CA-Zertifikat wird im Truststore aktualisiert.
-
Wenn ein bestehendes vertrauenswürdiges CA-Zertifikat als nicht vertrauenswürdig eingestuft wird, wird es aus dem Vertrauensspeicher entfernt.
-
Wird der Zertifikatskörper aktualisiert (Feld „cert“), muss der Indikator „isSelfSigned“ angegeben werden, um den Status des neuen Zertifikats zu kennzeichnen. Wird der Indikator „isSelfSigned“ in diesem Fall nicht angegeben, wird der Wert auf „false“ gesetzt.
-
Wenn ein Update den Zertifikatstext ("cert"-Feld) nicht ändert, ist der Indikator "isSelfSigned" optional und der bestehende Wert wird beibehalten, wenn er nicht angegeben wird.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
True |
ID der übergeordneten Kontoressource
|
Zertifikats-ID |
Zeichenkette |
Pfad |
True |
ID der aufzulistenden Zertifikatssammlung |
Anfragetext
Ersetzt die gesamte gespeicherte Ressource durch den bereitgestellten JSON-Anfragetext.
Nebenwirkungen
-
Ein aktualisiertes CA-Zertifikat wird im Truststore aktualisiert.
-
Wenn ein bestehendes vertrauenswürdiges CA-Zertifikat als nicht vertrauenswürdig eingestuft wird, wird es aus dem Vertrauensspeicher entfernt.
-
Wird der Zertifikatskörper aktualisiert (Feld „cert“), muss der Indikator „isSelfSigned“ angegeben werden, um den Status des neuen Zertifikats zu kennzeichnen. Wird der Indikator „isSelfSigned“ in diesem Fall nicht angegeben, wird der Wert auf „false“ gesetzt.
-
Wenn ein Update den Zertifikatstext ("cert"-Feld) nicht ändert, ist der Indikator "isSelfSigned" optional und der bestehende Wert wird beibehalten, wenn er nicht angegeben wird.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Folgende Werte sind definiert:
|
Version |
Zeichenkette |
True |
Version der Ressource. Folgende Werte sind definiert:
|
id |
Zeichenkette |
Falsch |
Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:
|
certUse |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die die Verwendung des Zertifikats angibt. Falls nicht angegeben, wird standardmäßig „rootCA“ verwendet. Folgende Werte sind definiert:
|
Zertifikat |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Base64-kodierten, PKCS-11-formatierten Zertifikat (PEM). Folgende Werte sind definiert:
|
cn |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem aus dem Zertifikat extrahierten allgemeinen Namen. Folgende Werte sind definiert:
|
expiryTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Zeitstempel, der das Ablaufdatum des Zertifikats angibt. Folgende Werte sind definiert:
|
isSelfSigned |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die angibt, ob das Zertifikat selbstsigniert ist. Wird beim Erstellen kein Wert angegeben, ist der Standardwert "false". Beim Aktualisieren:
|
trustState |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die einen von mehreren definierten Werten enthält und angibt, ob das Zertifikat als vertrauenswürdig eingestuft wird. Folgende Werte sind definiert:
|
trustStateTransitions |
Array["type_astra_stateTransition"] |
Falsch |
JSON-Array von JSON-Objekten, die jeweils die Menge der zulässigen Zustandsübergänge von einem definierten Zustand aus darstellen. Jedes JSON-Objekt enthält die Felder "from" und "to", wobei der Wert von "from" der Name eines Zustands ist und der Wert von "to" ein Array zulässiger Zielzustände ist. |
trustStateDesired |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der angibt, ob das Zertifikat vertrauenswürdig ist. Wenn beim Erstellen kein Wert angegeben wird, ist der Standardwert "trusted". Folgende Werte sind definiert:
|
trustStateDetails |
Array["type_astra_stateDetail"] |
Falsch |
Ein JSON-Array mit JSON-Objekten, das zusätzliche Details zum Vertrauensstatus des Zertifikats auflistet. Sind keine Details verfügbar, ist dieses Array leer.
|
Metadaten |
Falsch |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
|
Beispielanfrage
{
"type": "application/astra-certificate",
"version": "1.1",
"trustStateDesired": "trusted"
}
Antwort
Status: 204, Indicates if the certificate resource was updated.
Antwort
Status: 401, Unauthorized
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Antwort
Status: 400, Bad request
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidFields |
Array["invalidFields"] |
Falsch |
Liste ungültiger Anfragetextfelder |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Antwort
Status: 409, Conflict
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidFields |
Array["invalidFields"] |
Falsch |
Liste ungültiger Anfragetextfelder |
Beispielantwort
{
"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"
}
Antwort
Status: 403, Forbidden
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Antwort
Status: 503, Service unavailable
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/41",
"title": "Service not ready",
"detail": "Currently, the service can't respond to this request.",
"status": "503"
}
Fehler
Status: 404, Not found
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispiel-Fehlermeldung
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definitionen
Siehe Definitionen
type_astra_stateTransition
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
aus |
Zeichenkette |
True |
|
: |
Array[string] |
True |
additionalDetails
type_astra_stateDetail
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
additionalDetails |
Falsch |
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
|
Wert |
Zeichenkette |
True |
type_astra_metadata_update
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
-
Entspricht dem Astra-Metadatenschema. Falls beim Erstellen keine Bezeichnung angegeben wird, wird ein Metadatenobjekt ohne Bezeichnungen erstellt. Wird beim Aktualisieren kein Label angegeben, bleiben die Labels, creationTimestamp und createdBy, des Metadatenobjekts unverändert erhalten.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Etiketten |
Array["Typ_Astra_Label"] |
Falsch |
|
CreationZeitstempel |
Zeichenkette |
Falsch |
|
Änderungszeitstempel |
Zeichenkette |
Falsch |
|
Erstellt von |
Zeichenkette |
Falsch |
|
modifiedBy |
Zeichenkette |
Falsch |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
True |
Grund, warum der Abfrageparameter ungültig ist |
invalidFields
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
Name des ungültigen Anfragetextfelds |
Grund |
Zeichenkette |
True |
Grund, warum das Anfragekörperfeld ungültig ist |