{{ {{site.data.keyword.en_short}}.keyword.en_short}} CLI

Die Befehlszeilenschnittstelle (CLI) von „ IBM Cloud “ bietet zusätzliche Funktionen für Serviceangebote. Die CLI von „ IBM Cloud “ unterstützt ein Plug-in-Framework zur Erweiterung ihrer Funktionen. Sie können das Plug-in der Event Notifications-Befehlszeilenschnittstelle über das IBM Cloud-Plug-in-Repository installieren. Mit dem CLI-Plug-in für den Event Notifications-Dienst können Sie Instanzen des Event Notifications-Dienstes mithilfe der verfügbaren CLI-Befehle ganz einfach verwalten.

Voraussetzungen

Wenn Sie sich bei der IBM Cloud-CLI anmelden, werden Sie benachrichtigt, sobald Updates verfügbar sind. Stellen Sie sicher, dass sich die Befehlszeilenschnittstelle stets auf dem neuesten Stand befindet, damit Sie die Befehle und Flags nutzen können, die für das Plug-in der Befehlszeilenschnittstelle von Event Notifications verfügbar sind.

IBM Cloud Kurzreferenzkarte.

Hinweis: Die Versionen des CLI-Plugins vor 1.15.2 sind veraltet.

Event Notifications-CLI installieren

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

ibmcloud plugin install en

Event Notifications }} CLI-Befehle

Hinweis: Der Befehl CLI Plugin init wird in Zukunft veraltet sein

ibmcloud de de-Liste

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

ibmcloud en en-list

ibmcloud event-notifications-Umgebungsvariablensatz

Legen Sie die Region fest, in der Sie arbeiten möchten, indem Sie die Zielregion für IBM Cloud festlegen (ibmcloud target -r ) oder den regionalen Endpunkt über die Variable IBMCLOUD_EN_ENDPOINT exportieren. Verwenden Sie beispielsweise für Sydney Folgendes:

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

  • Exportieren Sie die Variable IBMCLOUD_EN_ENDPOINT, um den öffentlichen Endpunkt der Region Event Notifications festzulegen.

    • 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
  • Exportieren Sie die Variable IBMCLOUD_EN_ENDPOINT, um den privaten Endpunkt der Region Event Notifications festzulegen.

    • 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
  • Exportieren Sie die Variable **EVENT_NOTIFICATIONS_API_KEY,** um die Instanz von Event Notifications zu konfigurieren apikey.

EVENT_NOTIFICATIONS_API_KEY kann Ihr API-Schlüssel für IBM Cloud oder der API-Schlüssel für die Anmeldeinformationen Ihres Dienstes aus Ihrer Event Notifications-Instanz sein.

Quellen

Quelle: IBM Cloud Event Notifications

ibmcloud event-notifications source create

  • Aktion: Erstellen Sie Source.

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

ibmcloud event-notifications sources-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS]
  • Parameter, die angegeben werden müssen:
--instance-id 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 (int64)

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

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 DESCRIPTION (Zeichenfolge)

Die Beschreibung für die Quelle. Optional.

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 ENABLED(Boolesch)

Das boolesche Flag zum Aktivieren oder Deaktivieren der Quelle. Optional.

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

--store-notifications (bool)

Aktivieren Sie diese Option, um die Nutzdaten eingehender Ereignisse zur Fehlerbehebung anzuzeigen.

Der Standardwert ist false.

ibmcloud event-notifications source update

  • Maßnahme: Aktualisieren Sie Source.
ibmcloud event-notifications source-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS]
  • Parameter, die angegeben werden müssen:
--instance-id (Zeichenfolge)

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 (int64)

API-Quellenname.

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 (int64)

API-Quelle Beschreibung

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)

Suchbegriff zum Filtern der Ergebnisse.

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

--store-notifications (bool)

aktivieren, um die Nutzdaten eingehender Ereignisse zur Fehlersuche anzuzeigen.

Der Standardwert ist false.

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

ibmcloud event-notifications source list

  • Maßnahme: Alle auflisten Source.
ibmcloud event-notifications sources [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--limit LIMIT (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

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

--offset OFFSET (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

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

--instance-id INSTANCE-ID (Zeichenfolge)

Der eindeutige Bezeichner 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]

Aktivieren, um das Löschen der Ressource zu erzwingen (um die Bestätigungsaufforderung zu umgehen).

ibmcloud event-notifications source get

  • Maßnahme: Gehen Sie ins Detail Source.
ibmcloud event-notifications source --id ID --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--id 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.

--offset OFFSET

Die Einrückung für paginierte Ergebnisse.

--search SEARCH

Der Suchbegriff zum Filtern von Ergebnissen.

--instance-id 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]

Aktivieren, um das Löschen der Ressource zu erzwingen (um die Bestätigungsaufforderung zu umgehen).

ibmcloud event-notifications source delete

  • Aktion: Bestimmte Source löschen.
ibmcloud event-notifications source-delete  --instance-id INSTANCE-ID --id ID
  • Parameter, die angegeben werden müssen:
--id 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 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]

Aktivieren, um das Löschen der Ressource zu erzwingen (um die Bestätigungsaufforderung zu umgehen).

Ziele

Betreiben Sie die Website IBM Cloud Event Notifications.

ibmcloud event-notifications destination create

  • Aktion: Ein Ziel erstellen.
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]
  • Parameter, die angegeben werden müssen:
--instance-id (Zeichenfolge)

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

--name 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 TYPE (Zeichenfolge)

Der Typ des Ziels. Die verfügbaren Optionen sind webhook, push_android, push_ios, push_chrome, push_firefox, push_huawei, push_safari, ibmce, ibmcos, msteams, pagerduty, servicenow, slack, smtp_custom, sms_custom, event_streams. Erforderlich.

Zulässige Werte sind: webhook, push_android, push_ios,push_chrome,push_firefox,push_huawei,push_safari,ibmce, ibmcos,msteams,pagerduty,servicenow,slack,smtp_custom,sms_custom, event_streams. Die Mindestlänge beträgt Zeichen 1.

--collect-failed-events (bool)

Ob das fehlgeschlagene Ereignis im Cloud Object Storage gesammelt werden soll.

Der Standardwert ist false.

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

--certificate CERTIFICATE (Zeichenfolge)

Der Pfad der Zertifikatsdatei, die angegeben werden muss. Der zulässige Dateityp ist p8 und p12 Zertifikat. Geben Sie den Speicherort der Datei an, um das Zertifikat zu übergeben.

--certificate-content-type CERTIFICATE-CONTENT-TYPE (Zeichenfolge)

Der Typ des Zertifikatsinhalts, der bei einem IOS-Ziel festgelegt werden soll. Der Standardwert ist "". Die verfügbaren Optionen sind: p8 oder p12.

--config CONFIG (DestinationConfig Beispiele )

Die Konfiguration, die erforderlich ist, um die zielspezifischen Parameter festzulegen.

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

--icon16x16 (io.ReadCloser)
Safari-Symbol 16x16.

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

--icon16x16-content-type (Zeichenfolge)

Der Inhaltstyp von Icon16x16.

--icon16x162x (io.ReadCloser)

Safari-Symbol 16x16@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon16x162x-content-type (Zeichenfolge)

Der Inhaltstyp von Icon16x162x.

--icon32x32 (io.ReadCloser)

Safari-Symbol 32x32.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon32x32-content-type (Zeichenfolge)

Der Inhaltstyp von Icon32x32.

--icon32x322x (io.ReadCloser)

Safari-Symbol 32x32@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon32x322x-content-type (Zeichenfolge)

Der Inhaltstyp von Icon32x322x.

--icon128x128 (io.ReadCloser)

Safari-Symbol 128x128.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon128x128-content-type (Zeichenfolge)

Der Inhaltstyp von Icon128x128.

--icon128x1282x (io.ReadCloser)

Safari-Symbol 128x128@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon128x1282x-content-type (Zeichenfolge)

Der Inhaltstyp von Icon128x1282x.

{
   "params" : {
      "url" : "exampleString",
      "verb" : "get",
      "custom_headers" : { },
      "sensitive_headers" : [ "exampleString" ]
   }
}

Hinweis: Cloud Functions Event Notifications sind veraltet und werden in der Kategorie der Ziele nicht mehr unterstützt.

Beispiele

  • 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* ".

```json
   {
      "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 Objekts `DestinationConfig` 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* ".

```json
   {
      "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* ".

```json
   {
      "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".

```json
   {
      "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.

```json
   {
      "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* ".

```json
   {
      "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).

```json
   {
      "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.
   {: attention}

   ```json
   {
      "params" : {
         "routing_key" : "routingkeytoconnecttoPD",
         "api_key" : "cffunctionnamespaceserviceidapikey"
      }
   }
   ```


- Das folgende Beispiel zeigt das Format des `DestinationConfig` Objekts für Webhook (webhook).

```json
   {
      "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).

```json
   {
      "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.

```json
   {
      "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

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

   code Motor Zielart: Job

   ```json
   {
      "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).

```json
   {
      "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).

```json
   {
      "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.

   Prozess zur Konfiguration und Überprüfung benutzerdefinierter Domains: <https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify>

   ```json
   {
      "params" : {
         "domain": "mailx.com"
      }
   }
   ```

- Das folgende Beispiel zeigt das Format des `DestinationConfig` Objekts für das Ziel Event Streams (event_streams).

```json
   {
      "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).

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

Hinweis: Ein benutzerdefiniertes SMS-Ziel kann auch ohne „ `DestinationConfig` “ angelegt werden, funktioniert jedoch erst, wenn die erforderlichen personalisierten Nummern ausdrücklich angefordert und konfiguriert wurden. Informationen zur Beantragung personalisierter Nummern finden Sie unter „ [Personalisierte SMS-Nummern](/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom#en-destinations-sms-custom-numbers) “.

### ibmcloud event-notifications destination list {: #en-cli-destination-list-command}

- **Maßnahme:** Alle auflisten `Destination`.

```sh {: pre}
ibmcloud event-notifications destinations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--limit LIMIT (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

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

--offset OFFSET (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

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

--instance-id (Zeichenfolge)

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

ibmcloud event-notifications destination get

  • Maßnahme: Gehen Sie ins Detail Destination.
ibmcloud event-notifications destination --id ID --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--id 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.

--instance-id 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.

ibmcloud event-notifications destination update

  • Maßnahme: Vorhandene Dokumente aktualisieren Destination.
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]
  • Parameter, die angegeben werden müssen:
--instance-id (Zeichenfolge)
Eindeutige ID für IBM Cloud Event Notifications-Instanz. 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)

Eindeutige ID 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)

Zielname

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)

Zielbeschreibung.

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 (bool)

Ob das fehlgeschlagene Ereignis im Cloud Object Storage gesammelt werden soll.

Der Standardwert ist false.

--config (DestinationConfig)

Nutzdaten, die eine Zielkonfiguration beschreiben.

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 (io.ReadCloser)

Zertifikat für APNS.

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

--certificate-content-type (Zeichenfolge)

Der Inhaltstyp des Zertifikats.

--icon16x16 (io.ReadCloser)

Safari-Symbol 16x16.

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

--icon16x16-content-type (Zeichenfolge)

Der Inhaltstyp von Icon16x16.

--icon16x162x (io.ReadCloser)

Safari-Symbol 16x16@2x.

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

--icon16x162x-content-type (Zeichenfolge)

Der Inhaltstyp von Icon16x162x.

--icon32x32 (io.ReadCloser)

Safari-Symbol 32x32.

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

--icon32x32-content-type (Zeichenfolge)

Der Inhaltstyp von Icon32x32.

--icon32x322x (io.ReadCloser)

Safari-Symbol 32x32@2x.

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

--icon32x322x-content-type (Zeichenfolge)

Der Inhaltstyp von Icon32x322x.

--icon128x128 (io.ReadCloser)

Safari-Symbol 128x128.

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

--icon128x128-content-type (Zeichenfolge)

Der Inhaltstyp von Icon128x128.

--icon128x1282x (io.ReadCloser)

Safari-Symbol 128x128@2x.

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

--icon128x1282x-content-type (Zeichenfolge)

Der Inhaltstyp von Icon128x1282x.

ibmcloud event-notifications destination delete

  • Maßnahme: Vorhandene löschen Destination.
ibmcloud event-notifications destination-delete --id ID --instance-id INSTANCE-ID [--force]
  • Parameter, die angegeben werden müssen:
--id 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.

--instance-id 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](Boolesch)

Aktivieren, um das Löschen der Ressource zu erzwingen (um die Bestätigungsaufforderung zu umgehen).

ibmcloud event-notifications enabled-countries

Erhalten Sie aktivierte Länderdetails des SMS-Ziels.

ibmcloud event-notifications enabled-countries --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 `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)

Eindeutige ID 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 enabled-countries \
    --instance-id=exampleString \
    --id=exampleString

ibmcloud event-notifications test-destination

Testen Sie ein Reiseziel.

ibmcloud event-notifications test-destination --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 `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)

Eindeutige ID 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 email-sandbox-destination-update

Aktualisieren Sie das Sandbox-Ziel auf Produktion mit benutzerdefinierter Domäne.

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

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. 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)

Eindeutige ID 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 /^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$/ entsprechen.

--domain (Zeichenfolge)

E-Mail-Domäne. 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 email-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 der benutzerdefinierten Domain.

ibmcloud event-notifications verify-destination-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 `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)

Eindeutige ID 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)

Art der Überprüfung. 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

  • Maßnahme: Neues erstellen Topic.
ibmcloud event-notifications topic-create --name NAME [--description DESCRIPTION] [--sources SOURCES] --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--name NAME (Zeichenfolge)

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.

--instance-id INSTANCE-ID (Zeichenfolge)

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.

[--sources SOURCES] (TopicCreateSourcesItem[])

Liste der Quellen mit ihren Filterkonfigurationen, die diesem Thema zugeordnet werden sollen. Dies ist nicht nur eine Liste von Quellen-IDs – jeder Eintrag enthält die Quellen-ID sowie Filterregeln, die festlegen, welche Ereignisse aus dieser Quelle an dieses Thema weitergeleitet werden. Die vollständige Struktur entnehmen Sie bitte den Beispielen.

Beispiel

  • 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[]`.

```json
   [
      {
         "id" : "exampleString",
         "rules" : [
            {
               "enabled" : true,
               "event_type_filter" : "$.*",
               "notification_filter" : "exampleString"
            }
         ]
      }
   ]
   ```

- Das folgende Beispiel zeigt das Format des Objekts `TopicUpdateSourcesItem[]`.

```json
   [
      {
         "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 topic list {: #en-cli-topic-list-command}

- **Maßnahme:** Alle auflisten `Topic`.

```sh {: pre}
ibmcloud event-notifications topics [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--limit LIMIT (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

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

--offset OFFSET (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

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

--instance-id 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.

ibmcloud event-notifications topic get

  • Maßnahme: Gehen Sie ins Detail Topic.
ibmcloud event-notifications topic --id ID [--include INCLUDE] --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--id ID (Zeichenfolge)

Eindeutige ID für 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 INCLUDE (Zeichenfolge)

Unterthemen einschließen.

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.

--instance-id 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.

ibmcloud event-notifications topic update

  • Maßnahme: Vorhandene Dokumente aktualisieren Topic.
ibmcloud event-notifications topic-replace --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES] --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--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.

--id (Zeichenfolge)

Eindeutige ID für 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)

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)

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[])

Liste der neuen Quellen mit ihren Filterkonfigurationen, die diesem Thema hinzugefügt werden sollen. Dies ist nicht nur eine Liste von Quellen-IDs – jeder Eintrag enthält die Quellen-ID sowie Filterregeln, die festlegen, welche Ereignisse aus dieser Quelle an dieses Thema weitergeleitet werden. Die vollständige Struktur entnehmen Sie bitte den Beispielen.

Dieses Flag fügt ausschließlich neue Quellen hinzu. Bereits mit dem Thema verknüpfte Quellen können nicht ersetzt oder aktualisiert werden – sie können nur gelöscht und erneut hinzugefügt werden. Um Quellfilter zu ändern, entfernen Sie die Quelle zunächst aus dem Thema und fügen Sie sie anschließend mit der neuen Filterkonfiguration wieder hinzu.

ibmcloud event-notifications topic delete

  • Maßnahme: Vorhandene löschen Topic.
ibmcloud event-notifications topic-delete --id ID --instance-id INSTANCE-ID [--force]
  • Parameter, die angegeben werden müssen:
--id ID (Zeichenfolge)

Eindeutige ID für 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.

--instance-id 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](Boolesch)

Aktivieren, um das Löschen der Ressource zu erzwingen (um die Bestätigungsaufforderung zu umgehen).

Abonnements

Abonnement für IBM Cloud Event Notifications aktivieren.

ibmcloud event-notifications subscription create

  • Maßnahme: Neues erstellen Subscription.
ibmcloud event-notifications subscription-create --instance-id INSTANCE-ID --name NAME --destination-id DESTINATION-ID --topic-id TOPIC-ID [--description DESCRIPTION] [--attributes ATTRIBUTES]
  • Parameter, die angegeben werden müssen:
--name NAME (Zeichenfolge)

Der Name, der für das Abonnement festgelegt werden soll.

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 INSTANCE-ID (Zeichenfolge)

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

--description DESCRIPTION (Zeichenfolge)

Die Beschreibung, die für das Abonnement festgelegt werden soll.

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 DESTINATION-ID (Zeichenfolge)

Die Ziel-ID, die für das Abonnement festgelegt werden soll.

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 TOPIC-ID (Zeichenfolge)

Die Themen-ID, die für das Abonnement festgelegt werden soll

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 ATTRIBUTES (SubscriptionCreateAttributes)

Die für das Abonnement festzulegenden Attribute.

Beispiele

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

```json
   {
      "invited" :["+1xxxxxxxxxx", "+1xxxxxxxxxx"]
   }
   ```

- Das folgende Beispiel zeigt das Format des `SubscriptionCreateAttributes` Objekts für IBM-E-Mail.

```json
   {
      "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.

```json
   {
      "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.

```json
{
   "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.

```json
   {
      "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.

```json
   {
      "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.

   ```json
   {
      "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.

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

### ibmcloud event-notifications subscription list {: #en-cli-subscription-list-command}

- **Maßnahme:** Alle auflisten `Subscription`.

```sh {: pre}
ibmcloud event-notifications subscriptions [--offset OFFSET] [--limit LIMIT] [--search SEARCH] --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--limit LIMIT (int64)

Die Seitenbegrenzung für paginierte Ergebnisse.

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

--offset OFFSET (int64)

Die Einrückung für paginierte Ergebnisse.

Der Mindestwert ist 0.

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

--instance-id 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.

ibmcloud event-notifications subscription get

  • Maßnahme: Gehen Sie ins Detail Subscription.
ibmcloud event-notifications subscription --id ID --instance-id INSTANCE-ID
  • Parameter, die angegeben werden müssen:
--id ID (Zeichenfolge)

Eindeutige ID 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.

--instance-id 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.

ibmcloud event-notifications subscription delete

  • Maßnahme: Vorhandene löschen Subscription.
ibmcloud event-notifications subscription-delete --id ID --instance-id INSTANCE-ID [--force]
  • Parameter, die angegeben werden müssen:
--id ID (Zeichenfolge)

Eindeutige ID 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.

--instance-id 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](Boolesch)

Aktivieren, um das Löschen der Ressource zu erzwingen (um die Bestätigungsaufforderung zu umgehen).

ibmcloud event-notifications subscription update

  • Maßnahme: Vorhandene Dokumente aktualisieren Subscription.
ibmcloud event-notifications subscription-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES]
  • Parameter, die angegeben werden müssen:
--id ID (Zeichenfolge)

Eindeutige ID 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 NAME] (Zeichenfolge)

Die aktualisierte Beschreibung, die für das Abonnement festgelegt werden soll.

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 INSTANCE-ID (Zeichenfolge)

Der eindeutige Bezeichner 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.

[--description DESCRIPTION] (Zeichenfolge)

Die aktualisierte Beschreibung, die für das Abonnement festgelegt werden soll.

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 ATTRIBUTES] (SubscriptionUpdateAttributes)

Die Attribute, die für das Abonnement festgelegt werden sollen.

Beispiele

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

```json
   {
      "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.

```json
   {
      "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.

```json
   {
      "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.

```json
   {
      "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`.

```json
   {
      "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`.

```json
   {
      "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.

```json
   {
      "assigned_to" : "serviceuser@gmail.com",
      "assignment_group" : "incidentgroup"
   }
   ```

   - Das folgende Beispiel zeigt das Format des Objekts `SubscriptionUpdateAttributes` für Pagerduty/ Event Streams.

   ```json
   {
      "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 angelegt wird – entweder für **die Auswertung von Feature-Flags** oder für **die Erstellung von Benachrichtigungsvorlagen**, jedoch nicht für beides gleichzeitig.

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

## Integrationen {: #en-cli-integration}

Arbeiten Sie mit IBM Cloud Event Notifications Integration.

### ibmcloud-Ereignisbenachrichtigungsintegration Erstellen {: #en-cli-integration-create-command}

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

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.
--type (Zeichenfolge)

Typ der Integration collect_failed_events.

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

--metadata (IntegrationCreateAttributes)

Integrationsschema für Update

Metadaten für die Integration erforderlich.

Beispiele

  • 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"
   }
   ```

### iBM Cloud Event-Benachrichtigungen Integration ersetzen {: #en-cli-integration-update-command}

Ersetze `Integration`.

```sh
ibmcloud event-notifications integration-replace --instance-id INSTANCE-ID --id ID --type Type --metadata METADATA

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.
--type (Zeichenfolge)

Typ der Integration KMS/hs-crypto(veraltet).

Die maximale Länge beträgt 50 Zeichen. Die Mindestlänge beträgt 1 Zeichen. Erlaubte Werte sind KMS und collect_failed_events. Hinweis: Der Typ hs-crypto ist inzwischen veraltet. Es werden keine neuen Integrationsressourcen mit dem Typ hs-crypto unterstützt.

--metadata (IntegrationReplaceAttributes)

Integrationsschema für Update

Metadaten für die Integration erforderlich.

--id (Zeichenfolge)

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

  • Das folgende Beispiel zeigt das Format des IntegrationReplaceAttributes Objekts für kms.
   {
      "endpoint" : "https://qa.us-south.kms.cloud.ibm.com",
      "crn" : "crn of key protect",
      "root_key_id" : "root key id"
   }
   ```

### ibmcloud-Ereignisbenachrichtigungs-Integrationsliste {: #en-cli-integration-list-command}

Listet alle `Integrations` auf.

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

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.

ibmcloud-Ereignisbenachrichtigungen Integration erhalten

Bestimmte Integration abrufen.

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

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.
--id (Zeichenfolge)

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.

Vorlagen

IBM Cloud Event Notifications Vorlagen.

ibmcloud event-notifications template-create

Erstellen Sie eine neue Vorlage.

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

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. 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)

Die Nachrichtenvorlage. 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. 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)

Dateninhalt, der eine Vorlagenkonfiguration beschreibt. Erforderlich.

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-Mail. Der unterstützte Typ ist smtp_custom.notification|smtp_custom.invitation
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type smtp_custom.notification \
    --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

Alle Vorlagen auflisten. Hinweis: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Sammlung ab.

ibmcloud event-notifications templates --instance-id INSTANCE-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 `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)

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 (bool)

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

Details zu einer Vorlage abrufen.

ibmcloud event-notifications template --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 `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)

Eindeutige Kennung für 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-replace

Details einer Vorlage aktualisieren.

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

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. 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)

Eindeutige Kennung für 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)

Vorlagenname.

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)

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.

--type (Zeichenfolge)

Die Art der Vorlage.

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)

Dateninhalt, der eine Vorlagenkonfiguration beschreibt. 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-update \
    --instance-id exampleString \
    --id exampleString \
    --name exampleString \
    --description exampleString \
    --type exampleString \
    --params '{"body": "exampleString", "subject": "exampleString"}'

ibmcloud event-notifications template-delete

Vorlage löschen.

ibmcloud event-notifications template-delete --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 `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)

Eindeutige Kennung für 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-delete \
    --instance-id exampleString \
    --id exampleString

ibmcloud event-notifications pre-defined-templates

Alle vordefinierten Vorlagen auflisten.

Wenn die Option --all-pages nicht gesetzt ist, ruft der Befehl nur eine einzige 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)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. 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)

Quellenart. 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)

Zieltyp. 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)

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 (bool)

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

Beispiel

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

SMTP-Konfigurationen

IBM Cloud Event Notifications SMTP-Konfigurationen.

ibmcloud event-notifications smtp-configuration-create

Erstellen Sie eine neue SMTP-Konfiguration.

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

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. 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 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 Domänenname. 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)

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

Alle SMTP-Konfigurationen auflisten. Hinweis: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne Seite der Sammlung ab.

ibmcloud event-notifications smtp-configurations --instance-id INSTANCE-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 `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)

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 (bool)

Führen Sie mehrere Anfragen aus, um alle Seiten der Sammlung für SMTP-Konfigurationen 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 neuen SMTP-Benutzer.

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

Befehlsoptionen

--instance-id (Zeichenfolge)

Eindeutige ID für IBM Cloud Event Notifications-Instanz. 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)

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.

--description (Zeichenfolge)

Beschreibung der SMTP-Konfiguration.

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)

den Namen des zu klonenden Benutzers angeben.

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 auflisten. Hinweis: Wenn die Option --all-pages nicht festgelegt ist, ruft der Befehl nur eine einzelne 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 `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)

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 (bool)

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

Informieren Sie sich über die SMTP-Konfiguration.

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 `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)

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 die SMTP-Details.

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 `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)

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.

ibmcloud event-notifications smtp-configuration-delete --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 `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)

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

Details zu einem SMTP-Benutzer abrufen.

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 `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)

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 die Details des SMTP-Benutzers.

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 `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)

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.

ibmcloud event-notifications smtp-user-delete --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 `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)

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

Erhalten Sie Details zu den von SMTP zugelassenen IP-Adressen.

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 `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)

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

Hinweis: Die Unterstützung für die Aufnahme in die Liste der zu prüfenden Anträge ist veraltet. Die Unterstützung wurde über kontextbasierte Einschränkungen ermöglicht. Ausführliche Informationen finden Sie hier: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-smtp-configurations#en-smtp-configurations-cbr

ibmcloud event-notifications verify-smtp-update

Überprüfen Sie die SPF- und DKIM-Einträge von SMTP.

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 `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)

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-Überprüfungstyp. 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 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 `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.
--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

Erhalten Sie Bounce-Metriken.

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

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

Dieses Dokument beschreibt die Payload-Details zum Abrufen des Benachrichtigungsstatus für Webhook-Zieltest-Benachrichtigungen.

ibmcloud event-notifications notifications-status

Den Status einer Testbenachrichtigung abrufen, die an ein Webhook-Ziel gesendet wurde. Dieser Befehl dient speziell dazu, den Zustellstatus von Webhook-Testbenachrichtigungen abzurufen.

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 `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 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

Dieses Dokument beschreibt die Details der Nutzdaten für das Senden von Ereignissen mithilfe der API-Quellen unter Event Notifications. API-Quellen können verwendet werden, um Ereignisse von Ihren Back-End-Anwendungen zu senden. Event Notifications Unterstützt zwei Modi für die Durchführung von HTTP-Aufrufen. Dies entspricht der Spezifikation CloudEvents. Diese Modi sind der Binärmodus und der strukturierte Modus. Weitere Details finden Sie hier – https://github.com/cloudevents/spec. Im Binary Content Mode wird der Wert der Ereignisdaten unverändert in den Hauptteil der Anfrage oder Antwort unter HTTP eingefügt, wobei der Wert des Attributs datacontenttype den Medientyp im Content-Type-Header unter HTTP angibt; alle anderen Ereignisattribute werden den HTTP-Headern zugeordnet. Allen Attributnamen wird das Präfix ce- vorangestellt und sie werden in die Kopfzeile aufgenommen (mit Ausnahme von data und datacontenttype). Wenn obligatorische Attribute von CloudEvents (specversion, id, type und source) als Teil von Headern übergeben werden, wird die Anfrage als Binärmodus behandelt. Strukturierter Modus. Im Modus Structured Content werden die Metadatenattribute und Ereignisdaten in den Request-Body der HTTP-Anfrage eingefügt. Für den strukturierten Modus setzen Sie den Content-Type-Header auf application/cloudevents+json. Obligatorische Attribute von CloudEvents (specversion, id, type und source) müssen Teil des Antragstextes sein. Zusätzlich werden Identifikationsdaten als Dateninhaltstyp bereitgestellt, was obligatorisch ist. Wir unterstützen nur den Datentyp "application/json".

ibmcloud event-notifications send-notifications

Benachrichtigungen aus der Instanz senden. Weitere Informationen zur Nutzlast Event Notifications " finden Sie hier.

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

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.

Versionsprotokoll der Befehlszeilenschnittstelle (CLI)

Suchen Sie eine Zusammenfassung der Änderungen für jede Version des Event Notifications-Plug-ins. Halten Sie Ihre CLI auf dem neuesten Stand, damit Sie alle verfügbaren Befehle und deren Optionen verwenden können.

Die CLI-Plugin-Versionen von 0.0.5 bis 1.9.0 sind veraltet.

Änderungen in der IBM Cloud Event Notifications CLI
Version Freigabedatum Änderungen
1.5.0
  1. Mai 2024
Unterstützung für SMTP-Konfiguration und Slack-Vorlagen.
1.6.0
  1. August 2024
CF-Ziel veraltet und MMS unterstützt.
1.7.0
  1. August 2024
Unterstützung für Metriken und entfernte Unterstützung für SMTP-IPs, die von der SMTP-Konfiguration zugelassen wurden.
1.8.0
  1. September 2024
Unterstützung für Slack DM-Ziel.
1.9.0
  1. Oktober 2024
Unterstützung für Webhook-Vorlagen.
1.10.0
  1. November 2024
Unterstützung für Cloud Functions entfernt
1.11.0
  1. Januar 2025
Unterstützung für Periodic Timer
1.12.0
  1. Februar 2025
Unterstützung für Pagerduty-Vorlage
1.13.0
  1. März 2025
Unterstützung für Event Streams Ziel, Abonnement und Vorlagen.
1.14.0
  1. April 2025
PagerDuty der veraltete Parameter api_key ist als optional gekennzeichnet.
1.15.0
  1. Juni 2025
Der Markdown-Inhalt für die Benachrichtigung.
1.16.0
  1. August 2025
Code Engine und vordefinierte Vorlagen unterstützt.
1.17.0
  1. September 2025
Unterstützung des Webhook-Ziels test get notifications-status Befehl
1.18.0
  1. Spetember 2025
Unterstützung von App-Konfigurationszielen, Abonnements und Vorlagen
1.19.0
  1. Oktober 2025
Unterstützung für geklonte smtp-Benutzeranmeldedaten
1.20.0
  1. Dezember 2025
Unterstützung für Bounce-Metriken
1.20.1
  1. Januar 2026
Behebung des Problems mit den Metadaten für die Unterstützung privater Endpunkte und der Installation des EN-Plugins in private.cloud.ibm.com
1.20.2
  1. Februar 2026
CLI-Plugin Sicherheitslücke beheben Patch-Update
1.21.0
  1. April 2026
CLI-Plugin-Update für View-Sandbox, E-Mail-Anhänge und Unterstützung von Quelloptionen für Payload-Debugging
1.21.1
  1. Mai 2026
Die Befehle init und show wurden veraltet und der Befehl en instances listing hinzugefügt. Es wurde eine Korrektur vorgenommen, um den EN-Endpunkt automatisch entsprechend der eingestellten Zielregion zu setzen.
1.21.2
  1. Juni 2026
Fehlerbehebung bei den SMTP-Metriken zur Unterstützung des SMTP-Config-ID-Flags und zur Kennzeichnung des Zieltyps als optional.
1.21.3
  1. August 2026
Behebung einer Sicherheitslücke im CLI-Plugin sowie Verbesserungen hinsichtlich Benutzerfreundlichkeit und Optik