Referencia de CLI de Event Notifications

Para trabajar con Event Notifications mediante la interfaz comando línea de comandos (CLI), puede instalar el complemento CLI de Event Notifications desde el repositorio de complementos de IBM Cloud. El complemento está diseñado para ampliar las capacidades que ofrece la interfaz de línea de comandos (CLI) de IBM Cloud.

Requisitos previos

Cuando inicias sesión en la CLI de IBM Cloud, se te notifica si hay actualizaciones disponibles. Asegúrate de mantener tu CLI actualizada para poder acceder a cualquier comandos o indicador nuevo que esté disponible para el complemento CLI de Event Notifications.

Instalar la CLI de Event Notifications

Instala el complemento de la CLI de Event Notifications utilizando el comando plugin install.

ibmcloud plugin install event-notifications

Las versiones del complemento anteriores a 1.15.2 han quedado obsoletas.

Event Notifications Comandos CLI

El comando init está obsoleto y se eliminará en una versión futura.

ibmcloud event-notifications en-list

Enumera las instancias de la región de destino establecida. Puede recuperar el GUID de su instancia de las instancias listadas.

ibmcloud event-notifications en-list

Ejemplo

ibmcloud event-notifications en-list

Selecciona una región de destino

Establece la región en la que deseas trabajar utilizando el comando ibmcloud target.

ibmcloud target -r REGION

Como alternativa, puedes exportar un punto final regional mediante la variable, tal y como IBMCLOUD_EN_ENDPOINT se muestra en el siguiente ejemplo.

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

Para configurar el punto final regional como público o privado, consulta las siguientes opciones:

  • Puntos de conexión públicos disponibles:

    • Dallas: https://us-south.event-notifications.cloud.ibm.com/event-notifications
    • Londres: https://eu-gb.event-notifications.cloud.ibm.com/event-notifications
    • Sídney: https://au-syd.event-notifications.cloud.ibm.com/event-notifications
    • Fráncfort: 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
    • En 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
  • Puntos de conexión privados disponibles:

    • Dallas: https://private.us-south.event-notifications.cloud.ibm.com/event-notifications
    • Londres: https://private.eu-gb.event-notifications.cloud.ibm.com/event-notifications
    • Sídney: https://private.au-syd.event-notifications.cloud.ibm.com/event-notifications
    • Fráncfort: 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
    • En 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

También puede exportar la variable EVENT_NOTIFICATIONS_API_KEY para configurar la clave API o la clave API de las credenciales del servicio para su instancia de Event Notifications.

Orígenes

Operar en IBM Cloud Event Notifications fuente.

ibmcloud event-notifications source-create

Crea una fuente que configure un servicio para generar eventos que Event Notifications pueda consumir. Debe indicar el ID de la instancia de Event Notifications para la que va a configurar el origen. Para obtener más información sobre los tipos de fuente y cómo registrarlos en Event Notifications, consulta Añadir una fuente de Event Notifications.

Actualmente, la CLI solo permite crear fuentes de API.

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

sources-create Se admiten tanto como source-create. Utiliza source-create para mantener la coherencia con otros comandos.

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name NAME (cadena)

El nombre que se debe proporcionar para la fuente de la API. Obligatorio.

El valor predeterminado es . La longitud máxima es de caracteres 255. La longitud mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description (cadena)

Descripción del código fuente de la API.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--enabled (booleano)

Activar o desactivar la fuente. Obligatorio. Establece en true para habilitar la fuente.

--store-notifications (booleano)

Notificaciones de la tienda. Configúralo en true para almacenar notificaciones y poder ver el contenido de los eventos entrantes con fines de resolución de problemas.

Ejemplo

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

ibmcloud event-notifications source-update

Actualiza los parámetros de origen utilizando el ID de origen. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado la fuente.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la fuente. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--name (cadena)

El nombre actualizado de la fuente de la API.

El valor predeterminado es . La longitud máxima es de caracteres 255. La longitud mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description (cadena)

Descripción actualizada del código fuente de la API.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--enabled (booleano)

Activar o desactivar la fuente.

El valor se establece en true para habilitar la fuente y en false para deshabilitarla.

--store-notifications (booleano)

Notificaciones de la tienda. Puede consultar la carga útil de los eventos entrantes con fines de resolución de problemas.

El valor predeterminado es false.

Ejemplo

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

ibmcloud event-notifications sources

Enumera todas las fuentes en una instancia específica.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--limit (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--search (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de origen.

Ejemplo

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

ibmcloud event-notifications source

Consulta los detalles de una fuente concreta.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la fuente. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

Ejemplo

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

ibmcloud event-notifications source-delete

Eliminar una fuente.

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

Opciones de comando

--id (cadena)

Identificador exclusivo para el Origen. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--instance-id (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--force

Omite el mensaje de confirmación y fuerza la eliminación del recurso.

Ejemplo

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

Destinos

Operar en IBM Cloud {{site {{site.data.keyword.en_short}} destino.

ibmcloud event-notifications destination-create

Crea un destino que sirva como objetivo de entrega para una notificación. Un destino puede configurarse para enviar notificaciones a un usuario humano o a un servicio automatizado.

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]

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name (cadena)

El nombre del destino. Obligatorio.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (cadena)

El tipo de destino. Destinos para usuarios humanos: smtp_ibm, sms_ibm, smtp_custom, sms_custom, event_streams, msteams, pagerduty, push_android, push_chrome, push_firefox, push_huawei, push_ios, push_safari, servicenow, slack. Destinos para servicios: ibmce, ibmcos, webhook. Obligatorio.

La extensión mínima es de caracteres 1.

--description (cadena)

La descripción del destino.

El valor predeterminado es . La longitud máxima es de caracteres 255. La longitud mínima es de caracteres 0. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--collect-failed-events (booleano)

Configúralo true para recopilar eventos fallidos en un bucket de Cloud Object Storage. Para recopilar eventos de error, habilita la integración Cloud Object Storage para esta instancia. El valor predeterminado es false.

--config ( DestinationConfig ejemplos )

La configuración del destino. Si creas un destino sin « --config », el destino se creará, pero no funcionará hasta que lo configures.

--certificate (cadena)

Ruta del archivo de certificado para destinos de notificaciones push de APNs o iOS. Admite archivos de certificados de tipo p8 y p12.

--certificate-content-type (cadena)

El tipo de contenido del certificado para destinos de iOS. Los valores permitidos son p8 y p12.

--icon16x16 (cadena)

La ruta de acceso al icono de Safari es 16x16. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon16x16-content-type (cadena)

El tipo de contenido del icono de Safari 16x16.

--icon16x162x (cadena)

La ruta del archivo del icono de Safari es 16x16@2x. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon16x162x-content-type (cadena)

El tipo de contenido del icono de Safari 16x16@2x.

--icon32x32 (cadena)

La ruta de acceso al icono de Safari es 32x32. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon32x32-content-type (cadena)

El tipo de contenido del icono de Safari 32x32.

--icon32x322x (cadena)

La ruta del archivo del icono de Safari es 32x32@2x. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon32x322x-content-type (cadena)

El tipo de contenido del icono de Safari 32x32@2x.

--icon128x128 (cadena)

La ruta del archivo del icono de Safari es 128x128. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon128x128-content-type (cadena)

El tipo de contenido del icono de Safari 128x128.

--icon128x1282x (cadena)

La ruta del archivo del icono de Safari es 128x128@2x. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon128x1282x-content-type (cadena)

El tipo de contenido del icono de Safari 128x128@2x.

Cloud Functions ya no es un destino compatible.

Ejemplos

ibmcloud event-notifications destination-create \
  --instance-id=exampleString \
  --name=exampleString \
  --type=webhook \
  --description=exampleString \
  --collect-failed-events=false \
  --config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
  --certificate=tempdir/test-file.txt \
  --certificate-content-type=exampleString \
  --icon16x16=tempdir/test-file.txt \
  --icon16x16-content-type=exampleString \
  --icon16x162x=tempdir/test-file.txt \
  --icon16x162x-content-type=exampleString \
  --icon32x32=tempdir/test-file.txt \
  --icon32x32-content-type=exampleString \
  --icon32x322x=tempdir/test-file.txt \
  --icon32x322x-content-type=exampleString \
  --icon128x128=tempdir/test-file.txt \
  --icon128x128-content-type=exampleString \
  --icon128x1282x=tempdir/test-file.txt \
  --icon128x1282x-content-type=exampleString
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para un destino de iOS (push_ios) con un certificado de P8. Establezca el parámetro booleano pre_prod en true para configurar el destino como destino de preproducción o en 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)
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para un destino de iOS (push_ios) con un certificado de P12. Establezca el parámetro booleano pre_prod en true para configurar el destino como destino de preproducción o en false.

    {
       "params" : {
          "cert_type" : "p12",
          "is_sandbox" : true,
          "password": "apnspasswordvalue",
          "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino Chrome (push_chrome). Establezca el parámetro booleano pre_prod en true para configurar el destino como destino de preproducción o en false.

    {
       "params" : {
          "api_key": "chromeapikey",
          "website_url" : "https://testwebsite.com",
          "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • El siguiente ejemplo muestra el formato del objeto DestinationConfig para el destino Firefox (push_firefox). Establezca el parámetro booleano pre_prod en true para configurar el destino como destino de preproducción o en false.

    {
       "params" : {
          "website_url" : "https://testwebsite.com",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • El siguiente ejemplo muestra el formato del objeto DestinationConfig para el destino Slack (slack) con el tipo incoming_webhook.

    {
       "params" : {
          "type" : "incoming_webhook",
          "url" : "https://hooks.slack.com/services/G0gyhsush/TYodsjhs/GHTbfidsimkk"
       }
    }
    
  • El siguiente ejemplo muestra el formato del objeto DestinationConfig para el destino Slack (slack) con el tipo como direct_message.

    {
       "params" : {
          "type" : "direct_message",
          "token" : "vhdwvecwefwefewivcweivcwiwiciwcvwicwec"
       }
    }
    
  • El siguiente ejemplo muestra el formato del objeto DestinationConfig para el destino Safari (push_safari). Establezca el parámetro booleano pre_prod en true para configurar el destino como destino de preproducción o en false.

    {
       "params": {
          "cert_type":"p12",
          "certificate_name":"Users/Testuser/Documents/safari.p12",
          "password":"safarinew",
          "url_format_string":"https://test.com",
          "website_name":"testwebsite",
          "website_push_id":"test",
          "website_url":"https://test.com",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino MS Teams (msteams).

    {
       "params" : {
          "url" : "https://xyz.webhook.office.com"
       }
    }
    
  • El siguiente ejemplo muestra el formato del objeto DestinationConfig para el destino PagerDuty(pagerduty.

    Se recomienda utilizar sólo la tecla Enrutar al crear el destino. La clave API está obsoleta y no podrá utilizarse en el futuro.

    {
       "params" : {
          "routing_key" : "routingkeytoconnecttoPD",
          "api_key" : "cffunctionnamespaceserviceidapikey"
       }
    }
    
  • El siguiente ejemplo muestra el formato del objeto DestinationConfig para Webhook (webhook).

    {
       "params" : {
          "url" : "exampleString",
          "verb" : "get",
          "custom_headers" : { },
          "sensitive_headers" : [ "exampleString" ]
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino Android (push_android).

    {
       "params" : {
          "project_id" : "6232305230320",
          "private_key" : "36e21epfweort823or8rt832pr8p2r832pr82pr382r8f",
          "client_email" : "testuser.123@gmail.com",
          "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • El siguiente ejemplo muestra el formato del objeto DestinationConfig para un destino de ServiceNow(servicenow ).

    {
       "params" : {
          "client_id" : "359705ceddd100eyfewyyw1f0f9e1c96",
          "client_secret": "testsecrets",
          "username": "testuser",
          "password": "user_password",
          "instance_name": "testinstancenje"
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino Code Engine (ibmce).

    código motor destino tipo: aplicación

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

    código motor destino tipo: trabajo

    {
       "params" : {
          "type" : "job",
          "job_name" : "custom-job",
          "project_crn" : "crn:v1:bluemix:public:codeengine:us-south:a/e7e5820aeccb40efb78fd69a7858ef23:xxxxxxxxxxxxxx::"
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino IBM Cloud Object Storage (ibmcos).

    {
       "params" : {
          "bucket_name" : "cos-destination-en-bucket",
          "instance_id" : "42e13636e-0548-41a0-a178-e95be28464773",
          "endpoint" : "https://s3.us-west.cloud-object-storage.appdomain.cloud"
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino Huawei (push_huawei).

    {
       "params" : {
          "client_id" : "359705ceddd100eyfew",
          "client_secret": "testsecrets",
          "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino de correo electrónico personalizado (smtp_custom). En el caso del destino Sandbox de correo electrónico personalizado (smtp_custom_sandbox), los parámetros de configuración de destino no son necesarios.

    Proceso para realizar la configuración y verificación del dominio personalizado: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify

    {
       "params" : {
          "domain": "mailx.com"
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino Event Streams (event_streams).

    {
       "params" : {
          "crn": "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c13357373:a292db6e-af78-4c0b-b3db-7d6794b637g::",
          "endpoint": "https://n6627w6t7dgeh2cfgd.svc09.us-south.eventstreams.cloud.ibm.com",
          "topic": "demo_topic"
       }
    }
    
  • El siguiente ejemplo muestra el formato del DestinationConfig objeto para el destino App Configuration (app_configuration).

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

    Se puede crear un destino de SMS personalizado sin DestinationConfig, pero no funcionará hasta que se soliciten y configuren explícitamente los números personalizados necesarios. Para solicitar números personalizados, consulta la sección «Números personalizados de SMS ».

ibmcloud event-notifications destinations

Enumera todos los destinos de una instancia de Event Notifications.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--limit (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--search (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de destino.

Ejemplo

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

ibmcloud event-notifications destination

Obtén los detalles de un destino utilizando su ID.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del destino. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Ejemplo

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

ibmcloud event-notifications destination-update

Actualiza los parámetros de destino utilizando el ID de destino.

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]

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del destino. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name (cadena)

El nombre actualizado del destino.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (cadena)

Descripción actualizada del destino.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--collect-failed-events (booleano)

Configúralo true para recopilar eventos fallidos en un bucket de Cloud Object Storage. El valor predeterminado es false.

--config (DestinationConfig)

La configuración actualizada del destino.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --config=@path/to/file.json.

--certificate (cadena)

Ruta del archivo de certificado para destinos de notificaciones push de APNs o iOS. Admite archivos de certificados de tipo p8 y p12.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--certificate-content-type (cadena)

El tipo de contenido del certificado para destinos de iOS. Los valores permitidos son p8 y p12.

--icon16x16 (cadena)

La ruta de acceso al icono de Safari es 16x16. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon16x16-content-type (cadena)

El tipo de contenido del icono de Safari 16x16.

--icon16x162x (cadena)

La ruta del archivo del icono de Safari es 16x16@2x. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon16x162x-content-type (cadena)

El tipo de contenido del icono de Safari 16x16@2x.

--icon32x32 (cadena)

La ruta de acceso al icono de Safari es 32x32. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon32x32-content-type (cadena)

El tipo de contenido del icono de Safari 32x32.

--icon32x322x (cadena)

La ruta del archivo del icono de Safari es 32x32@2x. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon32x322x-content-type (cadena)

El tipo de contenido del icono de Safari 32x32@2x.

--icon128x128 (cadena)

La ruta del archivo del icono de Safari es 128x128. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon128x128-content-type (cadena)

El tipo de contenido del icono de Safari 128x128.

--icon128x1282x (cadena)

La ruta del archivo del icono de Safari es 128x128@2x. Para push_safari destinos.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon128x1282x-content-type (cadena)

El tipo de contenido del icono de Safari 128x128@2x.

Ejemplo

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

ibmcloud event-notifications destination-delete

Eliminar un destino utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el destino.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del destino. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--force (booleano)

Forzar la ejecución del comando.

Ejemplo

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

ibmcloud event-notifications enabled-countries

Obtener los datos del país habilitado de un destino de SMS utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el destino.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del destinatario del SMS. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Ejemplo

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

ibmcloud event-notifications test-destination

Comprueba la configuración de un destino utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el destino. Para consultar la lista de destinos compatibles, véase Comprobación de un destino.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del destino. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Ejemplo

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

ibmcloud event-notifications sandbox-destination-update

Actualiza un destino de correo electrónico del entorno de pruebas a producción con un dominio personalizado.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del destino. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--domain (cadena)

El dominio de correo electrónico. Obligatorio.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

ibmcloud event-notifications verify-destination-update

Verifica los registros SPF y DKIM de un dominio personalizado.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del destino. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--type (cadena)

El tipo de verificación para un destino de correo electrónico con dominio personalizado. Los valores permitidos son spf y dkim. Obligatorio.

La longitud máxima es de 20 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-z]/.

Ejemplo

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

Temas

Operar en IBM Cloud {{site {{site.data.keyword.en_short}} tema.

ibmcloud event-notifications topic-create

Crea un tema para recibir eventos de las fuentes y enviar notificaciones a los destinos suscritos. Un tema puede conectarse a varios orígenes. Para crear un tema, debes indicar el ID de la instancia de Event Notifications.

Para obtener más información, consulta Creación de un tema.

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

Opciones de comando

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name NAME (cadena)

El nombre del tema. Obligatorio.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description DESCRIPTION (cadena)

Descripción del tema.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--sources SOURCES (TopicCreateSourcesItem[])

La configuración de la fuente y del filtro que se debe asociar al tema. Consulta los ejemplos de configuración de origen.

Ejemplo

ibmcloud event-notifications topic-create \
  --instance-id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'
  • El siguiente ejemplo muestra el formato del objeto TopicCreateSourcesItem[] para la fuente Temporizador periódico.

    [
       {
          "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": "* * * * *"
                }
             }
          ]
       }
    ]
    
  • El siguiente ejemplo muestra el formato del objeto TopicCreateSourcesItem[].

    [
       {
          "id" : "exampleString",
          "rules" : [
             {
                "enabled" : true,
                "event_type_filter" : "$.*",
                "notification_filter" : "exampleString"
             }
          ]
       }
    ]
    
  • El siguiente ejemplo muestra el formato del objeto TopicUpdateSourcesItem[].

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

ibmcloud event-notifications topics

Enumera todos los temas creados para una instancia de Event Notifications. Debe indicar el ID de la instancia.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--limit (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--search (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de temas.

Ejemplo

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

ibmcloud event-notifications topic

Consulta los detalles de un tema utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el tema.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del tema. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--include (cadena)

Incluir subtemas.

El valor por defecto es ``. La longitud máxima es 20 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-z]/.

Ejemplo

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

ibmcloud event-notifications topic-update

Actualiza los detalles de un tema utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el tema.

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

Puedes utilizar topic-replace como alias de topic-update. El comando topic-replace está obsoleto y se eliminará en una futura versión.

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del tema. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--name (cadena)

El nombre actualizado del tema.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description (cadena)

Descripción actualizada del tema.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--sources (TopicUpdateSourcesItem[])

Los detalles y filtros actualizados de la fuente. Consulta los ejemplos de configuración de origen.

Esta opción solo añade nuevas fuentes. Las fuentes que ya están asociadas al tema no se pueden sustituir ni actualizar. Para modificar los filtros de origen, elimina el origen del tema y añádelo de nuevo con la nueva configuración de filtros.

Ejemplo

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

ibmcloud event-notifications topic-delete

Elimina un tema utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el tema.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único del tema. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--force (booleano)

Forzar la ejecución del comando.

Ejemplo

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

Suscripciones

Funciona con IBM Cloud {{site {{site.data.keyword.en_short}} suscripción.

ibmcloud event-notifications subscription-create

Crea una suscripción que vincule un destino a un tema para la entrega de eventos. Un destino puede suscribirse a temas, y varios destinos pueden suscribirse al mismo tema. Para crear una suscripción, debe proporcionar el ID de la instancia de Event Notifications.

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

Opciones de comando

--name (cadena)

El nombre de la suscripción. Obligatorio.

La longitud máxima es de 50 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--description (cadena)

Descripción de la suscripción.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--destination-id (cadena)

El ID de destino al que enlazar con el tema. Obligatorio.

La longitud máxima es de 150 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--topic-id (cadena)

El ID del tema de la suscripción. Obligatorio.

La longitud máxima es de 150 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--attributes (SubscriptionCreateAttributes)

Los atributos necesarios para crear la suscripción. Véanse los ejemplos de atributos.

Ejemplos

ibmcloud event-notifications subscription-create \
  --instance-id=exampleString \
  --name=exampleString \
  --destination-id=exampleString \
  --topic-id=exampleString \
  --description=exampleString \
  --attributes='{"invited": ["exampleString"]}'
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para el webhook.
{
   "signing_enabled" : true,
   "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13"
}
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para SMS.
{
   "invited" :["+1xxxxxxxxxx", "+1xxxxxxxxxx"]
}
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para el correo electrónico de IBM.
{
   "invited" :["entest@gmail.com"],
   "add_notification_payload": true,
   "reply_to_mail": "en@ibm.com",
   "reply_to_name": "EYS ORG",
   "from_name":"ABC ORG"
}
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para el tipo de destino de Slack incoming_webhook.
{
   "attachment_color" : "#FF0000",
   "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para el tipo de destino de Slack direct_message.
{
"channels" : [{ "id": "GHIUIFJHGGH"},{"id": "TSFDIDFOFNF"}],
"template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para ServiceNow.
{
   "assigned_to" : "serviceuser@gmail.com",
   "assignment_group" : "incidentgroup"
}
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para el correo electrónico personalizado.

    {
       "invited" :["entest@gmail.com"],
       "add_notification_payload": true,
       "reply_to_mail": "en@ibm.com",
       "reply_to_name": "EYS ORG",
    }
    
  • El siguiente ejemplo muestra el formato del objeto SubscriptionCreateAttributes para Custom Email Sandbox.

    {
       "invited" :["entest@gmail.com"],
       "add_notification_payload": true,
       "reply_to_mail": "en@ibm.com",
       "reply_to_name": "EYS ORG",
       "from_name":"ABC ORG",
       "from_email":"Testuser@mailx.com",
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
       "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
    }
    
  • El siguiente ejemplo muestra el formato del objeto SubscriptionCreateAttributes para Pagerduty/ Event Streams.

    {
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
    }
    
  • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para App Configuration. Al crear o actualizar una suscripción para un App Configuration destino, el objeto attributes tiene una regla específica:

    • Debe incluir feature_flag_enabled o template_id_notification
    • No puedes incluir ambas propiedades a la vez

    De este modo se garantiza que se cree una suscripción para el caso de uso correcto: ya sea la evaluación de indicadores de funcionalidad o la creación de plantillas de notificaciones, pero no ambas cosas a la vez.

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

ibmcloud event-notifications subscriptions

Enumera todas las suscripciones configuradas para una instancia de Event Notifications. Debe indicar el ID de la instancia.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--offset (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--limit (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--search (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de la suscripción.

Ejemplo

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

ibmcloud event-notifications subscription

Consulta los detalles de una suscripción utilizando su ID. Debe indicar el ID de la instancia de Event Notifications para la que está configurada la suscripción.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la suscripción. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

Ejemplo

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

ibmcloud event-notifications subscription-delete

Elimina una suscripción utilizando su ID. Debe indicar el ID de la instancia de Event Notifications para la que está configurada la suscripción.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la suscripción. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--force (booleano)

Forzar la ejecución del comando.

Ejemplo

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

ibmcloud event-notifications subscription-update

Actualiza los parámetros de una suscripción utilizando su ID. Debe indicar el ID de la instancia de Event Notifications para la que está configurada la suscripción.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la suscripción. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--name (cadena)

El nombre actualizado de la suscripción.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--description (cadena)

Descripción actualizada de la suscripción.

El valor por defecto es ``. La longitud máxima es 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--attributes (SubscriptionUpdateAttributes)

Los atributos actualizados. Véanse los ejemplos de atributos.

Ejemplos

ibmcloud event-notifications subscription-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --attributes='{"invited": {"add": ["exampleString"], "remove": ["exampleString"]}, "subscribed": {"remove": ["exampleString"]}, "unsubscribed": {"remove": ["exampleString"]}}'
  • El siguiente ejemplo muestra el formato del SubscriptionUpdateAttributes objeto para Webhook.

    {
       "signing_enabled": true
    }
    
  • El siguiente ejemplo muestra el formato del SubscriptionUpdateAttributes objeto para un SMS de IBM.

    {
       "invited": {
          "add": ["+8xxxxxxxxxx"],
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       },
       "subscribed": {
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       },
       "unsubscribed": {
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       }
    }
    
  • El siguiente ejemplo muestra el formato del SubscriptionUpdateAttributes objeto para el correo electrónico de IBM.

    {
       "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
    }
    
  • El siguiente ejemplo muestra el formato del SubscriptionUpdateAttributes objeto para el correo electrónico personalizado.

    {
       "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"
    }
    
  • El siguiente ejemplo muestra el formato del objeto SubscriptionUpdateAttributes para Custom Email Sandbox.

    {
       "invited": {
          "add": ["example1@gmail.com"],
          "remove": []
       },
       "subscribed": {
          "remove": ["example2@gmail.com"]
       },
       "unsubscribed": {
          "remove": ["example3@gmail.com"]
       },
       "reply_to_mail": "example@ibm.com",
       "reply_to_name": "USA news",
       "add_notification_payload": true,
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
       "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
    }
    
  • El siguiente ejemplo muestra el formato del objeto SubscriptionUpdateAttributes para Slack para el tipo como incoming_webhook.

    {
       "attachment_color" : "#FF0000",
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    
  • El siguiente ejemplo muestra el formato del objeto SubscriptionUpdateAttributes para Slack para el tipo como direct_message.

    {
       "channels": [{"id": "D01CFDTYBH", "operation": "add"}, {"id": "D01GHUTYBH", "operation": "remove"}],
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    
  • El siguiente ejemplo muestra el formato del SubscriptionUpdateAttributes objeto para Service Now.

    {
       "assigned_to" : "serviceuser@gmail.com",
       "assignment_group" : "incidentgroup"
    }
    
    • El siguiente ejemplo muestra el formato del objeto SubscriptionUpdateAttributes para Pagerduty/ Event Streams.
    {
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    
    • El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para App Configuration. Al crear o actualizar una suscripción para un App Configuration destino, el objeto attributes tiene una regla específica:

      • Debe incluir feature_flag_enabled o template_id_notification
      • No puedes incluir ambas propiedades a la vez

      De este modo se garantiza que se cree una suscripción para el caso de uso correcto: ya sea la evaluación de indicadores de funcionalidad o la creación de plantillas de notificaciones, pero no ambas cosas a la vez.

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

Integraciones

Operar en IBM Cloud {{site {{site.data.keyword.en_short}} integración.

ibmcloud event-notifications integration-create

Crea una integración que conecte Event Notifications con IBM Cloud Object Storage.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--type (cadena)

El tipo de integración. El tipo admitido es collect_failed_events. Obligatorio.

La longitud máxima es de 50 caracteres. La longitud mínima es de 1 caracteres. El valor permitido es collect_failed_events.

--metadata (cadena)

Los metadatos de integración necesarios para crear la integración. Consulta el ejemplo para obtener ayuda sobre el formato. Obligatorio.

Ejemplos

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

El siguiente ejemplo muestra el formato del objeto IntegrationCreateAttributes.

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

ibmcloud event-notifications integration-update

Actualiza una integración existente utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado la integración.

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

En este momento, también puedes utilizar integration-replace para actualizar tu integración. Sin embargo, el comando integration-replace está en desuso y se eliminará en una futura versión.

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--type (cadena)

El tipo de integración. Los valores permitidos son kms, hs-crypto, y collect_failed_events. Obligatorio.

La longitud máxima es de 50 caracteres. La longitud mínima es de 1 caracteres.

--metadata (cadena)

Los metadatos de integración necesarios para actualizar la integración. Consulta el ejemplo para obtener ayuda sobre el formato. Obligatorio.

--id (cadena)

El identificador único de la integración. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

Ejemplos

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

El siguiente ejemplo muestra el formato del objeto IntegrationReplaceAttributes de Key Protect.

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

ibmcloud event-notifications integrations

Enumera las integraciones creadas para una instancia de Event Notifications.

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

Opciones de comando

--instance-id (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--limit (int64)

Límite de página para resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor mínimo es 0.

--search (cadena)

Serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de integraciones.

Ejemplo

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

ibmcloud event-notifications integration

Consulta los detalles de una integración utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado la integración.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la integración. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

Ejemplo

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

Plantillas

IBM Cloud Event Notifications plantillas.

ibmcloud event-notifications template-create

Crear una plantilla para invitaciones y notificaciones. También debe proporcionar el ID de la instancia de Event Notifications para la que configura la plantilla.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 10 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name (cadena)

El nombre de la plantilla. Obligatorio.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (cadena)

El tipo de plantilla. Los tipos admitidos son smtp_custom.invitation, smtp_custom.notification, webhook.notification, slack.notification, pagerduty.notification, y event_streams.notification. Obligatorio.

La longitud máxima es de 24 caracteres. La longitud mínima es de 22 caracteres. El valor debe coincidir con la expresión regular /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Los parámetros de la plantilla para la notificación. Obligatorio. Consulte los parámetros de la plantilla.

En su lugar, esta opción JSON puede proporcionarse configurando campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --params=@path/to/file.json.

--description (cadena)

Descripción de la plantilla.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--params-body (cadena)

Cuerpo de la plantilla. Esta opción proporciona un valor para un subcampo de la opción JSON 'params'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 20000 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--params-subject (cadena)

El asunto de la plantilla. Esta opción proporciona un valor para un subcampo de la opción JSON 'params'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 1000 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

Ejemplos

  • El siguiente ejemplo muestra el formato del TemplateConfig objeto para el correo electrónico. Los tipos admitidos son smtp_custom.notification y smtp_custom.invitation.
ibmcloud event-notifications template-create \
  --instance-id=exampleString \
  --name=exampleString \
  --type=exampleString \
  --params='{"body": "exampleString", "subject": "exampleString"}' \
  --description=exampleString
  • El siguiente ejemplo muestra el formato del TemplateConfig objeto para Slack. El tipo admitido es slack.notification.
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type slack.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString
  • El siguiente ejemplo muestra el formato del TemplateConfig objeto para Webhook. El tipo admitido es webhook.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type webhook.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString
  • El siguiente ejemplo muestra el formato del TemplateConfig objeto para Pagerduty. El tipo admitido es pagerduty.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type pagerduty.notification \
    --params '{"body": "ewogICJwYXlsb2FkIjogewogICAgInN1bW1hcnkiOiAie3sgZGF0YS5hbGVydF9kZWZpbml0aW9uLm5hbWV9fSIsCiAgICAidGltZXN0YW1wIjogInt7dGltZX19IiwKICAgICJzZXZlcml0eSI6ICJpbmZvIiwKICAgICJzb3VyY2UiOiAie3sgc291cmNlIH19IgogIH0sCiAgImRlZHVwX2tleSI6ICJ7eyBpZCB9fSIsCiAge3sjZXF1YWwgZGF0YS5zdGF0dXMgInRyaWdnZXJlZCJ9fQogICJldmVudF9hY3Rpb24iOiAidHJpZ2dlciIKICAge3svZXF1YWx9fQoKICB7eyNlcXVhbCBkYXRhLnN0YXR1cyAicmVzb2x2ZWQifX0KICAiZXZlbnRfYWN0aW9uIjogInJlc29sdmUiCiAge3svZXF1YWx9fQoKICAge3sjZXF1YWwgZGF0YS5zdGF0dXMgImFja25vd2xlZGdlZCJ9fQogICAiZXZlbnRfYWN0aW9uIjogImFja25vd2xlZGdlIgogICB7ey9lcXVhbH19Cn0="}' \
    --description exampleString
  • El siguiente ejemplo muestra el formato del TemplateConfig objeto para Event Streams. El tipo admitido es event_streams.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type event_streams.notification \
    --params '{"body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="}' \
    --description exampleString
  • El siguiente ejemplo muestra el formato del objeto TemplateConfig para Code Engine Job. El tipo admitido es ibmcejob.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmcejob.notification\
    --params '{"body": "ewogInJ1bl9lbnZfdmFyaWFibGVzIjogWwogICB7ICJuYW1lIjogInJlZ2lvbiIsICJ2YWx1ZSI6ICJ7e2RhdGEucmVnaW9ufX0iLCJ0eXBlIjogImxpdGVyYWwifSwKeyJuYW1lIjoiVkFSMSIsInR5cGUiOiJsaXRlcmFsIiwidmFsdWUiOiJ7e2RhdGEudmFyMX19In0sCnsibmFtZSI6IlZBUjIiLCJ0eXBlIjoibGl0ZXJhbCIsInZhbHVlIjoie3tkYXRhLnZhcjJ9fSJ9Cl0KfQ=="}' \
    --description exampleString
  • El siguiente ejemplo muestra el formato del objeto TemplateConfig para Code Engine Aplicación/Función. El tipo admitido es ibmceapp.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmceapp.notification\
    --params '{"body": "ewogICJ2YXIxIjogInt7ZGF0YS52YXIxfX0iLAogICJ2YXIyIjogInt7ZGF0YS52YXIyfX0iCn0="}' \
    --description exampleString
  • El siguiente ejemplo muestra el formato del TemplateConfig objeto para App Configuration. El tipo admitido es 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

Enumera todas las plantillas definidas por el usuario que se han creado para una instancia de Event Notifications. Debe indicar el ID de la instancia.

Si no se configura la opción --all-pages, el comando solo recupera una página de la colección.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 10 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--limit (int64)

El límite de páginas para los resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

El desplazamiento para los resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de plantillas.

Ejemplo

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

ibmcloud event-notifications template

Consulta los detalles de una plantilla utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado la plantilla.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--id (cadena)

El identificador único de la plantilla. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

Ejemplo

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

ibmcloud event-notifications template-update

Actualizar los detalles de una plantilla existente creada en una instancia de Event Notifications.

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

Puedes utilizar template-update en lugar de template-replace. Actualmente se admiten ambos comandos, pero template-replace quedarán obsoletos en una futura versión.

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 10 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la plantilla. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--name (cadena)

El nombre actualizado de la plantilla.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (cadena)

Descripción actualizada de la plantilla.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--params (TemplateConfig)

Los parámetros actualizados de la plantilla. Consulte los parámetros de la plantilla.

En su lugar, esta opción JSON puede proporcionarse configurando campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --params=@path/to/file.json.

Ejemplos

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

ibmcloud event-notifications template-delete

Elimina una plantilla utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado la plantilla.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 10 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la plantilla. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

-f, --force (booleano)

Forzar la ejecución del comando.

Ejemplo

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

ibmcloud event-notifications pre-defined-templates

Enumerar las plantillas predefinidas para una instancia de Event Notifications.

Si no se configura la opción --all-pages, el comando solo recupera una página de la colección.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--source (cadena)

El tipo de fuente de la plantilla predefinida. Obligatorio.

La longitud máxima es de 50 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--type (cadena)

El tipo de plantilla para la plantilla predefinida, en función del destino. Obligatorio.

La longitud máxima es de 50 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--limit (int64)

El límite de páginas para los resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

El desplazamiento para los resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de plantillas predefinidas.

Ejemplo

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

ibmcloud event-notifications pre-defined-template

Consigue los detalles de una plantilla predefinida utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que está configurada la plantilla predefinida.

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

Opciones de comando

--instance-id (cadena)
El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.
--id (cadena)
El identificador único de la plantilla predefinida. Obligatorio.

Ejemplo

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

Configuraciones de SMTP

Configuraciones SMTP IBM Cloud Event Notifications.

ibmcloud event-notifications smtp-configuration-create

Configurar SMTP para el envío de correo. Para obtener más información, consulta las configuraciones de SMTP.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name (cadena)

El nombre de la configuración SMTP. Obligatorio.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--domain (cadena)

El nombre de dominio para la configuración de SMTP. Obligatorio.

La longitud máxima es de 512 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--description (cadena)

Descripción de la configuración de SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Ejemplo

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

ibmcloud event-notifications smtp-configurations

Enumera todas las configuraciones SMTP para una instancia de Event Notifications.

Si no se configura la opción --all-pages, el comando solo recupera una página de la colección.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--limit (int64)

El límite de páginas para los resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

El desplazamiento para los resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de configuración de SMTP.

Ejemplo

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

ibmcloud event-notifications smtp-user-create

Crea un usuario SMTP para una configuración SMTP. Debe proporcionar el ID de la configuración SMTP y el ID de la instancia de Event Notifications.

Las credenciales SMTP solo se muestran una vez. Cópialos y guárdalos de forma segura, ya que no se podrán recuperar más adelante.

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

Opciones de comando

--instance-id (cadena)

El identificador único de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

El identificador único de la configuración SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--description (cadena)

Descripción del usuario SMTP.

La longitud máxima es de 250 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--username-to-clone (cadena)

El nombre de usuario del usuario SMTP que se va a clonar.

La longitud máxima es de 20 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /^[a-z0-9]{18}\\d{2}$/.

Ejemplo

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

ibmcloud event-notifications smtp-users

Enumerar todos los usuarios SMTP de una configuración SMTP.

Si la opción --all-pages no está activada, el comando solo recupera una página de la colección.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--limit (int64)

Límite de página para resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

Serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de los usuarios de SMTP.

Ejemplo

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

ibmcloud event-notifications smtp-configuration

Consulta los detalles de la configuración SMTP para una instancia de Event Notifications.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

Ejemplo

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

ibmcloud event-notifications smtp-configuration-update

Actualiza una configuración SMTP utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--name (cadena)

Nombre SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (cadena)

Descripción SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Ejemplo

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

ibmcloud event-notifications smtp-configuration-delete

Eliminar una configuración SMTP utilizando su ID. También debe proporcionar el ID de la instancia de Event Notifications para la que se ha configurado el SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

Ejemplo

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

ibmcloud event-notifications smtp-user

Obtenga información detallada sobre un usuario SMTP utilizando el ID de usuario y el ID de configuración SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--user-id (cadena)

UserID. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 5 caracteres. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

ibmcloud event-notifications smtp-user-update

Actualiza un usuario SMTP utilizando el ID de usuario y el ID de configuración SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--user-id (cadena)

UserID. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 5 caracteres. El valor debe coincidir con la expresión regular /.*/.

--description (cadena)

Descripción del usuario SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Ejemplo

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

ibmcloud event-notifications smtp-user-delete

Elimina un usuario SMTP utilizando el ID de usuario y el ID de configuración SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--user-id (cadena)

UserID. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 5 caracteres. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

ibmcloud event-notifications smtp-allowed-ips

Obtener todas las direcciones IP permitidas para una configuración SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

Ejemplo

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

ibmcloud event-notifications smtp-allowed-ips-update

El soporte para las listas de permitidos heredadas ha quedado obsoleto. La lista de permitidos ya está habilitada a través de las restricciones basadas en el contexto. Para obtener más información, consulta las configuraciones de SMTP.

ibmcloud event-notifications verify-smtp-update

Verifica la configuración SMTP del dominio para SPF, SKIM y en_authorization.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (cadena)

Identificador único para SMTP. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--type (cadena)

Tipo de verificación SMTP. Los valores permitidos son spf, dkim, y en_authorization. Obligatorio.

La longitud máxima es de 20 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

Métricas

ibmcloud event-notifications metrics

Obtener métricas de una instancia de Event Notifications.

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]

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--gte (cadena)

GTE (mayor que igual), fecha de inicio en UTC. Obligatorio.

La longitud máxima es de 28 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[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/.

--lte (cadena)

LTE (menos que igual), marca de tiempo final en UTC. Obligatorio.

La longitud máxima es de 28 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[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/.

--smtp-config-id (cadena)

ID de configuración de SMTP. Es obligatorio al consultar métricas de destinos de la interfaz SMTP.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--destination-type (cadena)

Tipo de destino para el que se solicitan las métricas. Valor admitido: smtp_custom. Es obligatorio al consultar métricas para destinos de correo electrónico personalizados.

Los valores permitidos son: smtp_custom.

--destination-id (cadena)

Identificador exclusivo del Destino.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--subscription-id (cadena)

Identificador exclusivo de la Suscripción.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--source-id (cadena)

Identificador exclusivo para el Origen.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--email-to (cadena)

Correo electrónico del receptor.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (cadena)

Notificación Id.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--subject (cadena)

asunto del correo electrónico.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

Ejemplo

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

Obtener métricas de rebote para una instancia de Event Notifications.

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]

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--gte (cadena)

Marca de tiempo de inicio mayor o igual que (GTE) en UTC. Obligatorio.

La longitud máxima es de 28 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[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/.

--lte (cadena)

Marca de tiempo de inicio Less than equal (LTE) en UTC. Obligatorio.

La longitud máxima es de 28 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[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/.

--smtp-config-id (cadena)

ID de configuración de SMTP. Es obligatorio al consultar métricas de destinos de la interfaz SMTP.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--destination-type (cadena)

Tipo de destino para el que se solicitan las métricas. Valor admitido: smtp_custom. Es obligatorio al consultar métricas para destinos de correo electrónico personalizados.

Los valores permitidos son: smtp_custom.

--destination-id (cadena)

Identificador exclusivo del Destino.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--subscription-id (cadena)

Identificador exclusivo de la Suscripción.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--source-id (cadena)

Identificador exclusivo para el Origen.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--email-to (cadena)

Dirección de correo electrónico del destinatario.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (cadena)

ID de notificación.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--subject (cadena)

asunto del correo electrónico.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--limit (int64)

Límite de página para resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

Ejemplo

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

Obtener el estado de las notificaciones

ibmcloud event-notifications notifications-status

Obtener el estado de la notificación de una notificación de prueba de destino de webhook.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

--id (cadena)

El ID de notificación que se devuelve al probar un destino de webhook. Este ID es específico para las notificaciones de prueba enviadas a destinos de webhook. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[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}/.

Ejemplo

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

Enviar notificaciones

Envía eventos desde tus aplicaciones de backend utilizando fuentes de API. Event Notifications admite dos modos de contenido CloudEvents:

  • Modo binario: los datos del evento se incluyen tal cual en el cuerpo de la solicitud HTTP, con el atributo datacontenttype que declara su tipo de medio en el Content-Type encabezado. El resto de atributos se asignan a encabezados de tipo HTTP precedidos por el prefijo ce-. Las solicitudes se tratan en modo binario cuando se pasan como encabezados los atributos obligatorios de CloudEvents (specversion, id, type, y source).
  • Modo estructurado: los metadatos y los datos del evento se incluyen en el cuerpo de la solicitud HTTP. Establece el encabezado Content-Type en application/cloudevents+json. Los atributos obligatorios (specversion, id, type, y source) deben figurar en el cuerpo de la solicitud. El campo datacontenttype es obligatorio y debe establecerse en application/json.

ibmcloud event-notifications send-notifications

Enviar una notificación desde una instancia del servicio. Para obtener más información sobre el contenido de la notificación, consulta la documentación.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--body (NotificationCreate)

Carga útil que describe una solicitud de creación de notificación.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --body=@path/to/file.json.

NotificationCreate

El siguiente ejemplo muestra el formato del objeto 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" : "{ }"
}

Ejemplo

Con los parámetros requeridos:

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"}'

Con todos los parámetros:

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": "{}"}'

Propiedades adicionales que se pueden configurar para la notificación de IOS

ajustes de la plataforma iOS
Propiedad Tipo de propiedad Descripción
badge integer El número a mostrar como identificador del icono de aplicación.
interactive_category string El identificador de categoría a utilizar para las notificaciones push interactivas.
ios_action_key string El título de la clave de acción.
payload Objeto JSON Carga útil JSON personalizada que se envía como parte del mensaje de notificación.
sound string El nombre del archivo de sonido del paquete de aplicación. El sonido de este archivo se reproduce como una alerta.
title_loc_key string La clave de una serie de título en el archivo Localizable.strings de la localización actual. La serie de la clave se puede formatear con especificadores %@ y %n$@ que serán sustituidos con las variables especificadas en la matriz titleLocArgs.
loc_key string Una clave para una serie alert-message en un archivo Localizable.strings para la localización actual (establecido por la preferencia de idioma del usuario). La serie de la clave se puede formatear con especificadores %@ y %n$@ que serán sustituidos con las variables especificadas en la matriz locArgs.
launch_image string El nombre de un archivo de imagen incluido en el paquete de la aplicación, con o sin la extensión del nombre de archivo. La imagen se utiliza como imagen de lanzamiento cuando los usuarios pulsan en el botón de acción o mueven el control deslizante de acción.
title_loc_args string Valores de cadena variables que aparecen en el lugar de los especificadores de formato en title-loc-key.
loc_args string Valores de serie variables que aparecen en lugar de los especificadores de formato en locKey.
title string El título de las notificaciones push completas (soportado únicamente en iOS 10 y superior).
subtitle string El subtítulo de las notificaciones completas (solo soportado en iOS 10 y superior).
body string El cuerpo para las notificaciones de iOS.
attachment_url string El enlace al soporte de las notificaciones iOS (vídeo, audio, GIF, imágenes - soportado únicamente en iOS 10 y superior).
type string Valores permitidos: DEFAULT, MIXED, SILENT.
apns_collapse_id string Varias notificaciones con el mismo identificador de contracción se muestran al usuario como una única notificación.
apns_thread_id string Un identificador específico de una app para agrupar notificaciones relacionadas. Este valor corresponde a la propiedad threadIdentifier del objeto UNNotificationContent.
apns_group_summary_arg string La serie que la notificación añade a la serie de formato de resumen de la categoría.
apns_group_summary_arg_count integer El número de elementos que la notificación añade a la serie de formato de resumen de la categoría.

Propiedades adicionales que se pueden configurar para la notificación de FCM

Ajustes de la plataforma Android
Propiedad Tipo de propiedad Descripción
icon string Especifica el nombre del icono a visualizar en la notificación. Asegúrese de que el icono ya está empaquetado con la aplicación de cliente.
delay_while_idle Boolean Cuando se establece en true, este parámetro indica que el mensaje no se debe enviar hasta que el dispositivo pase a estar activo.
sync Boolean La mensajería del grupo de dispositivos facilita que cada instancia de app de un grupo refleje el estado actualizado de mensajería.
visibility string privada o pública: visibilidad de esta notificación, lo que influye en cómo y cuándo se muestran las notificaciones en una pantalla de bloqueo segura.
redact string El contenido que se especifica aparece en una pantalla bloqueada segura en el dispositivo cuando la visibilidad se establece en Private.
payload Objeto JSON Carga útil JSON personalizada que se envía como parte del mensaje de notificación.
priority string Un valor de serie que indica la prioridad de esta notificación. Los valores permitidos son 'max', 'high', 'default', 'low' y 'min'. Las notificaciones de prioridad High/Max junto con el campo 'sound' se pueden utilizar para la notificación de Heads up en Android 5.0 o higher.sampleval='low'.
sound string El archivo de sonido (en el dispositivo) que se intentará reproducir cuando la notificación llegue al dispositivo.
time_to_live integer Especifica cuánto tiempo (en segundos) debe mantenerse el mensaje en el almacenamiento de GCM si el dispositivo está fuera de línea.
lights Establece el color del LED de notificación al recibir la notificación push.
ledArgb string El color del led. El hardware realiza la mejor aproximación posible.
ledOnMs integer El tiempo en milisegundos en que el LED estará encendido mientras parpadea. El hardware realiza la mejor aproximación posible.
ledOffMs string El tiempo en milisegundos en que el LED estará apagado mientras parpadea. El hardware realiza la mejor aproximación posible.
android_title string El título de las notificaciones push completas.
group_id string Establezca esta notificación para que forme parte de un grupo de notificaciones que comparten la misma clave. Las notificaciones agrupadas se pueden mostrar en un clúster o en una pila en dispositivos que dan soporte a dicha representación.
style Opciones que se pueden especificar para notificaciones expandibles de Android. Los tipos de notificaciones expandibles son picture_notification, bigtext_notification, inbox_notification.
type string Especifica el tipo de notificaciones expandible. Los valores posibles son bigtext_notification, picture_notification, inbox_notification.
title string Especifica el título de la notificación. El título se muestra cuando se expande la notificación. El título se debe especificar para las tres notificaciones expandibles.
type string Valores permitidos: DEFAULT, SILENT.
alert string El valor de alerta de Notificación.

Scripts de ejemplo

Puedes utilizar los siguientes scripts como ayuda para el desarrollo.

Script de ejemplo para el aprovisionamiento de Event Notifications mediante CLI

El script provision_event_notification.sh automatiza el aprovisionamiento y la configuración de una instancia de Event Notifications.

Script de ejemplo para la integración de notificaciones de plataforma mediante CLI

El script en-platform-notification-src-and-email-dest.sh integra las Notificaciones de Plataforma con Event Notifications y dirige las notificaciones a IBM Inbuilt Email o Custom Domain Sandbox.

Script de ejemplo para la integración de IBM Cloud Logs mediante CLI

El script en-icl-src-and-email-dest.sh integra IBM Cloud Logs con Event Notifications y dirige las notificaciones a IBM Inbuilt Email o Custom Domain Sandbox.

Este script asume que la instancia IBM Cloud Logs y la instancia Event Notifications están en la misma cuenta.