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:

Sie haben ein Google Cloud-Konto. Standardmäßig können Sie mit einem Google Cloud-Konto eine Apigee-Organisation ohne Evaluierung erstellen. Evaluationsorganisationen laufen nach 60 Tagen ab. Die Organisation wird dann gelöscht.
Sie haben ein Google Cloud-Konto und ein bezahltes Apigee-Abo in Ihrem Google Cloud-Projekt- und Abrechnungskonto aktiviert. Mit einem kostenpflichtigen Abo können Sie vollständige, skalierbare Apigee-Implementierungen erstellen. Wenden Sie sich an den Apigee-Vertrieb, um ein kostenpflichtiges Konto zu erwerben und das Abo aktivieren zu lassen.

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 (was einfach ein anderer Begriff für Einrichtung ist).

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.
Bekannt: Eine hybride Organisation ähnelt einer herkömmlichen Apigee-Organisation, mit der Ausnahme, dass sie an ein Google Cloud-Projekt gebunden ist. Es ist nicht dasselbe wie eine Google Cloud-Organisation oder eine Apigee-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 die Anmeldedaten der gcloud-Authentifizierung mit dem folgenden Befehl ab:
Linux / MacOS
```
export 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.
Windows
```
for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a
```
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.

Prüfen Sie, ob Sie die erforderlichen Umgebungsvariablen mit den folgenden Befehlen definiert haben:

echo ${PROJECT_ID}
echo ${ORG_NAME}
echo ${ORG_DISPLAY_NAME}
echo ${ORGANIZATION_DESCRIPTION}
echo ${ANALYTICS_REGION}
echo ${RUNTIMETYPE}

Sie können bei Bedarf die folgenden Umgebungsvariablen für die Elemente der Organisation erstellen oder neu definieren. Sie benötigen sie im Befehl, um die Organisation zu erstellen.

PROJECT_ID (erforderlich) ist das Google Cloud-Projekt, das an die neue hybride Organisation gebunden werden soll. Dies ist die ID, die Google in Schritt 2: Google Cloud-Projekt erstellen für Sie erstellt hat.
```
export PROJECT_ID=your_project_id
```
Hinweis: Geben Sie den Punkt nach der Projekt-ID nicht ein.
ORG_NAME (Erforderlich) ist die programmatische ID, die Sie für Ihre Hybrid-fähige Organisation wünschen.
Hinweis: Der Name der Organisation muss mit Ihrer Google Cloud-Projekt-ID übereinstimmen.
```
export ORG_NAME=$PROJECT_ID
```
ORG_DISPLAY_NAME (Optional) ist der nutzerfreundliche Name für Ihre Organisation. Dieser Wert muss nicht eindeutig sein und kann Leerzeichen und Sonderzeichen enthalten. Beispiel: "Meine Hybridorganisation".
```
ORG_DISPLAY_NAME="friendly_name"
```
Inhalte von Variablennamen, die Leerzeichen enthalten, müssen in doppelte Anführungszeichen gesetzt werden. Beispiel: "Meine Organisation"
ORGANIZATION_DESCRIPTION (Optional) sind Informationen zur Organisation, die Sie als Erinnerung an ihren Zweck verwenden möchten. Beispiel: "My first organization".
```
ORGANIZATION_DESCRIPTION="description_text"
```

ANALYTICS_REGION (Erforderlich) ist die primäre Region zum Speichern von Analysedaten.

export ANALYTICS_REGION=analytics_region

Dabei kann analytics_region für folgendes stehen:

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

Wählen Sie eine Region aus, die geografisch in der Nähe liegt oder die Speicheranforderungen Ihres Unternehmens erfüllt.

RUNTIMETYPE (Erforderlich) ist der Laufzeittyp der Apigee-Organisation, wobei HYBRID die vom Nutzer verwaltete Apigee-Hybridlaufzeit ist.
```
export RUNTIMETYPE=HYBRID
```

Tipp: Prüfen Sie mit dem Befehl echo $variable-name, ob die Umgebungsvariablen richtig festgelegt sind.

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":"'"$ORG_NAME"'",
    "displayName":"'"$ORG_DISPLAY_NAME"'",
    "description":"'"$ORGANIZATION_DESCRIPTION"'",
    "runtimeType":"'"$RUNTIMETYPE"'",
    "analyticsRegion":"'"$ANALYTICS_REGION"'"
  }' \
  "https://apigee.googleapis.com/v1/organizations?parent=projects/$PROJECT_ID"
```
Tipp: Die Anführungszeichen ("'") im vorherigen Codebeispiel sind erforderlich, um die Werte der Umgebungsvariablen im JSON-Textkörper zu übergeben.

Bei einer erfolgreichen Erstellungsanfrage sollte die Organizations API mit einer Nachricht wie dieser antworten:
```
{
  "name": "organizations/org_name/operations/LONG_RUNNING_OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "INSERT",
    "targetResourceName": "organizations/org_name",
    "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 (siehe Schritt 5).
- org_name ist die ID der neuen Organisation, die aktuell erstellt wird.
Da das Attribut state in der Antwort angibt, hat Apigee mit dem Erstellen der neuen Organisation begonnen. Der Status lautet daher IN_PROGRESS. Dieser Vorgang kann einige Minuten dauern.

Wenn Sie eine Fehlermeldung erhalten, lesen Sie die Informationen unter Fehlerbehebung beim Erstellen von Organisationen.
Speichern Sie die ID des lang andauernde Vorgangs in einer Umgebungsvariablen. Das wird bei zukünftigen Verwaltungsaufgaben hilfreich sein.
Syntax
```
export LONG_RUNNING_OPERATION_ID=long_running_operation_ID
```
Beispiel
```
export LONG_RUNNING_OPERATION_ID=6abc8a72-46de-f9da-bcfe-70d9ab347e4f
```

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. Beispiel:

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

Folgende Beispiele zeigen mögliche Antworten auf diese Anfrage:

IN_PROGRESS

Wenn Apigee noch die Organisation erstellt, antwortet Apigee mit dem Status IN_PROGRESS. Beispiel:

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

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

FINISHED

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

{
  "name": "organizations/ORG_NAME/operations/LONG_RUNNING_OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "INSERT",
    "targetResourceName": "organizations/ORG_NAME",
    "state": "FINISHED"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.Organization",
    "name": "ORG_NAME",
    "displayName": "ORG_DISPLAY_NAME",
    "description": "ORGANIZATION_DESCRIPTION",
    "createdAt": "1626237148461",
    "lastModifiedAt": "1626237149384",
    "properties": {
      "property": [
        {
          "name": "features.hybrid.enabled",
          "value": "true"
        },
        {
          "name": "features.mart.connect.enabled",
          "value": "true"
        }
      ]
    },
    "analyticsRegion": "ANALYTICS_REGION",
    "runtimeType": "HYBRID",
    "subscriptionType": "TRIAL",
    "state": "ACTIVE",
    "billingType": "EVALUATION",
    "expiresAt": "1631421073171",
    "addonsConfig": {
      "advancedApiOpsConfig": {},
      "integrationConfig": {},
      "monetizationConfig": {}
    }
  }
}

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

Informationen zur Organisation aufrufen

Sie können die Metadatendetails für die Organisation abrufen, die Sie mit einer Apigee API erstellt haben. Außerdem haben Sie die Möglichkeit, mit einer API alle Organisationen aufzulisten, auf die Ihr Google Cloud-Konto Zugriff hat. Zum Ausführen dieser Aktionen die verwenden Sie die Organizations API.

Aktualisieren Sie vor der Nutzung der APIs Ihr Autorisierungstoken:

TOKEN=$(gcloud auth print-access-token)

Details zur Organisation abrufen

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/org_name

Das folgende Beispiel ruft Details zur Organisation $ORG_NAME ab: In diesem Beispiel ist $ORG_NAME auf "apigee-example" festgelegt.

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

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

Das folgende Beispiel zeigt eine Antwort mit Details zur Organisation apigee-example:

{
  "name": "apigee-example",
  "displayName": "apigee-example-org",
  "description": "Apigee Example Org",
  "createdAt": "1626237148461",
  "lastModifiedAt": "1626237149384",
  "properties": {
    "property": [
      {
        "name": "features.hybrid.enabled",
        "value": "true"
      },
      {
        "name": "features.mart.connect.enabled",
        "value": "true"
      }
    ]
  },
  "analyticsRegion": "us-west1",
  "runtimeType": "HYBRID",
  "subscriptionType": "TRIAL",
  "projectId": "apigee-example",
  "state": "ACTIVE",
  "billingType": "EVALUATION",
  "expiresAt": "1631421073171",
  "addonsConfig": {
    "advancedApiOpsConfig": {},
    "integrationConfig": {},
    "monetizationConfig": {}
  }
}

Organisationen auflisten

So rufen Sie eine Liste aller Organisationen ab, auf die Ihr Google Cloud-Konto Zugriff hat:

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 apigee-example:

{
  "organizations": [
    {
      "organization": "apigee-example",
      "projectIds": [
        "apigee-example"
      ]
    },
    {
      "organization": "apigee-example-2",
      "projectIds": [
        "apigee-example-2"
      ]
    }
  ]
}

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": "",
        "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 Authentifizierungstoken `gcloud` 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 Schritt 5 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_org_name 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.

1 2 3 4 (WEITER) Schritt 5: Umgebungsgruppe erstellen