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.

So erstellen Sie eine neue Organisation und stellen sie bereit:

1. 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.

2. 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"

   Dabei gilt:

   • (Erforderlich) proposed_org_ID ist die programmatische ID, die Sie für Ihre Hybridorganisation benötigen. Beispiel: my-hybrid-org

     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.
   • (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.

3. 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.

   Fertig! 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:

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.

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

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

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

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

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

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