Abonnenten erstellen

So erstellen Sie einen neuen Abonnenten und abonnieren ihn mit der Konsole für einen oder mehrere Nutzungspläne:

1. Wählen Sie auf der Listenseite Abonnenten die Option Abonnenten erstellen aus. Wenn Sie Hilfe beim Suchen der Listenseite benötigen, finden Sie weitere Informationen unter Abonnenten auflisten.

2. Geben Sie die folgenden Werte für den Subscriber an:

   • Name: Der Name des neuen Abonnenten. Beispiel: Premium-subscriber. Vermeiden Sie die Eingabe von vertraulichen Informationen.
   • Compartment: Das Compartment, zu dem der neue Subscriber gehört.
   • Clients: Ein oder mehrere API-Clients, die mit den Nutzungsplänen, für die der Abonnent abonniert ist, auf API-Deployments zugreifen. Geben Sie für jeden API-Client Folgendes an:
     • Name: Geben Sie einen Namen Ihrer Wahl für den API-Client ein. Client-Namen müssen innerhalb eines Subscribers eindeutig sein. Beispiel: android. Empfehlung: Geben Sie einen aussagekräftigen Namen an, da Sie ihn API-Consumern zum Erfassen und Analysieren von Nutzungsplandaten bereitstellen können.
     • Token: Eine Zeichenfolge Ihrer Wahl, um den API-Client eindeutig zu identifizieren. Das angegebene Token muss innerhalb Ihres Mandanten für die aktuelle Region eindeutig sein und darf maximal 128 Zeichen lang sein. Beispiel: abc123def456ghi789jkl. Wenn bereits keine geeignete ID vorhanden ist, wählen Sie Token generieren aus, um eine zu erstellen.
       Hinweis
       
       Das Token, das Sie für einen API-Client in einer Subscriber-Definition angeben, dient nur zu Berichtserstellungszwecken für den Nutzungsplan. Verwenden Sie dieses Token nicht für die Authentifizierung und Autorisierung des API-Clients. Verwenden Sie stattdessen Autorisiererfunktionen oder JSON Web Tokens (JWTs) für die Authentifizierung und Autorisierung des API-Clients. Siehe Authentifizierung und Autorisierung zu API-Deployments hinzufügen.
   • Nutzungspläne: Wählen Sie Nutzungsplan hinzufügen aus, um den Abonnenten für einen oder mehrere Nutzungspläne zu abonnieren.
3. Wählen Sie optional Erweiterte Optionen, und geben Sie Folgendes an:
   • Tags: Wenn Sie über Berechtigungen zum Erstellen von Ressourcen verfügen, können Sie auch Freiformtags auf diese Ressource anwenden. Um ein definiertes Tag anzuwenden, benötigen Sie Die Berechtigungen zum Verwenden des Tag-Namespace. Weitere Informationen zu Tagging finden Sie unter Ressourcentags. Wenn Sie nicht sicher sind, ob Tags angewendet werden sollen, überspringen Sie diese Option, oder fragen Sie einen Administrator. Sie können Tags später anwenden.
4. Wählen Sie Erstellen aus, um den Abonnenten zu erstellen.

   Es kann einige Minuten dauern, bis der neue Subscriber erstellt wird. Während der Erstellung wird der Subscriber mit dem Status "Wird erstellt" auf der Seite Nutzungspläne angezeigt. Sobald es erfolgreich erstellt wurde, wird der neue Subscriber mit dem Status "Aktiv" angezeigt.

   Anstatt den neuen Abonnenten sofort zu erstellen, können Sie ihn später mit Resource Manager und Terraform erstellen. Wählen Sie dazu Als Stack speichern aus, um die Ressourcendefinition als Terraform-Konfiguration zu speichern. Weitere Informationen zum Speichern von Stacks aus Ressourcendefinitionen finden Sie unter Stacks auf der Seite "Ressourcen erstellen" erstellen.

5. Wenn Sie mehr als ein paar Minuten darauf gewartet haben, dass der Subscriber mit dem Status "Aktiv" angezeigt wird (oder wenn der Subscriber-Erstellungsvorgang nicht erfolgreich war):

   1. Wählen Sie den Namen des Subscribers, und wählen Sie Arbeitsanforderungen aus, um einen Überblick über den Erstellungsvorgang des Subscribers anzuzeigen.
   2. Wählen Sie den Vorgang Subscriber erstellen aus, um weitere Informationen zum Vorgang anzuzeigen (einschließlich Fehlermeldungen, Logmeldungen und Status der zugehörigen Ressourcen).
   3. Wenn der Vorgang zum Erstellen des Abonnenten nicht erfolgreich war und Sie die Ursache des Problems nicht aus den Arbeitsanforderungsinformationen diagnostizieren können, gehen Sie zu API-Gateway-Fehler beheben.

So erstellen Sie einen neuen Subscriber und abonnieren ihn mit der CLI für einen oder mehrere Nutzungspläne:

1. Erstellen Sie mit Ihrem bevorzugten JSON-Editor eine Subscriber-Definitionsdatei in folgendem Format:

   {
       "displayName": "<subscriber-name>",
       "clients": [
           {"name": "<api-client-name-one>", "token": "<unique-identifier>"}
       ],
       "usagePlans": ["<usage-plan-ocid>"],
       "compartmentId": "<compartment-ocid>",
       "freeformTags": {},
       "definedTags": {}
   }

   Dabei gilt:

   • "displayName": "<subscriber-name>" ist der Name des neuen Abonnenten. Beispiel: "displayName": "Premium-subscriber". Vermeiden Sie die Eingabe von vertraulichen Informationen.
   • "clients": [{...}] gibt einen oder mehrere API-Clients an, die mit den Nutzungsplänen, die der Abonnent abonniert hat, auf API-Deployments zugreifen. Geben Sie für jeden API-Client Folgendes an:
     • "name": "<api-client-name>" ist ein Name Ihrer Wahl für den API-Client. Client-Namen müssen innerhalb eines Subscribers eindeutig sein. Beispiel: "name": "android". Empfehlung: Geben Sie einen aussagekräftigen Namen an, da Sie ihn API-Consumern zum Erfassen und Analysieren von Nutzungsplandaten bereitstellen können. Vermeiden Sie die Eingabe von vertraulichen Informationen.
     • "token": "<unique-identifier>" ist eine Zeichenfolge Ihrer Wahl, um den API-Client eindeutig zu identifizieren. Das angegebene Token muss in Ihrem Mandanten für die aktuelle Region eindeutig sein und darf nicht mehr als 128 Zeichen enthalten. Beispiel: "token": "abc123def456ghi789jkl".
       Hinweis
       
       Das Token, das Sie für einen API-Client in einer Subscriber-Definition angeben, dient nur zu Berichtserstellungszwecken für den Nutzungsplan. Verwenden Sie dieses Token nicht für die Authentifizierung und Autorisierung des API-Clients. Verwenden Sie stattdessen Autorisiererfunktionen oder JSON Web Tokens (JWTs) für die Authentifizierung und Autorisierung des API-Clients. Siehe Authentifizierung und Autorisierung zu API-Deployments hinzufügen.
   • "usagePlans": [{…}] gibt die OCID eines oder mehrerer Nutzungspläne an, für die der Abonnent abonniert werden soll. Der Nutzungsplan kann zu demselben Compartment wie der Abonnent gehören, muss jedoch nicht. Beispiel: "usagePlans": "ocid1.usageplan.oc1..aaaaaaaaab______gap".
   • "compartmentId": "<compartment-ocid>" ist die OCID des Compartments, zu dem der neue Abonnent gehört. Beispiel: "ocid1.compartment.oc1..aaaaaaaa7______ysq"

   Beispiel:

   {
       "displayName": "MySubscriber",
       "clients": [
           {"name": "android", "token": "XXXXXX"},
           {"name": "iOS", "token": "YYYYYY"}
       ],
       "usagePlans": ["ocid1.usageplan.oc1..aaaaaaaaab______gap", "ocid1.usageplan.oc1..aaaaaaaaab______eya"],
       "compartmentId": "ocid1.compartment.oc1..aaaaaaaa7______ysq",
       "freeformTags": {},
       "definedTags": {}
   }

2. Speichern Sie die Subscriber-Definitionsdatei mit einem Namen Ihrer Wahl. Zum Beispiel, premium-subscriber.json
3. Erstellen Sie mit der Subscriber-Definitionsdatei einen Subscriber mit der CLI:
   1. Konfigurieren Sie die Clientumgebung zur Verwendung der CLI (Clientumgebung zur Verwendung der CLI für API-Gateway-Entwicklung konfigurieren).

   2. Öffnen Sie eine Eingabeaufforderung, und führen Sie oci api-gateway subscriber create aus, um den Subscriber aus der Subscriber-Definitionsdatei zu erstellen:

      oci api-gateway subscriber create --from-json file://<subscriber-definition>.json

      Dabei gilt:

      • --from-json file://<subscriber-definition>.json ist die Datei mit der Subscriber-Definition, einschließlich eines Pfads.

      Beispiel:

      oci api-gateway subscriber create --from-json file://premium-subscriber.json

      Die Antwort auf den Befehl umfasst Folgendes:

      • Die OCID des Subscribers und andere Details.
      • Den Lebenszyklusstatus (Beispiel: ACTIVE, FAILED).
      • Die ID der Arbeitsanforderung zum Erstellen des Subscribers (Details der Arbeitsanforderungen sind für sieben Tage nach Abschluss, Abbruch oder Fehler verfügbar).

      Wenn der Befehl die Steuerung erst dann zurückgeben soll, wenn der Subscriber aktiv ist (oder die Anforderung fehlgeschlagen ist), nehmen Sie einen oder beide der folgenden Parameter auf:

      • --wait-for-state ACTIVE
      • --wait-for-state FAILED

      Beispiel:

      oci api-gateway subscriber create --from-json file://premium-subscriber.json --wait-for-state ACTIVE

      Beachten Sie, dass Sie den Subscriber erst verwenden können, wenn die Arbeitsanforderung erfolgreich erstellt wurde und der Subscriber aktiv ist.

   3. (Optional) So zeigen Sie den Status des Subscribers an:

      oci api-gateway subscriber get --subscriber-id <subscriber-ocid>

   4. So zeigen Sie den Status der Anforderung an, die den Subscriber erstellt:

      oci api-gateway work-request get --work-request-id <work-request-ocid>

   5. (Optional) So zeigen Sie die Logs der Arbeitsanforderung an, die den Subscriber erstellt:

      oci api-gateway work-request-log list --work-request-id <work-request-ocid>

   6. (Optional) Wenn die Arbeitsanforderung, die den Subscriber erstellt, nicht erfolgreich ist und Sie die Fehlerlogs prüfen möchten, geben Sie Folgendes ein:

      oci api-gateway work-request-error --work-request-id <work-request-ocid>

   Weitere Informationen zur Verwendung der CLI finden Sie unter Befehlszeilenschnittstelle (CLI). Eine vollständige Liste der Flags und Optionen, die für CLI-Befehle verfügbar sind, finden Sie in der CLI-Hilfe.

Informationen zur Verwendung der API und zu Signieranforderungen finden Sie unter REST-API-Dokumentation und Sicherheitszugangsdaten. Informationen zu SDKs finden Sie unter SDKs und die CLI.

Verwenden Sie den Vorgang CreateSubscriber, um einen Subscriber zu erstellen.