Eine Cloud abrufen
GET /accounts/{account_id}/topology/v1/clouds/{cloud_id}
Gibt die gespeicherte Cloud-API-Ressource im JSON-Antworttext zurück.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
True |
ID der übergeordneten Kontoressource
|
cloud_id |
Zeichenkette |
Pfad |
True |
ID der aufzulistenden Cloud-Sammlung |
Antwort
Status: 200, Returns the stored Cloud API resource in the JSON response body.
| 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 |
True |
Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:
|
Name |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Namen der Cloud. Folgende Werte sind definiert:
|
Zustand |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Betriebszustand der Cloud angibt. Folgende Werte sind definiert:
|
stateUnready |
Array[string] |
True |
JSON-Array von JSON-Strings, die jeweils einen Grund dafür angeben, warum eine Cloud nicht in den Status „running“ wechseln kann oder warum sie in den Status „failed“ gewechselt ist. Folgende Werte sind definiert:
|
cloudType |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Cloud-Typ angibt. Folgende Werte sind definiert:
|
Anmeldeinformations-ID |
Zeichenkette |
Falsch |
JSON-Zeichenfolge mit einem Wert, der die ID der Anmeldeinformationen angibt, die das Dienstkonto für die Cloud enthalten. Dies ist für cloudType "gcp", "azure" und "aws" erforderlich. Folgende Werte sind definiert:
|
defaultBucketID |
Zeichenkette |
Falsch |
JSON-Zeichenfolge mit der ID eines Buckets, der standardmäßig für die Erstellung von Backups für Anwendungen in der Cloud verwendet wird. Dies ist beim Klonen von Anwendungen zwischen Clustern erforderlich und wird als Standardwert verwendet, wenn beim Erstellen von Backups und Zeitplänen kein Bucket angegeben wird. Folgende Werte sind definiert:
|
Metadaten |
True |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
|
Beispielantwort
{
"type": "application/astra-cloud",
"version": "1.1",
"id": "1c9512c3-ec62-5ed8-8013-02fc090b9d03",
"name": "GKE",
"state": "discovering",
"stateUnready": [
"Cloud discovery in progress"
],
"cloudType": "gcp",
"credentialID": "6fa2f917-f730-41b8-9c15-17f531843b31",
"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 |
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 |
|
invalidParams |
Array["invalidParams"] |
Falsch |
Liste ungültiger Abfrageparameter |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
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"
}
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
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 |