Neue Gruppe erstellen
POST /accounts/{account_id}/core/v1/groups
Gibt die gewünschten Werte für die zu erstellende Group-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 Group-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 |
Der Name der Gruppenressource. Falls beim Erstellen nicht angegeben, wird der Wert auf
|
authProvider |
Zeichenkette |
Wahr |
Der Authentifizierungsanbieter für die Gruppenressource. Folgende Werte sind definiert:
|
authID |
Zeichenkette |
Wahr |
Der Distinguished Name (DN) einer LDAP-Gruppe. Folgende Werte sind definiert:
|
Metadaten |
Falsch |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielanfrage
{
"type": "application/astra-group",
"version": "1.1",
"name": "engineering-group",
"authProvider": "ldap",
"authID": "CN=Engineering,CN=Groups,DC=example,DC=com"
}
Antwort
Status: 201, Returns the newly created group 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 |
Der Name der Gruppenressource. Falls beim Erstellen nicht angegeben, wird der Wert auf
|
authProvider |
Zeichenkette |
Wahr |
Der Authentifizierungsanbieter für die Gruppenressource. Folgende Werte sind definiert:
|
authID |
Zeichenkette |
Wahr |
Der Distinguished Name (DN) einer LDAP-Gruppe. Folgende Werte sind definiert:
|
Metadaten |
Wahr |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielantwort
{
"type": "application/astra-group",
"version": "1.1",
"id": "77754011-b93f-515e-a145-5a343aecdece",
"name": "engineering-group",
"authProvider": "ldap",
"authID": "CN=Engineering,CN=Groups,DC=example,DC=com",
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
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/14",
"title": "Unauthorized access",
"detail": "The user isn't enabled.",
"status": "403"
}
Antwort
Status: 406, Not acceptable
| 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/32",
"title": "Unsupported content type",
"detail": "The response can't be returned in the requested format.",
"status": "406"
}
Antwort
Status: 500, Internal server error
| 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/34",
"title": "Internal server error",
"detail": "The server was unable to process this request.",
"status": "500"
}
Fehler
Status: 400, Bad request
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidParams |
Array["invalidParams"] |
Falsch |
Liste ungültiger Abfrageparameter |
Beispiel-Fehlermeldung
{
"type": "https://astra.netapp.io/problems/7",
"title": "Invalid JSON payload",
"detail": "The request body is not valid JSON.",
"status": "400"
}
Definitionen
Siehe Definitionen
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 |
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 |