Schritt 4: Organisation erstellen

Sie haben ein Google Cloud-Konto und ein Projekt erstellt und die APIs aktiviert. Jetzt können Sie Ihre Organisation erstellen.

Voraussetzung

Um eine Organisation zu erstellen, müssen Sie eine der folgenden Bedingungen erfüllen:

Haben Sie ein Kennenlernkonto? Kennenlernkonten laufen nach 60 Tagen ab. Die Organisation wird dann gelöscht.
Ein kostenpflichtiges Konto haben.

Wenn keiner dieser Punkte zutrifft, müssen Sie sich an Apigee Sales wenden, bevor Sie fortfahren können.

Organisation erstellen

Wenn Sie eine Organisation erstellen, binden Sie sie an Ihr Google Cloud-Projekt ein. Das Binden einer Organisation an ein Google Cloud-Projekt wird als Bereitstellung bezeichnet (ein anderer Begriff für "Einrichtung").

Das sollten Sie beim Bereitstellen einer Organisation beachten:

Vollständig neu: Sie können keine bestehende Apigee-Organisation bereitstellen. Sie müssen eine neue Nur-Hybridorganisation erstellen.
Vertraut: Eine hybridfähige Organisation ähnelt einer herkömmlichen Edge-Organisation, mit dem Unterschied, dass sie an ein Google Cloud-Projekt gebunden ist. Es ist nicht dasselbe wie eine Google Cloud-Organisation oder eine Edge-Organisation.
Individuell: Sie können ein einzelnes Google Cloud-Projekt nur an eine einzelne Apigee-Organisation binden und umgekehrt.

Nachdem Sie eine neue Organisation erfolgreich verbunden haben, können Sie Nutzer und Rollen mit der Google Cloud Console verwalten, während Sie API-Proxys per Hybrid APIs oder UI entwickeln, bereitstellen und analysieren. Weitere Informationen zu Organisationen finden sich unter Versionsverwaltung und Terminologie.

So erstellen Sie eine neue Organisation und stellen sie bereit:

Rufen Sie in der Befehlszeile Ihre gcloud-Authentifizierungsdaten ab, wie im folgenden Beispiel gezeigt:
```
TOKEN=$(gcloud auth print-access-token)
```
Um zu prüfen, ob Ihr Token ausgefüllt wurde, verwenden Sie echo wie im folgenden Beispiel:
```
echo $TOKEN
```
Das Token sollte als codierter String angezeigt werden.

Weitere Informationen finden sich in der Übersicht über das gcloud-Befehlszeilentool.

Senden Sie eine authentifizierte POST-Anfrage an die Create Organisations API.

Das folgende Beispiel zeigt die Anfragestruktur, die eine Organisation erstellt:

curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
  -d '{
    "name":"proposed_org_ID",
    "displayName":"display_name",
    "description":"organization_description",
    "runtimeType":"runtime_type",
    "analyticsRegion":"analytics_region"
  }' \
  "https://apigee.googleapis.com/v1/organizations?parent=projects/project_ID"

Hierbei gilt:

(Erforderlich) proposed_org_ID ist die programmatische ID, die Sie für Ihre Hybridorganisation benötigen. Beispiel: my-hybrid-org
Hinweis: Die Organisations-ID darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten. Der Text für den Titel darf maximal 32 Zeichen lang sein.
Die folgenden Beispiel-IDs sind gültig:
org-all-lowercase
short-org-id
org-with-hyphens
org-number-42
Die folgenden Beispiel-IDs sind nicht gültig:
Org-With-Camel-Case
long-organization-id-is-more-than-32-characters
org_with_underscores
org+with*other/special%chars

Apigee empfiehlt, dieselbe ID wie die Google Cloud-Projekt-ID zu verwenden, die Sie unter Schritt 2: Google Cloud-Projekt erstellen erstellt haben. Sie können jedoch auch eine andere ID verwenden.
(Erforderlich) runtime_type ist der Laufzeittyp der Apigee-Organisation, wobei HYBRID die vom Nutzer verwaltete Apigee-Hybridlaufzeit ist.

(Erforderlich) analytics_region ist die primäre Region zum Speichern von Analysedaten. Wählen Sie eine der folgenden Optionen aus:

`asia-northeast1`	`australia-southeast1`	`us-west1`
`us-central1`	`us-east1`	`europe-west1`
`europe-west2`

Wir bieten diese Option, damit Sie eine Region auswählen können, die geografisch in der Nähe liegt oder wenn für Ihre Organisation andere Speicheranforderungen gelten.

(Erforderlich) project_ID ist das Google Cloud-Projekt, das an die neue Hybridorganisation gebunden werden soll. Dies ist die ID, die Google in Schritt 2: Google Cloud-Projekt erstellen für Sie erstellt hat.
Hinweis: Die Projekt-ID darf nur Kleinbuchstaben, Ziffern und Bindestriche mit einer maximalen Länge von 32 Zeichen enthalten.
(Optional) display_name ist der nutzerfreundliche Name Ihrer Organisation. Dieser Wert muss nicht eindeutig sein und kann Leerzeichen und Sonderzeichen enthalten. Beispiel: "Meine Hybridorganisation".
(Optional) organization_description sind Informationen zur Organisation, die Sie als Erinnerung an ihren Zweck verwenden möchten. Beispiel: "My first organization".

Bei einer erfolgreichen Erstellungsanfrage sollte die Organizations API mit einer Nachricht wie dieser antworten:

{
  "name": "organizations/organization_ID/operations/long_running_operation_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "INSERT",
    "targetResourceName": "organizations/organization_ID",
    "state": "IN_PROGRESS"
  }
}

Dabei gilt:

long_running_operation_ID ist die UUID eines asynchronen Vorgangs mit langer Ausführungszeit. Mit dieser ID können Sie den Status Ihrer Anfrage zum Erstellen einer Organisation prüfen. Eine Beschreibung dazu finden Sie weiter unten.
organization_ID ist die ID der neuen Organisation, die aktuell erstellt wird.

Da das Attribut state in der Antwort angibt, dass Apigee mit dem Erstellen der neuen Organisation begonnen hat, lautet der Status IN_PROGRESS. Dieser Vorgang kann einige Minuten dauern.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie die Informationen unter Fehlerbehebung beim Erstellen von Organisationen.

Sie können den Status des lang andauernden Vorgangs prüfen, dessen ID Apigee bei Ihrer ersten Erstellungsanfrage zurückgegeben hat. Verwenden Sie dazu die Operations API wie im folgenden Beispiel gezeigt:

curl -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/organization_ID/operations/long_running_operation_ID"

Folgende Beispiele zeigen mögliche Antworten auf diese Anfrage:

FINISHED

Wenn die Organisation bereitgestellt wurde, lautet der Status des lang andauernden Vorgangs FINISHED, wie folgendes Beispiel zeigt:

{
    "operations": [
      {
        "name": "organizations/organization_ID/operations/long_running_operation_ID",
        "metadata": {
          "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
          "operationType": "INSERT",
          "targetResourceName": "organizations/organization_ID",
          "state": "FINISHED"
        },
        "done": true,
        "response": {
          "@type": "type.googleapis.com/google.cloud.apigee.v1.Organization",
          "name": "organization_ID",
          "createdAt": "1572550611",
          "lastModifiedAt": "1572550611",
          "displayName": "display_name"
          "description": "description"
          "properties": {
            "property": [
              {
                "name": "features.hybrid.enabled",
                "value": "true"
              }
            ]
          },
          "analyticsRegion": "us-east1"
          "runtimeType": "HYBRID",

        }
      }
    ]
  }

Wenn Sie keine Beschreibung eingegeben haben, erscheint dieses Feld nicht in der Antwort.

Glückwunsch! Sie haben eine neue Organisation erstellt und können sie jetzt verwenden. Sie können mit Schritt 5: Umgebung hinzufügen fortfahren.

IN_PROGRESS

Wenn Apigee die Organisation noch erstellt, antwortet Apigee mit dem Status IN_PROGRESS, wie im folgenden Beispiel gezeigt:

{
    "name": "organizations/organization_ID/operations/long_running_operation_ID",
    "metadata": {
      "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
      "operationType": "INSERT",
      "targetResourceName": "organizations/organization_ID",
      "state": "IN_PROGRESS"
    }
  }

Warten Sie noch etwas länger, bevor Sie prüfen, ob der Erstellungsvorgang abgeschlossen ist.

Fehlerbehebung beim Erstellen einer Organisation

Wenn Sie eine Organisation mit der Create Organisations API erstellen, erhalten Sie möglicherweise eine Fehlermeldung. Antworten sehen so aus:

{
  "error": {
    "code": HTTP_error_code,
    "message": "short_error_message",
    "status": "high_level_error_type",
    "details": [
      {
        "@type": "specific_error_type",
        "detail": "expanded_error_description"
      }
    ]
  }
}

Das folgende Beispiel zeigt eine Antwort auf einen häufigen Fehler. Die Organisations-ID enthält unzulässige Zeichen (Großbuchstaben sind in Organisations-IDs nicht zulässig):

{
  "error": {
    "code": 400,
    "message": "invalid Organization ID \"MY-ORG\": \"MY-ORG\" is an invalid Organization ID",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.DebugInfo",
        "detail": "[ORIGINAL ERROR] generic::invalid_argument: invalid Organization ID \"MY-ORG\":
          \"My-ORG\" is an invalid Organization ID [google.rpc.error_details_ext]
          { message: \"invalid Organization ID \\\"MY-ORG\\\": \\\"MY-ORG\\\" is an invalid
          Organization ID\" }"
      }
    ]
  }
}

In diesem Fall können Sie die Benennung der Organisation in Kleinbuchstaben ändern und Ihre Anfrage noch einmal senden.

In folgender Tabelle sind Fehler aufgeführt, die beim Erstellen einer neuen Organisation auftreten können, sowie mögliche Lösungswege:

HTTP-Fehlercode	HTTP-Fehler	Beschreibung
`400`	`Invalid JSON payload received`	Entweder ist die Struktur der Daten in Ihrer Anfrage ein Syntaxfehler oder der Pfad zum Endpunkt ist falsch.
`400`	`Invalid organization ID`	Die von Ihnen angeforderte Organisations-ID darf keine Großbuchstaben und keine Sonderzeichen (außer Bindestrichen) enthalten. Sie darf nur Kleinbuchstaben, Ziffern und/oder Bindestriche enthalten. Sie darf höchstens 32 Zeichen umfassen.
`400`	`Unsupported analytics region`	Entweder haben Sie den Wert der `analyticsRegion` im Anfragetext nicht angegeben oder der von Ihnen angegebene Wert ist keine der gültigen Optionen.
`400`	`Does not have an Apigee entitlement`	Ihr Google Cloud-Projekt, das Sie in Schritt 2: Google Cloud-Projekt erstellen erstellt haben, ist noch nicht hybrid. Dies könnte auf ein Problem mit der Abrechnung oder auf einen anderen Fehler im Zusammenhang mit Ihrem Google Cloud-Konto hindeuten. Weitere Informationen erhalten Sie von Apigee Sales.
`401`	`Request had invalid authentication credentials`	Das gcloud-Authentifizierungstoken ist entweder fehlerhaft oder veraltet, oder Sie haben es nicht in die Anfrage aufgenommen. Generieren Sie ein neues Token und senden Sie die Adresse noch einmal.
`403`	`Permission denied on resource project project_ID`	Möglicherweise haben Sie eine Anfrage mit einer falschen Projekt-ID oder einem falschen Pfad gesendet.
`403`	`Unable to retrieve project information`	Die Organisation wurde noch nicht erstellt oder bereitgestellt. Sie können eine Anfrage an die Operations API senden, um den Status des lang andauernden Vorgangs zu prüfen, wie in dem Vorgang oben beschrieben.
`409`	`Organization already exists`	Sie haben versucht, mehr als eine Organisation für das Google Cloud-Projekt zu erstellen. Sie können nur eine Organisation pro Projekt erstellen.
`409`	`Org proposed_organization_ID already exists`	Sie haben versucht, eine Organisation mit einer ID zu erstellen, die bereits vorhanden ist. Organisations-IDs müssen für alle Hybrid-Kunden einmalig sein. Senden Sie die Anfrage nochmals, diesmal mit einer neuen Organisations-ID. Hängen Sie beispielsweise einen numerischen Wert an das Ende der zuvor genutzten ID an.

Organisationsinformationen abrufen

Sie können eine Liste aller Organisationen abrufen, auf die Ihr Konto Zugriff hat, oder Details zu einer bestimmten Organisation anhand derer ID abrufen. Verwenden Sie zum Ausführen dieser Aktionen die Organizations API.

Organisationen auflisten

So rufen Sie eine Liste aller Organisationen ab:

Senden Sie eine GET-Anfrage (ohne Text) an den folgenden Endpunkt der List Organizations API:

https://apigee.googleapis.com/v1/organizations

Beispiel:

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations"

Die Antwort auf Ihre Anfrage enthält ein Array aller Hybridorganisationen, auf die Sie Zugriff haben, im JSON-Format.

Das folgende Beispiel zeigt eine Antwort mit einer einzelnen Organisation "my-org-42":

{
  "organizations": [
    {
      "organization": "my-org-42",
      "projectIds": [
        "my-project"
      ]
    }
  ]
}

Details

So rufen Sie Details zu einer einzelnen Organisation ab:

Senden Sie eine GET-Anfrage (ohne Text) an den folgenden Get Organizations API-Endpunkt:

https://apigee.googleapis.com/v1/organizations/organization_ID

Das folgende Beispiel ruft Details zur Organisation „my-org-42“ ab:

curl -H "Authorization: Bearer $TOKEN"
  "https://apigee.googleapis.com/v1/organizations/my-org-42"

Die Antwort auf Ihre Anfrage enthält Details zur angegebenen Organisation im JSON-Format.

Das folgende Beispiel zeigt eine Antwort mit Details der Organisation „my-org-42“:

{
  "name": "my-org-42",
  "createdAt": "1572550611",
  "lastModifiedAt": "1572550611",
  "environments": [
    "my-environment"
  ],
  "analyticsRegion": "us-east1"
}

1 2 3 4 (ES FOLGT) Schritt 5: Umgebung hinzufügen