Einen neuen Bucket erstellen
POST /accounts/{account_id}/topology/v1/buckets
Gibt die gewünschten Werte für die zu erstellende Bucket-API-Ressource an.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
Wahr |
ID der übergeordneten Kontoressource
|
Anfragetext
Gibt die gewünschten Werte für die zu erstellende Bucket-API-Ressource an.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
Wahr |
Version der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem benutzerdefinierten Namen für den Bucket. Definierte Werte sind:
|
Anmeldeinformations-ID |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit der Kennung der Anmeldeinformationen für den Zugriff auf den Bucket. Folgende Werte sind definiert:
|
Anbieter |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die das Bucket-Protokoll angibt, über das auf den Bucket zugegriffen werden kann. Folgende Werte sind definiert:
|
bucketParameters |
Wahr |
Ein JSON-Objekt, das die für den Zugriff auf den Bucket erforderlichen bucket-anbieterspezifischen Informationen enthält. Die spezifischen Werte in diesem Bucket variieren je nach Anbieter. |
|
Metadaten |
Falsch |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielanfrage
{
"type": "application/astra-bucket",
"version": "1.2",
"name": "Test Bucket",
"credentialID": "d5b3854c-38de-42c6-9269-b5c052aba76f",
"provider": "gcp",
"bucketParameters": {
"gcp": {
"bucketName": "bucketName"
}
}
}
Antwort
Status: 201, Returns the newly created bucket resource in the JSON response body.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
Wahr |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
Wahr |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem benutzerdefinierten Namen für den Bucket. Definierte Werte sind:
|
Anmeldeinformations-ID |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit der Kennung der Anmeldeinformationen für den Zugriff auf den Bucket. Folgende Werte sind definiert:
|
Zustand |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der den Betriebszustand des Buckets angibt. Folgende Werte sind definiert:
|
stateDetails |
Array["type_astra_stateDetail"] |
Wahr |
Ein JSON-Array mit JSON-Objekten, das zusätzliche Details darüber auflistet, warum der "state" zu "removed" oder "failed" gewechselt hat. Sind keine Details verfügbar, ist dieses Array leer.
|
retentionTime |
Nummer |
Falsch |
Anzahl der Sekunden, die die Aufbewahrungsdauer einer Datei in diesem Bucket angeben. Folgende Werte sind definiert:
|
Anbieter |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die das Bucket-Protokoll angibt, über das auf den Bucket zugegriffen werden kann. Folgende Werte sind definiert:
|
bucketParameters |
Wahr |
Ein JSON-Objekt, das die für den Zugriff auf den Bucket erforderlichen bucket-anbieterspezifischen Informationen enthält. Die spezifischen Werte in diesem Bucket variieren je nach Anbieter. |
|
Metadaten |
Wahr |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielantwort
{
"type": "application/astra-bucket",
"version": "1.2",
"id": "9b296ce0-c545-5022-acfa-1980c5aaea97",
"name": "Test Bucket",
"credentialID": "8f039324-7795-40bf-a5ca-4442580f7ab0",
"state": "available",
"stateDetails": [],
"provider": "gcp",
"bucketParameters": {
"gcp": {
"bucketName": "bucketName"
}
},
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Antwort
Status: 401, Unauthorized
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
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 |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
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 |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
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 |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
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"
}
Fehler
Status: 404, Not found
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
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
s3
JSON-Objekt, das die Protokollparameter für Simple Storage Service (S3) bereitstellt. (Verwenden Sie dieses Objekt für alle S3-Typ-Anbieter).
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
serverURL |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit einer URL zum Basispfad des Buckets. Folgende Werte sind definiert:
|
bucketName |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit dem Namen des S3-Buckets. Folgende Werte sind definiert:
|
gcp
JSON-Objekt, das Google Cloud-Protokollparameter bereitstellt.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
bucketName |
Zeichenkette |
Wahr |
JSON-String mit dem Namen des zugrunde liegenden Google Cloud-Bucket-Namens. Folgende Werte sind definiert:
|
azure
JSON-Objekt, das Azure-Protokollparameter bereitstellt.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
storageAccount |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit dem Namen des Azure-Speicherkontos. Folgende Werte sind definiert:
|
bucketName |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit dem Namen des zugrunde liegenden Azure-Blobs. Folgende Werte sind definiert:
|
bucketParameters
Ein JSON-Objekt, das die für den Zugriff auf den Bucket erforderlichen bucket-anbieterspezifischen Informationen enthält. Die spezifischen Werte in diesem Bucket variieren je nach Anbieter.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
s3 |
Falsch |
JSON-Objekt, das die Protokollparameter für Simple Storage Service (S3) bereitstellt. (Verwenden Sie dieses Objekt für alle S3-Typ-Anbieter). |
|
gcp |
Falsch |
JSON-Objekt, das Google Cloud-Protokollparameter bereitstellt. |
|
azure |
Falsch |
JSON-Objekt, das Azure-Protokollparameter bereitstellt. |
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
|
Wert |
Zeichenkette |
Wahr |
type_astra_metadata_update
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
-
Entspricht dem Astra-Metadatenschema. Wird beim Erstellen kein Label angegeben, wird ein Metadatenobjekt ohne Labels 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 |
additionalDetails
type_astra_stateDetail
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
additionalDetails |
Falsch |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
Wahr |
Grund, warum der Abfrageparameter ungültig ist |
invalidFields
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
Name des ungültigen Anfragetextfelds |
Grund |
Zeichenkette |
Wahr |
Grund, warum das Anfragekörperfeld ungültig ist |