Event Notifications-CLI-Referenz

Um mit Event Notifications über die Befehlszeilenschnittstelle (CLI) zu arbeiten, können Sie das Event Notifications-CLI-Plug-in aus dem IBM Cloud-Plug-in-Repository installieren. Das Plug-in dient dazu, die Funktionen der IBM Cloud-CLI zu erweitern.

Voraussetzungen

Sie werden benachrichtigt, sobald Updates verfügbar sind, wenn Sie sich bei der IBM Cloud-CLI anmelden. Achten Sie darauf, Ihre CLI auf dem neuesten Stand zu halten, damit Sie Zugriff auf alle neuen Befehle und Flags haben, die für das CLI-Plug-in Event Notifications verfügbar sind.

Event Notifications-CLI installieren

Installieren Sie das CLI-Plug-in Event Notifications mithilfe des Befehls plugin install.

ibmcloud plugin install event-notifications

Versionen des Plugins vor 1.15.2 sind veraltet.

Event Notifications }} CLI-Befehle

Der Befehl init ist veraltet und wird in einer zukünftigen Version entfernt.

ibmcloud event-notifications en-list

Listet die Instanzen in der festgelegten Zielregion auf. Sie können Ihre Instanz-GUID aus den aufgelisteten Instanzen abrufen.

ibmcloud event-notifications en-list

Beispiel

ibmcloud event-notifications en-list

Zielregion festlegen

Legen Sie mithilfe des Befehls ibmcloud target die Region fest, in der Sie arbeiten möchten.

ibmcloud target -r REGION

Alternativ können Sie einen regionalen Endpunkt über die Variable exportieren, wie IBMCLOUD_EN_ENDPOINT im folgenden Beispiel gezeigt.

export IBMCLOUD_EN_ENDPOINT= https://au-syd.event-notifications.cloud.ibm.com/event-notifications

Um den regionalen Endpunkt als öffentlich oder privat festzulegen, beachten Sie die folgenden Optionen:

  • Verfügbare öffentliche Endpunkte:

    • Dallas: https://us-south.event-notifications.cloud.ibm.com/event-notifications
    • London: https://eu-gb.event-notifications.cloud.ibm.com/event-notifications
    • Sydney: https://au-syd.event-notifications.cloud.ibm.com/event-notifications
    • Frankfurt: https://eu-de.event-notifications.cloud.ibm.com/event-notifications
    • Madrid: https://eu-es.event-notifications.cloud.ibm.com/event-notifications
    • Osaka: https://jp-osa.event-notifications.cloud.ibm.com/event-notifications
    • Tokio: https://jp-tok.event-notifications.cloud.ibm.com/event-notifications
    • Toronto: https://ca-tor.event-notifications.cloud.ibm.com/event-notifications
    • São Paulo: https://br-sao.event-notifications.cloud.ibm.com/event-notifications
    • Montreal: https://ca-mon.event-notifications.cloud.ibm.com/event-notifications
    • Washington, D.C.: https://us-east.event-notifications.cloud.ibm.com/event-notifications
    • Chennai: https://in-che.event-notifications.cloud.ibm.com/event-notifications
    • Mumbai: https://in-mum.event-notifications.cloud.ibm.com/event-notifications
  • Verfügbare private Endpunkte:

    • Dallas: https://private.us-south.event-notifications.cloud.ibm.com/event-notifications
    • London: https://private.eu-gb.event-notifications.cloud.ibm.com/event-notifications
    • Sydney: https://private.au-syd.event-notifications.cloud.ibm.com/event-notifications
    • Frankfurt: https://private.eu-de.event-notifications.cloud.ibm.com/event-notifications
    • Madrid: https://private.eu-es.event-notifications.cloud.ibm.com/event-notifications
    • Osaka: https://private.jp-osa.event-notifications.cloud.ibm.com/event-notifications
    • Tokio: https://private.jp-tok.event-notifications.cloud.ibm.com/event-notifications
    • Toronto: https://private.ca-tor.event-notifications.cloud.ibm.com/event-notifications
    • São Paulo: https://private.br-sao.event-notifications.cloud.ibm.com/event-notifications
    • Montreal: https://private.ca-mon.event-notifications.cloud.ibm.com/event-notifications
    • Washington, D.C.: https://private.us-east.event-notifications.cloud.ibm.com/event-notifications
    • Chennai: https://private.in-che.event-notifications.cloud.ibm.com/event-notifications
    • Mumbai: https://private.in-mum.event-notifications.cloud.ibm.com/event-notifications

Sie können auch die Variable EVENT_NOTIFICATIONS_API_KEY exportieren, um den API-Schlüssel oder die Anmeldedaten für den Dienst Ihrer Event Notifications-Instanz zu konfigurieren.

Quellen

Quelle: IBM Cloud Event Notifications

ibmcloud event-notifications source-create

Erstellen Sie eine Quelle, die einen Dienst so konfiguriert, dass er Ereignisse generiert, die von Event Notifications verarbeitet werden können. Sie müssen die ID der Event Notifications-Instanz angeben, für die Sie die Quelle konfigurieren. Weitere Informationen zu Quelltypen und deren Registrierung bei Event Notifications finden Sie unter Hinzufügen einer Quelle aus Event Notifications.

Die CLI unterstützt derzeit ausschließlich die Erstellung von API-Quellen.

ibmcloud event-notifications source-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] --enabled ENABLED [--store-notifications STORE-NOTIFICATIONS]

Sowohl als auch source-create sources-create werden unterstützt. Verwenden Sie zur source-create Einheitlichkeit mit anderen Befehlen.

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--name NAME (Zeichenfolge)

Der Name, der für die API-Quelle anzugeben ist. Erforderlich.

Der Standardwert ist . Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--description (Zeichenfolge)

Die Beschreibung der API-Quelle.

Der Standardwert ist "". Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--enabled(Boolesch)

Quelle aktivieren oder deaktivieren. Erforderlich. Stellen Sie die Einstellung auf ein, um true die Quelle zu aktivieren.

--store-notifications(Boolesch)

Benachrichtigungen speichern. Stellen Sie die Option ein, um true Benachrichtigungen zu speichern, damit Sie den Inhalt eingehender Ereignisse zur Fehlerbehebung einsehen können.

Beispiel

ibmcloud event-notifications source-create \
   --instance-id=exampleString \
   --name=exampleString \
   --description=exampleString \
   --enabled=true \
   --store-notifications=false

ibmcloud event-notifications source-update

Aktualisieren Sie die Quellparameter mithilfe der Quell-ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die Quelle konfiguriert ist.

ibmcloud event-notifications source-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung der Quelle. Erforderlich.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

--name (Zeichenfolge)

Der aktualisierte Name für die API-Quelle.

Der Standardwert ist . Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--description (Zeichenfolge)

Die aktualisierte Beschreibung der API-Quelle.

Der Standardwert ist "". Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--enabled(Boolesch)

Quelle aktivieren oder deaktivieren.

Der Wert wird auf "true" gesetzt, um die Quelle zu aktivieren, und auf "false", um die Quelle zu deaktivieren.

--store-notifications(Boolesch)

Benachrichtigungen speichern. Sie können die Nutzdaten eingehender Ereignisse zur Fehlerbehebung einsehen.

Der Standardwert ist false.

Beispiel

ibmcloud event-notifications source-update \
   --instance-id=exampleString \
   --id=exampleString \
   --name=exampleString \
   --description=exampleString \
   --enabled=true \
   --store-notifications=false

ibmcloud event-notifications sources

Listen Sie alle Quellen in einer bestimmten Instanz auf.

ibmcloud event-notifications sources --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--limit (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

--search (Zeichenfolge)

Der Suchbegriff zum Filtern von Ergebnissen.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Quellsammlung anzuzeigen.

Beispiel

ibmcloud event-notifications sources \
  --instance-id=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

ibmcloud event-notifications source

Erfahren Sie mehr über eine bestimmte Quelle.

ibmcloud event-notifications source --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung der Quelle. Erforderlich.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

Beispiel

ibmcloud event-notifications source \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications source-delete

Eine Quelle löschen.

ibmcloud event-notifications source-delete  --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--id (Zeichenfolge)

Eindeutige ID für Quelle. Erforderlich.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--force

Überspringen Sie die Bestätigungsabfrage und erzwingen Sie die Löschung der Ressource.

Beispiel

ibmcloud event-notifications source-delete \
  --instance-id=exampleString \
  --id=exampleString

Ziele

Betreiben Sie die Website IBM Cloud Event Notifications.

ibmcloud event-notifications destination-create

Erstellen Sie ein Ziel, das als Zustelladresse für eine Benachrichtigung dient. Ein Ziel kann so konfiguriert werden, dass Benachrichtigungen an einen menschlichen Benutzer oder an einen automatisierten Dienst gesendet werden.

ibmcloud event-notifications destination-create --instance-id INSTANCE-ID --name NAME --type TYPE [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--name (Zeichenfolge)

Der Name des Ziels. Erforderlich.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--type (Zeichenfolge)

Der Typ des Ziels. Ziele für menschliche Nutzer: smtp_ibm, sms_ibm, smtp_custom, sms_custom, event_streams, msteams, pagerduty, push_android, push_chrome, push_firefox, push_huawei, push_ios, push_safari, servicenow, slack. Ziele für Dienste: ibmce, ibmcos, webhook. Erforderlich.

Die Mindestlänge beträgt Zeichen 1.

--description (Zeichenfolge)

Die Beschreibung des Ziels.

Der Standardwert ist . Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--collect-failed-events(Boolesch)

Setzen Sie die Einstellung auf, um true fehlgeschlagene Ereignisse in einem Cloud Object Storage-Bucket zu erfassen. Um Fehlerereignisse zu erfassen, aktivieren Sie die Cloud Object Storage-Integration für diese Instanz. Der Standardwert ist false.

--config (DestinationConfig Beispiele )

Die Konfiguration für das Ziel. Wenn Sie ein Ziel ohne „ --config “ anlegen, wird das Ziel zwar angelegt, funktioniert aber erst, wenn Sie es konfigurieren.

--certificate (Zeichenfolge)

Der Pfad zur Zertifikatsdatei für APNs- oder iOS-Push-Ziele. Unterstützt Zertifikatsdateien im Format p8 und p12.

--certificate-content-type (Zeichenfolge)

Der Inhaltstyp des Zertifikats für iOS-Ziele. Zulässige Werte sind und p8 p12.

--icon16x16 (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 16x16. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon16x16-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 16x16.

--icon16x162x (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 16x16@2x. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon16x162x-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 16x16@2x.

--icon32x32 (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 32x32. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon32x32-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 32x32.

--icon32x322x (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 32x32@2x. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon32x322x-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 32x32@2x.

--icon128x128 (Zeichenfolge)

Der Dateipfad für das Safari-Symbol 128x128. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon128x128-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 128x128.

--icon128x1282x (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 128x128@2x. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon128x1282x-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 128x128@2x.

Cloud Functions wird als Zielort nicht mehr unterstützt.

Beispiele

ibmcloud event-notifications destination-create \
  --instance-id=exampleString \
  --name=exampleString \
  --type=webhook \
  --description=exampleString \
  --collect-failed-events=false \
  --config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
  --certificate=tempdir/test-file.txt \
  --certificate-content-type=exampleString \
  --icon16x16=tempdir/test-file.txt \
  --icon16x16-content-type=exampleString \
  --icon16x162x=tempdir/test-file.txt \
  --icon16x162x-content-type=exampleString \
  --icon32x32=tempdir/test-file.txt \
  --icon32x32-content-type=exampleString \
  --icon32x322x=tempdir/test-file.txt \
  --icon32x322x-content-type=exampleString \
  --icon128x128=tempdir/test-file.txt \
  --icon128x128-content-type=exampleString \
  --icon128x1282x=tempdir/test-file.txt \
  --icon128x1282x-content-type=exampleString
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel iOS (push_ios) mit dem Zertifikat P8. Setzen Sie den booleschen Parameter pre_prod auf "true ", um das Ziel als Vorproduktionsziel zu konfigurieren. Setzen Sie den Wert andernfalls auf "false ":

    {
       "params" : {
          "cert_type" : "p8",
          "is_sandbox" : true,
          "key_id": "production",
          "team_id": "1234",
          "bundle_id": "test1",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel iOS (push_ios) mit dem Zertifikat P12. Setzen Sie den booleschen Parameter pre_prod auf "true ", um das Ziel als Vorproduktionsziel zu konfigurieren, andernfalls setzen Sie den Wert auf "false ".

    {
       "params" : {
          "cert_type" : "p12",
          "is_sandbox" : true,
          "password": "apnspasswordvalue",
          "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Chrome-Ziel (push_chrome). Setzen Sie den booleschen Parameter pre_prod auf "true ", um das Ziel als Vorproduktionsziel zu konfigurieren, andernfalls setzen Sie den Wert auf "false ".

    {
       "params" : {
          "api_key": "chromeapikey",
          "website_url" : "https://testwebsite.com",
          "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel Firefox (push_firefox). Setzen Sie den booleschen Parameter pre_prod auf "true ", um das Ziel als Vorproduktionsziel zu konfigurieren, andernfalls setzen Sie den Wert auf "false ".

    {
       "params" : {
          "website_url" : "https://testwebsite.com",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig-Objekts für Slack destination(slack) mit dem Typ "incoming_webhook".

    {
       "params" : {
          "type" : "incoming_webhook",
          "url" : "https://hooks.slack.com/services/G0gyhsush/TYodsjhs/GHTbfidsimkk"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig-Objekts für Slack destination(slack) mit dem Typ direct_message.

    {
       "params" : {
          "type" : "direct_message",
          "token" : "vhdwvecwefwefewivcweivcwiwiciwcvwicwec"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts DestinationConfig für das Safari-Ziel (push_safari). Setzen Sie den booleschen Parameter pre_prod auf "true ", um das Ziel als Vorproduktionsziel zu konfigurieren, andernfalls setzen Sie den Wert auf "false ".

    {
       "params": {
          "cert_type":"p12",
          "certificate_name":"Users/Testuser/Documents/safari.p12",
          "password":"safarinew",
          "url_format_string":"https://test.com",
          "website_name":"testwebsite",
          "website_push_id":"test",
          "website_url":"https://test.com",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel MS Teams (msteams).

    {
       "params" : {
          "url" : "https://xyz.webhook.office.com"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts DestinationConfig für das Ziel PagerDuty(pagerduty.

    Es wird empfohlen, bei der Erstellung des Ziels nur den Schlüssel Routing zu verwenden. Der API-Schlüssel ist veraltet und wird in Zukunft nicht mehr verwendet werden können.

    {
       "params" : {
          "routing_key" : "routingkeytoconnecttoPD",
          "api_key" : "cffunctionnamespaceserviceidapikey"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für Webhook (webhook).

    {
       "params" : {
          "url" : "exampleString",
          "verb" : "get",
          "custom_headers" : { },
          "sensitive_headers" : [ "exampleString" ]
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel Android (push_android).

    {
       "params" : {
          "project_id" : "6232305230320",
          "private_key" : "36e21epfweort823or8rt832pr8p2r832pr82pr382r8f",
          "client_email" : "testuser.123@gmail.com",
          "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts DestinationConfig für das Ziel ServiceNow(servicenow.

    {
       "params" : {
          "client_id" : "359705ceddd100eyfewyyw1f0f9e1c96",
          "client_secret": "testsecrets",
          "username": "testuser",
          "password": "user_password",
          "instance_name": "testinstancenje"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel Code Engine (ibmce).

    code-Engine-Zieltyp: Anwendung

    {
       "params" : {
          "type" : "application",
          "url" : "https://codeengine.test.com",
          "verb" : "get",
          "custom_headers" : { },
          "sensitive_headers" : [ "exampleString" ]
       }
    }
    

    code Motor Zielart: Job

    {
       "params" : {
          "type" : "job",
          "job_name" : "custom-job",
          "project_crn" : "crn:v1:bluemix:public:codeengine:us-south:a/e7e5820aeccb40efb78fd69a7858ef23:xxxxxxxxxxxxxx::"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel IBM Cloud Object Storage (ibmcos).

    {
       "params" : {
          "bucket_name" : "cos-destination-en-bucket",
          "instance_id" : "42e13636e-0548-41a0-a178-e95be28464773",
          "endpoint" : "https://s3.us-west.cloud-object-storage.appdomain.cloud"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel Huawei (push_huawei).

    {
       "params" : {
          "client_id" : "359705ceddd100eyfew",
          "client_secret": "testsecrets",
          "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel Custom Email (smtp_custom). Im Falle eines benutzerdefinierten E-Mail-Sandbox-Ziels (smtp_custom_sandbox) sind die Parameter für die Zielkonfiguration nicht erforderlich.

    Vorgehensweise zur Konfiguration und Überprüfung einer benutzerdefinierten Domain: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify

    {
       "params" : {
          "domain": "mailx.com"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel Event Streams (event_streams).

    {
       "params" : {
          "crn": "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c13357373:a292db6e-af78-4c0b-b3db-7d6794b637g::",
          "endpoint": "https://n6627w6t7dgeh2cfgd.svc09.us-south.eventstreams.cloud.ibm.com",
          "topic": "demo_topic"
       }
    }
    
  • Das folgende Beispiel zeigt das Format des DestinationConfig Objekts für das Ziel App Configuration (app_configuration).

    {
       "params" : {
          "type": "features",
          "crn": "crn:v1:bluemix:public:apprapp:us-south:a/4a74f2c31f554afc88156b73a1d577c6:dbxxxx93-0xxa-4xx5-axcf-c2faxxxd::",
          "environment_id": "stage",
          "feature_id": "test"
       }
    }
    

    Ein benutzerdefiniertes SMS-Ziel kann ohne erstellt werden DestinationConfig, ist jedoch erst funktionsfähig, wenn die erforderlichen personalisierten Nummern ausdrücklich angefordert und konfiguriert wurden. Informationen zur Beantragung personalisierter Nummern finden Sie unter „ Personalisierte SMS-Nummern “.

ibmcloud event-notifications destinations

Listen Sie alle Ziele für eine Event Notifications-Instanz auf.

ibmcloud event-notifications destinations --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--limit (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

--search (Zeichenfolge)

Der Suchbegriff zum Filtern von Ergebnissen.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Zielsammlung anzuzeigen.

Beispiel

ibmcloud event-notifications destinations \
  --instance-id=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

ibmcloud event-notifications destination

Rufen Sie die Details eines Ziels anhand seiner ID ab.

ibmcloud event-notifications destination --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Ziel. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

Beispiel

ibmcloud event-notifications destination \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications destination-update

Aktualisieren Sie die Zielparameter mithilfe der Ziel-ID.

ibmcloud event-notifications destination-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Ziel. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--name (Zeichenfolge)

Der aktualisierte Name des Ziels.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--description (Zeichenfolge)

Die aktualisierte Beschreibung des Ziels.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--collect-failed-events(Boolesch)

Setzen Sie die Einstellung auf, um true fehlgeschlagene Ereignisse in einem Cloud Object Storage-Bucket zu erfassen. Der Standardwert ist false.

--config (DestinationConfig)

Die aktualisierte Konfiguration für das Ziel.

Geben Sie eine JSON-Zeichenfolgeoption an oder geben Sie eine JSON-Datei an, aus der gelesen werden soll, indem Sie eine Dateipfadoption angeben, die mit @ beginnt, z. B. --config=@path/to/file.json.

--certificate (Zeichenfolge)

Der Pfad zur Zertifikatsdatei für APNs- oder iOS-Push-Ziele. Unterstützt Zertifikatsdateien im Format p8 und p12.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--certificate-content-type (Zeichenfolge)

Der Inhaltstyp des Zertifikats für iOS-Ziele. Zulässige Werte sind und p8 p12.

--icon16x16 (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 16x16. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon16x16-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 16x16.

--icon16x162x (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 16x16@2x. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon16x162x-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 16x16@2x.

--icon32x32 (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 32x32. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon32x32-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 32x32.

--icon32x322x (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 32x32@2x. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon32x322x-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 32x32@2x.

--icon128x128 (Zeichenfolge)

Der Dateipfad für das Safari-Symbol 128x128. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon128x128-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 128x128.

--icon128x1282x (Zeichenfolge)

Der Dateipfad für das Safari-Symbol lautet 128x128@2x. Für push_safari Zielorte.

Die maximale Länge beträgt 5000 Zeichen. Die Mindestlänge beträgt Zeichen 1.

--icon128x1282x-content-type (Zeichenfolge)

Der Inhaltstyp des Safari-Symbols 128x128@2x.

Beispiel

ibmcloud event-notifications destination-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --collect-failed-events=false \
  --config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
  --certificate=tempdir/test-file.txt \
  --certificate-content-type=exampleString \
  --icon16x16=tempdir/test-file.txt \
  --icon16x16-content-type=exampleString \
  --icon16x162x=tempdir/test-file.txt \
  --icon16x162x-content-type=exampleString \
  --icon32x32=tempdir/test-file.txt \
  --icon32x32-content-type=exampleString \
  --icon32x322x=tempdir/test-file.txt \
  --icon32x322x-content-type=exampleString \
  --icon128x128=tempdir/test-file.txt \
  --icon128x128-content-type=exampleString \
  --icon128x1282x=tempdir/test-file.txt \
  --icon128x1282x-content-type=exampleString

ibmcloud event-notifications destination-delete

Löschen Sie ein Ziel anhand seiner ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die das Ziel konfiguriert ist.

ibmcloud event-notifications destination-delete --instance-id INSTANCE-ID --id ID [--force]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Ziel. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--force(Boolesch)

Erzwingen Sie die Ausführung des Befehls.

Beispiel

ibmcloud event-notifications destination-delete \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications enabled-countries

Rufen Sie die Details zu den aktivierten Ländern eines SMS-Empfängers anhand dessen ID ab. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die das Ziel konfiguriert ist.

ibmcloud event-notifications enabled-countries --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für den SMS-Empfänger. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

Beispiel

ibmcloud event-notifications enabled-countries \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications test-destination

Testen Sie eine Zielkonfiguration anhand ihrer ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die das Ziel konfiguriert ist. Eine Liste der unterstützten Ziele finden Sie unter Ein Ziel testen.

ibmcloud event-notifications test-destination --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Ziel. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

Beispiel

ibmcloud event-notifications test-destination \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications sandbox-destination-update

Ein E-Mail-Ziel in der Sandbox mit einer benutzerdefinierten Domain in die Produktionsumgebung übertragen.

ibmcloud event-notifications sandbox-destination-update --instance-id INSTANCE-ID --id ID --domain DOMAIN

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Ziel. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--domain (Zeichenfolge)

Die E-Mail-Domain. Erforderlich.

Die maximale Länge beträgt 250 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

Beispiel

ibmcloud event-notifications sandbox-destination-update \
    --instance-id=exampleString \
    --id=exampleString \
    --domain=exampleString

ibmcloud event-notifications verify-destination-update

Überprüfen Sie die SPF- und DKIM-Einträge einer benutzerdefinierten Domain.

ibmcloud event-notifications verify-destination-update --instance-id INSTANCE-ID --id ID --type TYPE

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Ziel. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--type (Zeichenfolge)

Die Art der Verifizierung für eine E-Mail-Adresse mit benutzerdefinierter Domain. Zulässige Werte sind und spf dkim. Erforderlich.

Die maximale Länge beträgt 20 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-z]/ entsprechen.

Beispiel

ibmcloud event-notifications verify-destination-update \
  --instance-id=exampleString \
  --id=exampleString \
  --type=exampleString

Themen

Thema IBM Cloud Event Notifications bearbeiten.

ibmcloud event-notifications topic-create

Erstellen Sie ein Thema, um Ereignisse von Quellen zu empfangen und Benachrichtigungen an abonnierte Ziele zu senden. Von einem Thema kann eine Verbindung zu mehreren Quellen hergestellt werden. Um ein Thema zu erstellen, müssen Sie die ID der Event Notifications-Instanz angeben.

Weitere Informationen finden Sie unter Ein Thema erstellen.

ibmcloud event-notifications topic-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] [--sources SOURCES]

Befehlsoptionen

--instance-id INSTANCE-ID (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--name NAME (Zeichenfolge)

Der Name des Themas. Erforderlich.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--description DESCRIPTION (Zeichenfolge)

Beschreibung des Themas.

Der Standardwert ist "". Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--sources SOURCES (TopicCreateSourcesItem[])

Die Quell- und Filterkonfiguration, die mit dem Thema verknüpft werden soll. Siehe Beispiele für die Quellkonfiguration.

Beispiel

ibmcloud event-notifications topic-create \
  --instance-id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'
  • Das folgende Beispiel zeigt das Format des TopicCreateSourcesItem[]-Objekts für die Periodic Timer-Quelle.

    [
       {
          "id" : "exampleString",
          "rules" : [
             {
                "enabled" : true,
                "event_schedule_filter": {
                   "starts_at": "2024-12-23T12:00:00.000Z",
                   "ends_at": "2024-12-23T20:00:00.000Z",
                   "expression": "* * * * *"
                }
             }
          ]
       }
    ]
    
  • Das folgende Beispiel zeigt das Format des Objekts TopicCreateSourcesItem[].

    [
       {
          "id" : "exampleString",
          "rules" : [
             {
                "enabled" : true,
                "event_type_filter" : "$.*",
                "notification_filter" : "exampleString"
             }
          ]
       }
    ]
    
  • Das folgende Beispiel zeigt das Format des Objekts TopicUpdateSourcesItem[].

    [
       {
          "id" : "exampleString",
          "rules" : [
             {
                "enabled" : true,
                "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'",
                "notification_filter" : "$.notification.findings[0].severity == \'MODERATE\'",
                "rule_id" : "exampleString"
             }
          ]
       }
    ]
    

ibmcloud event-notifications topics

Listen Sie alle Themen auf, die für eine Event Notifications-Instanz erstellt wurden. Sie müssen die ID der Instanz angeben.

ibmcloud event-notifications topics --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--limit (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

--search (Zeichenfolge)

Der Suchbegriff zum Filtern von Ergebnissen.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Themen-Sammlung anzuzeigen.

Beispiel

ibmcloud event-notifications topics \
  --instance-id=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

ibmcloud event-notifications topic

Rufen Sie die Details zu einem Thema anhand seiner ID ab. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die das Thema konfiguriert ist.

ibmcloud event-notifications topic --instance-id INSTANCE-ID --id ID [--include INCLUDE]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Thema. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--include (Zeichenfolge)

Unterthemen einbeziehen.

Der Standardwert ist "". Die maximale Länge beträgt 20 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-z]/ entsprechen.

Beispiel

ibmcloud event-notifications topic \
  --instance-id=exampleString \
  --id=exampleString \
  --include=exampleString

ibmcloud event-notifications topic-update

Aktualisieren Sie die Details eines Themas anhand seiner ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die das Thema konfiguriert ist.

ibmcloud event-notifications topic-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES]

Sie können topic-replace als Alias für verwenden topic-update. Der Befehl topic-replace ist veraltet und wird in einer zukünftigen Version entfernt.

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Thema. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--name (Zeichenfolge)

Der aktualisierte Name des Themas.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--description (Zeichenfolge)

Die aktualisierte Beschreibung des Themas.

Der Standardwert ist "". Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/ entsprechen.

--sources (TopicUpdateSourcesItem[])

Die aktualisierten Angaben zu Quellen und Filtern. Siehe Beispiele für die Quellkonfiguration.

Diese Option fügt nur neue Quellen hinzu. Quellen, die bereits mit dem Thema verknüpft sind, können nicht ersetzt oder aktualisiert werden. Um Quellfilter zu ändern, entfernen Sie die Quelle aus dem Thema und fügen Sie sie mit der neuen Filterkonfiguration erneut hinzu.

Beispiel

ibmcloud event-notifications topic-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'

ibmcloud event-notifications topic-delete

Löschen Sie ein Thema anhand seiner ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die das Thema konfiguriert ist.

ibmcloud event-notifications topic-delete --instance-id INSTANCE-ID --id ID [--force]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Thema. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--force(Boolesch)

Erzwingen Sie die Ausführung des Befehls.

Beispiel

ibmcloud event-notifications topic-delete \
  --instance-id=exampleString \
  --id=exampleString

Abonnements

Abonnement für IBM Cloud Event Notifications aktivieren.

ibmcloud event-notifications subscription-create

Erstellen Sie ein Abonnement, das ein Ziel mit einem Thema für die Ereignisübermittlung verknüpft. Ein Ziel kann Themen abonnieren, und mehrere Ziele können dasselbe Thema abonnieren. Um ein Abonnement anzulegen, müssen Sie die ID der Event Notifications-Instanz angeben.

ibmcloud event-notifications subscription-create --instance-id INSTANCE-ID --name NAME --destination-id DESTINATION-ID --topic-id TOPIC-ID [--description DESCRIPTION] [--attributes ATTRIBUTES]

Befehlsoptionen

--name (Zeichenfolge)

Der Name des Abonnements. Erforderlich.

Die maximale Länge beträgt 50 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--description (Zeichenfolge)

Die Beschreibung des Abonnements.

Der Standardwert ist "". Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--destination-id (Zeichenfolge)

Die Ziel-ID für den Link zu diesem Thema. Erforderlich.

Die maximale Länge beträgt 150 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--topic-id (Zeichenfolge)

Die Themen-ID für das Abonnement. Erforderlich.

Die maximale Länge beträgt 150 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--attributes (SubscriptionCreateAttributes)

Die Attribute, die zum Erstellen des Abonnements erforderlich sind. Siehe Beispiele für Attribute.

Beispiele

ibmcloud event-notifications subscription-create \
  --instance-id=exampleString \
  --name=exampleString \
  --destination-id=exampleString \
  --topic-id=exampleString \
  --description=exampleString \
  --attributes='{"invited": ["exampleString"]}'
  • Das folgende Beispiel zeigt das Format des SubscriptionCreateAttributes Objekts für Webhooks.
{
   "signing_enabled" : true,
   "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13"
}
  • Das folgende Beispiel zeigt das Format des SubscriptionCreateAttributes Objekts für SMS.
{
   "invited" :["+1xxxxxxxxxx", "+1xxxxxxxxxx"]
}
  • Das folgende Beispiel zeigt das Format des SubscriptionCreateAttributes Objekts für IBM-E-Mail.
{
   "invited" :["entest@gmail.com"],
   "add_notification_payload": true,
   "reply_to_mail": "en@ibm.com",
   "reply_to_name": "EYS ORG",
   "from_name":"ABC ORG"
}
  • Das folgende Beispiel zeigt das Format des SubscriptionCreateAttributes Objekts für den Slack-Zieltyp incoming_webhook.
{
   "attachment_color" : "#FF0000",
   "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}
  • Das folgende Beispiel zeigt das Format des SubscriptionCreateAttributes Objekts für den Slack-Zieltyp direct_message.
{
"channels" : [{ "id": "GHIUIFJHGGH"},{"id": "TSFDIDFOFNF"}],
"template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}
  • Das folgende Beispiel zeigt das Format des Objekts SubscriptionCreateAttributes für ServiceNow.
{
   "assigned_to" : "serviceuser@gmail.com",
   "assignment_group" : "incidentgroup"
}
  • Das folgende Beispiel zeigt das Format des SubscriptionCreateAttributes Objekts für Custom Email.

    {
       "invited" :["entest@gmail.com"],
       "add_notification_payload": true,
       "reply_to_mail": "en@ibm.com",
       "reply_to_name": "EYS ORG",
    }
    
  • Das folgende Beispiel zeigt das Format des SubscriptionCreateAttributes Objekts für Custom Email Sandbox.

    {
       "invited" :["entest@gmail.com"],
       "add_notification_payload": true,
       "reply_to_mail": "en@ibm.com",
       "reply_to_name": "EYS ORG",
       "from_name":"ABC ORG",
       "from_email":"Testuser@mailx.com",
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
       "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts SubscriptionCreateAttributes für Pagerduty/ Event Streams.

    {
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts SubscriptionCreateAttributes für App Configuration. Beim Erstellen oder Aktualisieren eines Abonnements für ein App Configuration ziel hat das Objekt attributes eine bestimmte Regel:

    • Sie müssen entweder feature_flag_enabled oder template_id_notification
    • Sie können nicht beide Eigenschaften gleichzeitig einbeziehen

    Dadurch wird sichergestellt, dass ein Abonnement für den richtigen Anwendungsfall erstellt wird – entweder für die Auswertung von Feature-Flags oder für die Erstellung von Benachrichtigungsvorlagen, jedoch nicht für beides gleichzeitig.

    {
       "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
    }
    
    {
       "feature_flag_enabled": false,
    }
    

ibmcloud event-notifications subscriptions

Listen Sie alle Abonnements auf, die für eine Event Notifications-Instanz konfiguriert sind. Sie müssen die ID der Instanz angeben.

ibmcloud event-notifications subscriptions --instance-id INSTANCE-ID [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--all-pages]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--offset (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

--limit (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--search (Zeichenfolge)

Der Suchbegriff zum Filtern von Ergebnissen.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Abonnement-Sammlung anzuzeigen.

Beispiel

ibmcloud event-notifications subscriptions \
  --instance-id=exampleString \
  --offset=0 \
  --limit=10 \
  --search=exampleString

ibmcloud event-notifications subscription

Rufen Sie die Details eines Abonnements anhand seiner ID ab. Sie müssen die ID der Event Notifications-Instanz angeben, für die das Abonnement konfiguriert ist.

ibmcloud event-notifications subscription --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Abonnement. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

Beispiel

ibmcloud event-notifications subscription \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications subscription-delete

Löschen Sie ein Abonnement anhand seiner ID. Sie müssen die ID der Event Notifications-Instanz angeben, für die das Abonnement konfiguriert ist.

ibmcloud event-notifications subscription-delete --instance-id INSTANCE-ID --id ID [--force]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Abonnement. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--force(Boolesch)

Erzwingen Sie die Ausführung des Befehls.

Beispiel

ibmcloud event-notifications subscription-delete \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications subscription-update

Aktualisieren Sie die Parameter eines Abonnements anhand seiner ID. Sie müssen die ID der Event Notifications-Instanz angeben, für die das Abonnement konfiguriert ist.

ibmcloud event-notifications subscription-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für das Abonnement. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--name (Zeichenfolge)

Der aktualisierte Name des Abonnements.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

--description (Zeichenfolge)

Die aktualisierte Beschreibung des Abonnements.

Der Standardwert ist "". Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

--attributes (SubscriptionUpdateAttributes)

Die aktualisierten Attribute. Siehe Beispiele für Attribute.

Beispiele

ibmcloud event-notifications subscription-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --attributes='{"invited": {"add": ["exampleString"], "remove": ["exampleString"]}, "subscribed": {"remove": ["exampleString"]}, "unsubscribed": {"remove": ["exampleString"]}}'
  • Das folgende Beispiel zeigt das Format des SubscriptionUpdateAttributes Objekts für Webhook.

    {
       "signing_enabled": true
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts SubscriptionUpdateAttributes für IBM SMS.

    {
       "invited": {
          "add": ["+8xxxxxxxxxx"],
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       },
       "subscribed": {
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       },
       "unsubscribed": {
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       }
    }
    
  • Das folgende Beispiel zeigt das Format des SubscriptionUpdateAttributes Objekts für IBM-E-Mail.

    {
       "invited": {
          "add": ["example1@gmail.com"],
          "remove": []
       },
       "subscribed": {
          "remove": ["example2@gmail.com"]
       },
       "unsubscribed": {
          "remove": ["example3@gmail.com"]
       },
       "reply_to_mail": "example@ibm.com",
       "reply_to_name": "USA news",
       "from_name": "IBM",
       "add_notification_payload": true
    }
    
  • Das folgende Beispiel zeigt das Format des SubscriptionUpdateAttributes Objekts für Custom Email.

    {
       "invited": {
          "add": ["example1@gmail.com"],
          "remove": []
       },
       "subscribed": {
          "remove": ["example2@gmail.com"]
       },
       "unsubscribed": {
          "remove": ["example3@gmail.com"]
       },
       "reply_to_mail": "example@ibm.com",
       "reply_to_name": "USA news",
       "from_name": "IBM",
       "from_email": "test@email.com",
       "add_notification_payload": true,
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
       "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
    }
    
  • Das folgende Beispiel zeigt das Format des SubscriptionUpdateAttributes Objekts für Custom Email Sandbox.

    {
       "invited": {
          "add": ["example1@gmail.com"],
          "remove": []
       },
       "subscribed": {
          "remove": ["example2@gmail.com"]
       },
       "unsubscribed": {
          "remove": ["example3@gmail.com"]
       },
       "reply_to_mail": "example@ibm.com",
       "reply_to_name": "USA news",
       "add_notification_payload": true,
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
       "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts SubscriptionUpdateAttributes für Slack für den Typ incoming_webhook.

    {
       "attachment_color" : "#FF0000",
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    
  • Das folgende Beispiel zeigt das Format des Objekts SubscriptionUpdateAttributes für Slack für den Typ direct_message.

    {
       "channels": [{"id": "D01CFDTYBH", "operation": "add"}, {"id": "D01GHUTYBH", "operation": "remove"}],
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    
  • Das folgende Beispiel zeigt das Format des SubscriptionUpdateAttributes Objekts für Service Now.

    {
       "assigned_to" : "serviceuser@gmail.com",
       "assignment_group" : "incidentgroup"
    }
    
    • Das folgende Beispiel zeigt das Format des Objekts SubscriptionUpdateAttributes für Pagerduty/ Event Streams.
    {
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    
    • Das folgende Beispiel zeigt das Format des Objekts SubscriptionCreateAttributes für App Configuration. Beim Erstellen oder Aktualisieren eines Abonnements für ein App Configuration ziel hat das Objekt attributes eine bestimmte Regel:

      • Sie müssen entweder feature_flag_enabled oder template_id_notification
      • Sie können nicht beide Eigenschaften gleichzeitig einbeziehen

      Dadurch wird sichergestellt, dass ein Abonnement für den richtigen Anwendungsfall erstellt wird – entweder für die Auswertung von Feature-Flags oder für die Erstellung von Benachrichtigungsvorlagen, jedoch nicht für beides gleichzeitig.

    {
       "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
    }
    
    {
       "feature_flag_enabled": false,
    }
    

Integrationen

Arbeiten Sie mit IBM Cloud Event Notifications Integration.

ibmcloud event-notifications integration-create

Erstellen Sie eine Integration, die Event Notifications mit IBM Cloud und Object Storage verbindet.

ibmcloud event-notifications integration-create --instance-id INSTANCE-ID --type TYPE --metadata METADATA

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--type (Zeichenfolge)

Die Art der Integration. Der unterstützte Dateityp ist collect_failed_events. Erforderlich.

Die maximale Länge beträgt 50 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Zulässiger Wert ist collect_failed_events.

--metadata (Zeichenfolge)

Die Integrationsmetadaten, die zum Erstellen der Integration erforderlich sind. Beachten Sie das Beispiel für Hinweise zur Formatierung. Erforderlich.

Beispiele

ibmcloud event-notifications integration-create \
  --instance-id=exampleString \
  --type=collect_failed_events \
  --metadata='{"endpoint": "exampleString", "crn": "exampleString", "bucket_name": "exampleString"}'

Das folgende Beispiel zeigt das Format des Objekts IntegrationCreateAttributes.

{
   "endpoint": "https://s3.us-west.cloud-object-storage.appdomain.cloud",
   "crn": "crn:v1:bluemix:public:cloud-object-storage:global:xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx::",
   "bucket_name": "cloud-object-storage"
}

ibmcloud event-notifications integration-update

Aktualisieren Sie eine vorhandene Integration anhand ihrer ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die Integration konfiguriert ist.

ibmcloud event-notifications integration-update --instance-id INSTANCE-ID --id ID --type TYPE --metadata METADATA

Derzeit können Sie diese auch verwenden, um integration-replace Ihre Integration zu aktualisieren. Der Befehl integration-replace ist jedoch veraltet und wird in einer zukünftigen Version entfernt.

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--type (Zeichenfolge)

Der Integrationstyp. Zulässige Werte sind kms, hs-crypto, und collect_failed_events. Erforderlich.

Die maximale Länge beträgt 50 Zeichen. Die Mindestlänge beträgt 1 Zeichen.

--metadata (Zeichenfolge)

Die Integrationsmetadaten, die zur Aktualisierung der Integration erforderlich sind. Beachten Sie das Beispiel für Hinweise zur Formatierung. Erforderlich.

--id (Zeichenfolge)

Die eindeutige Kennung für die Integration. Erforderlich.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

Beispiele

ibmcloud event-notifications integration-update \
  --instance-id=exampleString \
  --id=exampleString \
  --type=exampleString \
  --metadata='{"endpoint": "exampleString", "crn": "exampleString", "root_key_id": "exampleString", "bucket_name": "exampleString"}'

Das folgende Beispiel zeigt das Format des Objekts IntegrationReplaceAttributes für Key Protect.

{
   "endpoint" : "https://qa.us-south.kms.cloud.ibm.com",
   "crn" : "crn of key protect",
   "root_key_id" : "root key id"
}

ibmcloud event-notifications integrations

Listen Sie die Integrationen auf, die für eine Event Notifications-Instanz erstellt wurden.

ibmcloud event-notifications integrations --instance-id INSTANCE-ID [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--all-pages]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige Kennung für die Instanz IBM Cloud Event Notifications.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--limit (int64)

Seitenbegrenzung für seitenbezogene Ergebnisse.

Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Offset für seitenbezogene Ergebnisse.

Der Mindestwert ist 0.

--search (Zeichenfolge)

Suchbegriff zum Filtern der Ergebnisse.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Integrationssammlung anzuzeigen.

Beispiel

ibmcloud event-notifications integrations \
  --instance-id=exampleString \
  --offset=0 \
  --limit=10 \
  --search=exampleString

ibmcloud event-notifications integration

Rufen Sie die Details einer Integration anhand ihrer ID ab. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die Integration konfiguriert ist.

ibmcloud event-notifications integration --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für die Integration. Erforderlich.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

Beispiel

ibmcloud event-notifications integration \
  --instance-id=exampleString \
  --id=exampleString

Vorlagen

IBM Cloud Event Notifications Vorlagen.

ibmcloud event-notifications template-create

Erstellen Sie eine Vorlage für Einladungen und Benachrichtigungen. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die Sie die Vorlage konfigurieren.

ibmcloud event-notifications template-create --instance-id INSTANCE-ID --name NAME --type TYPE --params PARAMS [--description DESCRIPTION]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 10 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--name (Zeichenfolge)

Der Name der Schablone. Erforderlich.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--type (Zeichenfolge)

Die Art der Vorlage. Unterstützte Typen sind smtp_custom.invitation, smtp_custom.notification, webhook.notification, slack.notification, pagerduty.notification, und event_streams.notification. Erforderlich.

Die maximale Länge beträgt 24 Zeichen. Die Mindestlänge beträgt 22 Zeichen. Der Wert muss dem regulären Ausdruck /^(smtp_custom.notification|smtp_custom.invitation)$/ entsprechen.

--params (TemplateConfig)

Die Vorlagenparameter für die Benachrichtigung. Erforderlich. Siehe Vorlagenparameter.

Diese JSON-Option kann stattdessen durch das Festlegen einzelner Felder mit anderen Optionen bereitgestellt werden. Es schließt sich gegenseitig mit diesen Optionen aus.

Geben Sie eine JSON-Zeichenfolgeoption an oder geben Sie eine JSON-Datei an, aus der gelesen werden soll, indem Sie eine Dateipfadoption angeben, die mit @ beginnt, z. B. --params=@path/to/file.json.

--description (Zeichenfolge)

Die Beschreibung der Vorlage.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--params-body (Zeichenfolge)

Vorlagenkörper. Diese Option stellt einen Wert für ein Teilfeld der JSON-Option "params" bereit. Es schließt sich gegenseitig mit dieser Option aus.

Die maximale Länge beträgt 20000 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

--params-subject (Zeichenfolge)

Die Vorlage Betreff. Diese Option stellt einen Wert für ein Teilfeld der JSON-Option "params" bereit. Es schließt sich gegenseitig mit dieser Option aus.

Die maximale Länge beträgt 1000 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

Beispiele

  • Das folgende Beispiel zeigt das Format des TemplateConfig Objekts für E-Mails. Die unterstützten Typen sind und smtp_custom.notification smtp_custom.invitation.
ibmcloud event-notifications template-create \
  --instance-id=exampleString \
  --name=exampleString \
  --type=exampleString \
  --params='{"body": "exampleString", "subject": "exampleString"}' \
  --description=exampleString
  • Das folgende Beispiel zeigt das Format des TemplateConfig Objekts für Slack. Der unterstützte Typ ist slack.notification.
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type slack.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString
  • Das folgende Beispiel zeigt das Format des TemplateConfig Objekts für Webhook. Der unterstützte Typ ist webhook.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type webhook.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString
  • Das folgende Beispiel zeigt das Format des TemplateConfig Objekts für Pagerduty. Der unterstützte Typ ist pagerduty.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type pagerduty.notification \
    --params '{"body": "ewogICJwYXlsb2FkIjogewogICAgInN1bW1hcnkiOiAie3sgZGF0YS5hbGVydF9kZWZpbml0aW9uLm5hbWV9fSIsCiAgICAidGltZXN0YW1wIjogInt7dGltZX19IiwKICAgICJzZXZlcml0eSI6ICJpbmZvIiwKICAgICJzb3VyY2UiOiAie3sgc291cmNlIH19IgogIH0sCiAgImRlZHVwX2tleSI6ICJ7eyBpZCB9fSIsCiAge3sjZXF1YWwgZGF0YS5zdGF0dXMgInRyaWdnZXJlZCJ9fQogICJldmVudF9hY3Rpb24iOiAidHJpZ2dlciIKICAge3svZXF1YWx9fQoKICB7eyNlcXVhbCBkYXRhLnN0YXR1cyAicmVzb2x2ZWQifX0KICAiZXZlbnRfYWN0aW9uIjogInJlc29sdmUiCiAge3svZXF1YWx9fQoKICAge3sjZXF1YWwgZGF0YS5zdGF0dXMgImFja25vd2xlZGdlZCJ9fQogICAiZXZlbnRfYWN0aW9uIjogImFja25vd2xlZGdlIgogICB7ey9lcXVhbH19Cn0="}' \
    --description exampleString
  • Das folgende Beispiel zeigt das Format des Objekts TemplateConfig für Event Streams. Der unterstützte Typ ist event_streams.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type event_streams.notification \
    --params '{"body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="}' \
    --description exampleString
  • Das folgende Beispiel zeigt das Format des TemplateConfig Objekts für Code Engine Job. Der unterstützte Typ ist ibmcejob.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmcejob.notification\
    --params '{"body": "ewogInJ1bl9lbnZfdmFyaWFibGVzIjogWwogICB7ICJuYW1lIjogInJlZ2lvbiIsICJ2YWx1ZSI6ICJ7e2RhdGEucmVnaW9ufX0iLCJ0eXBlIjogImxpdGVyYWwifSwKeyJuYW1lIjoiVkFSMSIsInR5cGUiOiJsaXRlcmFsIiwidmFsdWUiOiJ7e2RhdGEudmFyMX19In0sCnsibmFtZSI6IlZBUjIiLCJ0eXBlIjoibGl0ZXJhbCIsInZhbHVlIjoie3tkYXRhLnZhcjJ9fSJ9Cl0KfQ=="}' \
    --description exampleString
  • Das folgende Beispiel zeigt das Format des Objekts TemplateConfig für Code Engine Application/Function. Der unterstützte Typ ist ibmceapp.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmceapp.notification\
    --params '{"body": "ewogICJ2YXIxIjogInt7ZGF0YS52YXIxfX0iLAogICJ2YXIyIjogInt7ZGF0YS52YXIyfX0iCn0="}' \
    --description exampleString
  • Das folgende Beispiel zeigt das Format des Objekts TemplateConfig für App Configuration. Der unterstützte Typ ist app_configuration.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type app_configuration.notification\
    --params '{"body": "eyJlbmFibGVkIjogZmFsc2V9Cg=="}' \
    --description exampleString

ibmcloud event-notifications templates

Listen Sie alle benutzerdefinierten Vorlagen auf, die für eine Event Notifications-Instanz erstellt wurden. Sie müssen die ID der Instanz angeben.

Wenn Sie die Option --all-pages nicht festlegen, ruft der Befehl nur eine Seite der Sammlung ab.

ibmcloud event-notifications templates --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 10 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--limit (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

Der Standardwert ist 10. Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Die Einrückung für paginierte Ergebnisse.

Der Standardwert ist 0. Der Mindestwert ist 0.

--search (Zeichenfolge)

Der Suchbegriff zum Filtern von Ergebnissen.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Vorlagensammlung anzuzeigen.

Beispiel

ibmcloud event-notifications templates \
  --instance-id=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

ibmcloud event-notifications template

Rufen Sie die Details einer Vorlage anhand ihrer ID ab. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die Vorlage konfiguriert ist.

ibmcloud event-notifications template --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für die Vorlage. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

Beispiel

ibmcloud event-notifications template \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications template-update

Aktualisieren Sie die Details einer bestehenden Vorlage, die unter einer Event Notifications-Instanz erstellt wurde.

ibmcloud event-notifications template-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--params PARAMS]

Sie können anstelle template-update von verwenden template-replace. Beide Befehle werden derzeit unterstützt, template-replace werden jedoch in einer zukünftigen Version als veraltet markiert.

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 10 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für die Vorlage. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--name (Zeichenfolge)

Der aktualisierte Name der Vorlage.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--description (Zeichenfolge)

Die aktualisierte Beschreibung der Vorlage.

Die maximale Länge beträgt 255 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--params (TemplateConfig)

Die aktualisierten Vorlagenparameter. Siehe Vorlagenparameter.

Diese JSON-Option kann stattdessen durch das Festlegen einzelner Felder mit anderen Optionen bereitgestellt werden. Es schließt sich gegenseitig mit diesen Optionen aus.

Geben Sie eine JSON-Zeichenfolgeoption an oder geben Sie eine JSON-Datei an, aus der gelesen werden soll, indem Sie eine Dateipfadoption angeben, die mit @ beginnt, z. B. --params=@path/to/file.json.

Beispiele

ibmcloud event-notifications template-replace \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --params='{"body": "exampleString", "subject": "exampleString"}'

ibmcloud event-notifications template-delete

Löschen Sie eine Vorlage anhand ihrer ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die Vorlage konfiguriert ist.

ibmcloud event-notifications template-delete --instance-id INSTANCE-ID --id ID [--force]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 10 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für die Vorlage. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

-f, --force(Boolesch)

Erzwingen Sie die Ausführung des Befehls.

Beispiel

ibmcloud event-notifications template-delete \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications pre-defined-templates

Auflistung vordefinierter Vorlagen für eine Event Notifications-Instanz.

Wenn Sie die Option --all-pages nicht festlegen, ruft der Befehl nur eine Seite der Sammlung ab.

ibmcloud event-notifications pre-defined-templates --instance-id INSTANCE-ID [--source SOURCE] [--type TYPE] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--source (Zeichenfolge)

Der Quellentyp für die vordefinierte Vorlage. Erforderlich.

Die maximale Länge beträgt 50 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

--type (Zeichenfolge)

Der Vorlagentyp für die vordefinierte Vorlage, basierend auf dem Zielort. Erforderlich.

Die maximale Länge beträgt 50 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

--limit (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

Der Standardwert ist 10. Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Die Einrückung für paginierte Ergebnisse.

Der Standardwert ist 0. Der Mindestwert ist 0.

--search (Zeichenfolge)

Der Suchbegriff zum Filtern von Ergebnissen.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Sammlung vordefinierter Vorlagen anzuzeigen.

Beispiel

ibmcloud event-notifications pre-defined-templates \
  --instance-id=exampleString \
  --source=exampleString \
  --type=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

ibmcloud event-notifications pre-defined-template

Rufen Sie die Details einer vordefinierten Vorlage anhand ihrer ID ab. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die vordefinierte Vorlage konfiguriert ist.

ibmcloud event-notifications pre-defined-template --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)
Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.
--id (Zeichenfolge)
Die eindeutige Kennung für die vordefinierte Vorlage. Erforderlich.

Beispiel

ibmcloud event-notifications pre-defined-template \
  --instance-id=exampleString \
  --id=exampleString

SMTP-Konfigurationen

IBM Cloud Event Notifications SMTP-Konfigurationen.

ibmcloud event-notifications smtp-configuration-create

Erstellen Sie eine SMTP-Konfiguration für den E-Mail-Versand. Weitere Informationen finden Sie unter SMTP-Konfigurationen.

ibmcloud event-notifications smtp-configuration-create --instance-id INSTANCE-ID --name NAME --domain DOMAIN [--description DESCRIPTION]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--name (Zeichenfolge)

Der Name der SMTP-Konfiguration. Erforderlich.

Die maximale Länge beträgt 250 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--domain (Zeichenfolge)

Der Domainname für die SMTP-Konfiguration. Erforderlich.

Die maximale Länge beträgt 512 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

--description (Zeichenfolge)

Die Beschreibung der SMTP-Konfiguration.

Die maximale Länge beträgt 250 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-configuration-create \
  --instance-id=exampleString \
  --name=exampleString \
  --domain=exampleString \
  --description=exampleString

ibmcloud event-notifications smtp-configurations

Listen Sie alle SMTP-Konfigurationen für eine Event Notifications-Instanz auf.

Wenn Sie die Option --all-pages nicht festlegen, ruft der Befehl nur eine Seite der Sammlung ab.

ibmcloud event-notifications smtp-configurations --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--limit (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

Der Standardwert ist 10. Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Die Einrückung für paginierte Ergebnisse.

Der Standardwert ist 0. Der Mindestwert ist 0.

--search (Zeichenfolge)

Der Suchbegriff zum Filtern von Ergebnissen.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der SMTP-Konfigurationssammlung anzuzeigen.

Beispiel

ibmcloud event-notifications smtp-configurations \
  --instance-id=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

ibmcloud event-notifications smtp-user-create

Erstellen Sie einen SMTP-Benutzer für eine SMTP-Konfiguration. Sie müssen die ID der SMTP-Konfiguration und die ID der Event Notifications-Instanz angeben.

Die SMTP-Anmeldedaten werden nur einmal angezeigt. Kopieren Sie diese und bewahren Sie sie sicher auf, da sie später nicht mehr abgerufen werden können.

ibmcloud event-notifications smtp-user-create --instance-id INSTANCE-ID --id ID [--description DESCRIPTION] [--username-to-clone USERNAME-TO-CLONE]

Befehlsoptionen

--instance-id (Zeichenfolge)

Die eindeutige Kennung für die Instanz IBM Cloud unter Event Notifications. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Die eindeutige Kennung für die SMTP-Konfiguration. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--description (Zeichenfolge)

Die Beschreibung des SMTP-Benutzers.

Die maximale Länge beträgt 250 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--username-to-clone (Zeichenfolge)

Der Benutzername des zu klonenden SMTP-Benutzers.

Die maximale Länge beträgt 20 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /^[a-z0-9]{18}\\d{2}$/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-user-create \
  --instance-id=exampleString \
  --id=exampleString \
  --description=exampleString \
  --username-to-clone=exampleString

ibmcloud event-notifications smtp-users

Alle SMTP-Benutzer für eine SMTP-Konfiguration auflisten.

Wenn die Option --all-pages nicht gesetzt ist, ruft der Befehl nur eine einzige Seite der Sammlung ab.

ibmcloud event-notifications smtp-users --instance-id INSTANCE-ID --id ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--limit (int64)

Seitenbegrenzung für seitenbezogene Ergebnisse.

Der Standardwert ist 10. Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Offset für seitenbezogene Ergebnisse.

Der Standardwert ist 0. Der Mindestwert ist 0.

--search (Zeichenfolge)

Suchbegriff zum Filtern der Ergebnisse.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--all-pages(Boolesch)

Führen Sie mehrere Anfragen aus, um alle Seiten der Sammlung für SMTP-Benutzer anzuzeigen.

Beispiel

ibmcloud event-notifications smtp-users \
  --instance-id=exampleString \
  --id=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

ibmcloud event-notifications smtp-configuration

Erhalten Sie Details zur SMTP-Konfiguration für eine Event Notifications-Instanz.

ibmcloud event-notifications smtp-configuration --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-configuration \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications smtp-configuration-update

Aktualisieren Sie eine SMTP-Konfiguration anhand ihrer ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die SMTP-Konfiguration eingerichtet ist.

ibmcloud event-notifications smtp-configuration-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--name (Zeichenfolge)

SMTP-Name

Die maximale Länge beträgt 250 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

--description (Zeichenfolge)

SMTP-Beschreibung.

Die maximale Länge beträgt 250 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-configuration-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString

ibmcloud event-notifications smtp-configuration-delete

Löschen Sie eine SMTP-Konfiguration anhand ihrer ID. Sie müssen außerdem die ID der Event Notifications-Instanz angeben, für die die SMTP-Konfiguration eingerichtet ist.

ibmcloud event-notifications smtp-configuration-delete --instance-id INSTANCE-ID --id ID [--force]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-configuration-delete \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications smtp-user

Rufen Sie Details zu einem SMTP-Benutzer anhand der Benutzer-ID und der SMTP-Konfigurations-ID ab.

ibmcloud event-notifications smtp-user --instance-id INSTANCE-ID --id ID --user-id USER-ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--user-id (Zeichenfolge)

UserID. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 5 Zeichen. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-user \
  --instance-id=exampleString \
  --id=exampleString \
  --user-id=exampleString

ibmcloud event-notifications smtp-user-update

Aktualisieren Sie einen SMTP-Benutzer mithilfe der Benutzer-ID und der SMTP-Konfigurations-ID.

ibmcloud event-notifications smtp-user-update --instance-id INSTANCE-ID --id ID --user-id USER-ID [--description DESCRIPTION]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--user-id (Zeichenfolge)

UserID. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 5 Zeichen. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

--description (Zeichenfolge)

SMTP-Benutzerbeschreibung.

Die maximale Länge beträgt 250 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-user-update \
  --instance-id=exampleString \
  --id=exampleString \
  --user-id=exampleString \
  --description=exampleString

ibmcloud event-notifications smtp-user-delete

Löschen Sie einen SMTP-Benutzer mithilfe der Benutzer-ID und der SMTP-Konfigurations-ID.

ibmcloud event-notifications smtp-user-delete --instance-id INSTANCE-ID --id ID --user-id USER-ID [--force]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--user-id (Zeichenfolge)

UserID. Erforderlich.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 5 Zeichen. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-user-delete \
  --instance-id=exampleString \
  --id=exampleString \
  --user-id=exampleString

ibmcloud event-notifications smtp-allowed-ips

Alle zulässigen IP-Adressen für eine SMTP-Konfiguration abrufen.

ibmcloud event-notifications smtp-allowed-ips --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

Beispiel

ibmcloud event-notifications smtp-allowed-ips \
  --instance-id=exampleString \
  --id=exampleString

ibmcloud event-notifications smtp-allowed-ips-update

Die Unterstützung für die alte Whitelist-Funktion wurde eingestellt. Die Whitelist-Funktion ist nun über kontextbasierte Einschränkungen aktiviert. Weitere Informationen finden Sie unter SMTP-Konfigurationen.

ibmcloud event-notifications verify-smtp-update

Überprüfen Sie die SMTP-Konfiguration der Domain für SPF, SKIM und en_authorization.

ibmcloud event-notifications verify-smtp-update --instance-id INSTANCE-ID --id ID --type TYPE

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--id (Zeichenfolge)

Eindeutige Kennung für SMTP. Erforderlich.

Die maximale Länge beträgt 32 Zeichen. Die Mindestlänge beträgt 32 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--type (Zeichenfolge)

SMTP-Verifizierungstyp. Zulässige Werte sind spf, dkim, und en_authorization. Erforderlich.

Die maximale Länge beträgt 20 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /.*/ entsprechen.

Beispiel

ibmcloud event-notifications verify-smtp-update \
  --instance-id=exampleString \
  --id=exampleString \
  --type=exampleString

Metriken

ibmcloud event-notifications metrics

Metriken für eine Event Notifications-Instanz abrufen.

ibmcloud event-notifications metrics --instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE] [--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--gte (Zeichenfolge)

GTE (größer gleich), Startzeitstempel in UTC. Erforderlich.

Die maximale Länge beträgt 28 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/ entsprechen.

--lte (Zeichenfolge)

LTE (kleiner gleich), Endzeitstempel in UTC. Erforderlich.

Die maximale Länge beträgt 28 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/ entsprechen.

--smtp-config-id (Zeichenfolge)

SMTP-Konfigurations-ID. Erforderlich bei der Abfrage von Metriken für SMTP-Schnittstellen-Ziele.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--destination-type (Zeichenfolge)

Art des Ziels, für das Kennzahlen angefordert werden. Unterstützter Wert: smtp_custom. Erforderlich bei der Abfrage von Metriken für benutzerdefinierte E-Mail-Empfänger.

Zulässige Werte: smtp_custom.

--destination-id (Zeichenfolge)

Eindeutige ID für das Ziel.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--subscription-id (Zeichenfolge)

Eindeutige ID für das Abonnement.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--source-id (Zeichenfolge)

Eindeutige ID für Quelle.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

--email-to (Zeichenfolge)

E-Mail-ID des Empfängers

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/ entsprechen.

--notification-id (Zeichenfolge)

Benachrichtigungs-ID

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--subject (Zeichenfolge)

E-Mail-Betreff angezeigt werden soll.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

Beispiel

ibmcloud event-notifications metrics \
  --instance-id=exampleString \
  --destination-type=smtp_custom \
  --gte=exampleString \
  --lte=exampleString \
  --destination-id=exampleString \
  --subscription-id=exampleString \
  --source-id=exampleString \
  --email-to=exampleString \
  --notification-id=exampleString \
  --subject=exampleString

ibmcloud event-notifications bounce-metrics

Rufen Sie die Bounce-Kennzahlen für eine Event Notifications-Instanz ab.

ibmcloud event-notifications bounce-metrics --instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE] [--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT] [--limit LIMIT] [--offset OFFSET]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--gte (Zeichenfolge)

Startzeitstempel größer oder gleich (GTE) in UTC. Erforderlich.

Die maximale Länge beträgt 28 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/ entsprechen.

--lte (Zeichenfolge)

Startzeitstempel Less than equal (LTE) in UTC. Erforderlich.

Die maximale Länge beträgt 28 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/ entsprechen.

--smtp-config-id (Zeichenfolge)

SMTP-Konfigurations-ID. Erforderlich bei der Abfrage von Metriken für SMTP-Schnittstellen-Ziele.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--destination-type (Zeichenfolge)

Art des Ziels, für das Kennzahlen angefordert werden. Unterstützter Wert: smtp_custom. Erforderlich bei der Abfrage von Metriken für benutzerdefinierte E-Mail-Empfänger.

Zulässige Werte: smtp_custom.

--destination-id (Zeichenfolge)

Eindeutige ID für das Ziel.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--subscription-id (Zeichenfolge)

Eindeutige ID für das Abonnement.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--source-id (Zeichenfolge)

Eindeutige ID für Quelle.

Die maximale Länge beträgt 100 Zeichen. Die Mindestlänge beträgt Zeichen 1. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9-:_]*/ entsprechen.

--email-to (Zeichenfolge)

E-Mail-Adresse des Empfängers.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/ entsprechen.

--notification-id (Zeichenfolge)

Benachrichtigungs-ID.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--subject (Zeichenfolge)

E-Mail-Betreff angezeigt werden soll.

Die maximale Länge beträgt 256 Zeichen. Die Mindestlänge beträgt 0 Zeichen. Der Wert muss dem regulären Ausdruck /[a-zA-Z0-9]/ entsprechen.

--limit (int64)

Seitenbegrenzung für seitenbezogene Ergebnisse.

Der Standardwert ist 10. Der Maximalwert beträgt 100. Der Mindestwert ist 1.

--offset (int64)

Offset für seitenbezogene Ergebnisse.

Der Standardwert ist 0. Der Mindestwert ist 0.

Beispiel

ibmcloud event-notifications bounce-metrics \
  --instance-id=exampleString \
  --destination-type=smtp_custom \
  --gte=exampleString \
  --lte=exampleString \
  --destination-id=exampleString \
  --subscription-id=exampleString \
  --source-id=exampleString \
  --email-to=exampleString \
  --notification-id=exampleString \
  --subject=exampleString \
  --limit=10 \
  --offset=0

Benachrichtigungsstatus abrufen

ibmcloud event-notifications notifications-status

Rufen Sie den Benachrichtigungsstatus für eine Testbenachrichtigung eines Webhook-Ziels ab.

ibmcloud event-notifications notifications-status --instance-id INSTANCE-ID --id ID

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

--id (Zeichenfolge)

Die Benachrichtigungs-ID, die beim Testen eines Webhook-Ziels zurückgegeben wird. Diese ID gilt speziell für Testbenachrichtigungen, die an Webhook-Ziele gesendet werden. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ entsprechen.

Beispiel

ibmcloud event-notifications notifications-status \
  --instance-id=exampleString \
  --id=exampleString

Benachrichtigungen senden

Senden Sie Ereignisse aus Ihren Backend-Anwendungen mithilfe von API-Quellen. Event Notifications unterstützt zwei CloudEvents-Inhaltsmodi:

  • Binärmodus – Die Ereignisdaten werden unverändert in den Request-Body von HTTP eingefügt, wobei das Attribut datacontenttype Media-Type im Header Content-Type den Medientyp angibt. Alle anderen Attribute werden den HTTP-Headern zugeordnet, denen ein ce-. vorangestellt ist. Anfragen werden im Binärmodus behandelt, wenn die obligatorischen Attribute CloudEvents (specversion, id, type, und source) als Header übermittelt werden.
  • Strukturierter Modus – Ereignismetadaten und Ereignisdaten werden in den Request-Body von HTTP eingefügt. Setzen Sie die Kopfzeile Content-Type auf application/cloudevents+json. Die obligatorischen Attribute (specversion, id, type, und source) müssen im Request-Body enthalten sein. Das Feld datacontenttype ist ein Pflichtfeld und muss auf gesetzt werden application/json.

ibmcloud event-notifications send-notifications

Senden Sie eine Benachrichtigung von einer Instanz des Dienstes aus. Weitere Informationen zur Benachrichtigungs-Nutzlast finden Sie in der Dokumentation.

ibmcloud event-notifications send-notifications --instance-id INSTANCE-ID [--body BODY]

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. Erforderlich.

Die maximale Länge beträgt 36 Zeichen. Die Mindestlänge beträgt 36 Zeichen. Der Wert muss dem regulären Ausdruck /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ entsprechen.

--body (NotificationCreate)

Nutzlast, die eine Benachrichtigung über eine Erstellungsanfrage beschreibt.

Geben Sie eine JSON-Zeichenfolgeoption an oder geben Sie eine JSON-Datei an, aus der gelesen werden soll, indem Sie eine Dateipfadoption angeben, die mit @ beginnt, z. B. --body=@path/to/file.json.

NotificationCreate

Das folgende Beispiel zeigt das Format des Objekts NotificationCreate.

{
  "specversion" : "1.0",
  "time" : "2019-01-01T12:00:00.000Z",
  "id" : "exampleString",
  "source" : "exampleString",
  "type" : "exampleString",
  "ibmenseverity" : "exampleString",
  "ibmensourceid" : "exampleString",
  "ibmendefaultshort" : "exampleString",
  "ibmendefaultlong" : "exampleString",
  "ibmensubject" : "exampleString",
  "ibmentemplates" : "[\"886f8f4c-8605-47hb-85a1-8682b9377468483\"]",
  "ibmenmailto" : "exampleString",
  "ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]",
  "ibmensmsto" : "exampleString",
  "ibmenmms": {"content": "VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO","content_type": "image/png"},
  "ibmenmarkdownn": "This is a *italic* message.\n- Item 1\n- Item 2\n**bold text** with more text data\n~~strike through~~\n1. order 1\n2. order 2\n```fenced code block```\n> block code\n`code`\n[Click here](https://example.com) for more info."
    "ibmenhtmlbody" : "exampleString",
    "subject" : "exampleString",
   "attachments": [
    {
      "content": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQK",
      "filename": "test.txt",
      "content_type": "text/plain",
      "disposition": "attachment"
    }
    ],
    "data" : {
    "anyKey" : "anyValue"
    },
    "datacontenttype" : "application/json",
    "ibmenpushto" : "{
    \"fcm_devices\" : [ \"exampleString\" ],
    \"apns_devices\" : [ \"exampleString\" ],
    \"huawei_devices\" : [ \"exampleString\" ],
    \"safari_devices\" : [ \"exampleString\" ],
    \"chrome_devices\" : [ \"exampleString\" ],
    \"firefox_devices\" : [ \"exampleString\" ],
    \"user_ids\" : [ \"exampleString\" ],
    \"tags\" : [ \"exampleString\" ],
    \"platforms\" : [ \"push_android\" ]
    }",
    "ibmenfcmbody" : "{ }",
    "ibmenapnsbody" : "{ }",
    "ibmenapnsheaders" : "{ }",
    "ibmenchromebody" : "{ }",
    "ibmenchromeheaders" : "{ }",
    "ibmenfirefoxbody" : "{ }",
    "ibmenfirefoxheaders" : "{ }",
    "ibmenhuaweibody" : "{ }",
    "ibmensafaribody" : "{ }"
}

Beispiel

Mit den erforderlichen Parametern:

ibmcloud event-notifications send-notifications \
    --instance-id=exampleString \
    --body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "type": "*", "id": "exampleString", "source": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "short message", "ibmendefaultlong": "long message", "data": {"name": "exampleString"}, "datacontenttype": "application/json"}'

Mit allen Parametern:

ibmcloud event-notifications send-notifications \
    --instance-id=exampleString \
    --body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "id": "exampleString", "source": "exampleString", "type": "exampleString", "ibmenseverity": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "exampleString", "ibmendefaultlong": "exampleString", "ibmensubject": "exampleString", "ibmentemplates": [\"template-id\"], "ibmenmailto": "exampleString","ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]", "ibmensmsto": "exampleString","ibmenmms": "{\"content\": \"VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO\",\"content_type\": \"image/png\"}", "ibmenhtmlbody": "exampleString", "subject": "exampleString", "data": {"anyKey": "anyValue"}, "datacontenttype": "application/json", "ibmenpushto": "{\"fcm_devices\": [\"exampleString\"], \"apns_devices\": [\"exampleString\"], \"huawei_devices\": [\"exampleString\"], \"safari_devices\": [\"exampleString\"], \"chrome_devices\": [\"exampleString\"], \"firefox_devices\": [\"exampleString\"], \"user_ids\": [\"exampleString\"], \"tags\": [\"exampleString\"], \"platforms\": [\"push_android\"]}", "ibmenfcmbody": "{}", "ibmenapnsbody": "{}", "ibmenapnsheaders": "{}", "ibmenchromebody": "{}", "ibmenchromeheaders": "{}", "ibmenfirefoxbody": "{}", "ibmenfirefoxheaders": "{}", "ibmenhuaweibody": "{}", "ibmensafaribody": "{}"}'

Weitere Eigenschaften, die für die iOS-Benachrichtigung konfiguriert werden können

einstellungen iOS
Eigenschaft Merkmaltyp Beschreibung
badge ganze Zahl Die Nummer, die als Markierung des Anwendungssymbols angezeigt werden soll.
interactive_category Zeichenfolge Die Kategorie-ID, die für interaktive Push-Benachrichtigungen verwendet werden soll.
ios_action_key Zeichenfolge Der Titel für den Aktionsschlüssel.
payload JSON-Objekt Angepasste JSON-Nutzdaten, die als Bestandteil der Benachrichtigung gesendet werden.
sound Zeichenfolge Der Name der Audiodatei im Anwendungsbundle. Die Tonsignale dieser Datei werden als Alert abgespielt.
title_loc_key Zeichenfolge Der Schlüssel einer Titelzeichenfolge in der Datei 'Localizable.strings' für die aktuelle Lokalisierung. Die Schlüsselzeichenfolge kann mit den Kennungen %@ und %n$@ formatiert werden, um die im Array titleLocArgs angegebenen Variablen zu verwenden.
loc_key Zeichenfolge Ein Schlüssel zu einer Zeichenfolge einer Alertnachricht in der Datei Localizabl.strings für die aktuelle Lokalisierung (die durch die Sprachvorgabe des Benutzers festgelegt wird). Die Schlüsselzeichenfolge kann mit den Kennungen %@ und %n$@ formatiert werden, um die im Array LocArgs angegebenen Variablen zu verwenden.
launch_image Zeichenfolge Der Dateiname einer Bilddatei im App-Bundle, mit oder ohne Dateiendung. Das Image wird als Startimage verwendet, wenn der Benutzer die Aktionsschaltfläche antippt oder den Aktionsschieberegler bewegt.
title_loc_args Zeichenfolge Variable Zeichenfolgewerte, die anstelle der Formatkennungen in 'title-loc-key' angezeigt werden sollen.
loc_args Zeichenfolge Variable Zeichenfolgewerte, die anstelle der Formatkennungen in 'locKey' angezeigt werden sollen.
title Zeichenfolge Der Titel von Rich Push-Benachrichtigungen (nur unterstützt ab iOS 10).
subtitle Zeichenfolge Der Untertitel der Rich-Benachrichtigungen (nur unterstützt ab iOS 10).
body Zeichenfolge Der Hauptteil für iOS-Benachrichtigungen.
attachment_url Zeichenfolge Der Link zu den iOS-Benachrichtigungsmedien (Video, Audio, GIF, Bilder - unterstützt nur ab iOS 10).
type Zeichenfolge Zulässige Werte: DEFAULT, MIXED, SILENT.
apns_collapse_id Zeichenfolge Mehrere Benachrichtigungen mit derselben Ausblend-ID werden den Benutzern als eine einzige Benachrichtigung angezeigt.
apns_thread_id Zeichenfolge Eine App-spezifische ID für die Gruppierung zusammengehöriger Benachrichtigungen. Dieser Wert entspricht der Eigenschaft 'threadIdentifier' im Objekt 'UNNotificationContent'.
apns_group_summary_arg Zeichenfolge Die Zeichenfolge, die durch die Benachrichtigung an die Formatierungszeichenfolge der Kategoriezusammenfassung hinzugefügt wird.
apns_group_summary_arg_count ganze Zahl Die Anzahl der Elemente, die durch die Benachrichtigung an die Formatierungszeichenfolge der Kategoriezusammenfassung hinzugefügt wird.

Weitere Eigenschaften, die für die FCM-Benachrichtigung konfiguriert werden können

Android-Plattform-Einstellungen
Eigenschaft Merkmaltyp Beschreibung
icon Zeichenfolge Gibt den Namen des Symbols an, das für die Benachrichtigung angezeigt werden soll. Stellen Sie sicher, dass das Symbol bereits in der Clientanwendung enthalten ist.
delay_while_idle Boolescher Wert Wird dieser Parameter auf 'true' gesetzt, gibt er an, dass die Nachricht erst gesendet werden soll, wenn das Gerät aktiv wird.
sync Boolescher Wert Durch Nachrichtenübermittlung in der Gerätegruppe kann jede App-Instanz in einer Gruppe den aktuellen Nachrichtenstatus widerspiegeln.
visibility Zeichenfolge privat oder öffentlich – Sichtbarkeit dieser Benachrichtigung, die Einfluss darauf hat, wie und wann die Benachrichtigungen auf einem gesicherten, gesperrten Bildschirm angezeigt werden.
redact Zeichenfolge Der angegebene Inhalt wird auf einem sicheren gesperrten Bildschirm auf dem Gerät angezeigt, wenn für "visibility" der Wert "private" angegeben ist.
payload JSON-Objekt Angepasste JSON-Nutzdaten, die als Bestandteil der Benachrichtigung gesendet werden.
priority Zeichenfolge Ein Zeichenfolgewert, der die Priorität dieser Benachrichtigung angibt. Zulässige Werte sind 'max', 'high', 'default', 'low' und 'min'. Die Benachrichtigungen zur Priorität 'High/Max' zusammen mit dem Feld 'sound' können für Hinweisbenachrichtigungen in Android 5.0 oder higher.sampleval='low' verwendet werden.
sound Zeichenfolge Die Audiodatei (auf einem Gerät), die versucht wird abgespielt zu werden, wenn die Benachrichtigung vom Gerät empfangen wird.
time_to_live ganze Zahl Gibt an, wie lange (in Sekunden) die Nachricht im GCM-Speicher aufbewahrt werden soll, wenn das Gerät offline ist.
lights Legt die Farbe der Benachrichtigungs-LED beim Empfang von Push-Benachrichtigungen fest.
ledArgb Zeichenfolge Die Farbe der LED. Die Hardware versucht eine Annäherung an die optimale Einstellung.
ledOnMs ganze Zahl Die Zeit in Millisekunden, die die LED leuchtet, während sie blinkt. Die Hardware versucht eine Annäherung an die optimale Einstellung.
ledOffMs Zeichenfolge Die Zeit in Millisekunden, die die LED aus ist, während sie blinkt. Die Hardware versucht eine Annäherung an die optimale Einstellung.
android_title Zeichenfolge Der Titel der Rich Push-Benachrichtigungen.
group_id Zeichenfolge Legen Sie diese Benachrichtigung so fest, dass sie Teil einer Gruppe von Benachrichtigungen ist, die denselben Schlüssel gemeinsam nutzen. Gruppierte Benachrichtigungen werden möglicherweise in einem Cluster oder in einem Stack auf Geräten angezeigt, die eine solche Wiedergabe unterstützen.
style Optionen zur Angabe von erweiterbaren Android-Benachrichtigungen. Die Typen der erweiterbaren Benachrichtigungen sind 'picture_notification', 'bigtext_notification', 'inbox_notification'.
type Zeichenfolge Gibt den Typ der erweiterbaren Benachrichtigungen an. Mögliche Werte: bigtext_notification, picture_notification, inbox_notification.
title Zeichenfolge Gibt den Titel der Benachrichtigung an. Der Titel wird angezeigt, wenn die Benachrichtigung erweitert wird. Der Titel muss für alle drei erweiterbaren Benachrichtigungen angegeben werden.
type Zeichenfolge Zulässige Werte: DEFAULT, SILENT.
alert Zeichenfolge Der Alertwert der Benachrichtigung.

Beispieldokumente

Sie können die folgenden Skripte zur Unterstützung bei der Entwicklung verwenden.

Beispielskript für die Bereitstellung von Event Notifications über CLI

Das provision_event_notification.sh Skript automatisiert die Bereitstellung und Konfiguration einer Instanz von Event Notifications.

Beispielskript für die Integration von Plattformbenachrichtigungen mit CLI

Das en-platform-notification-src-and-email-dest.sh Skript integriert Platform Notifications mit Event Notifications und leitet Benachrichtigungen an IBM Inbuilt Email oder Custom Domain Sandbox weiter.

Beispielskript für die IBM Cloud Logs Integration mit CLI

Das en-icl-src-and-email-dest.sh Skript integriert IBM Cloud Logs mit Event Notifications und leitet Benachrichtigungen an IBM Inbuilt Email oder Custom Domain Sandbox weiter.

Dieses Skript geht davon aus, dass die Instanz IBM Cloud Logs und die Instanz Event Notifications demselben Konto angehören.