示例

• 以下示例显示了带有 P8 证书的 iOS 目标（push_ios）的 DestinationConfig 对象的格式。 将布尔参数 pre_prod 设置为true，将目的地配置为预生产目的地，否则将值设置为 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)
      }
   }
   ```


- 以下示例显示了带有 P12 证书的 iOS 目标（push_ios）的 `DestinationConfig` 对象的格式。 将布尔参数 `pre_prod` 设置为 *true*，将目的地配置为预生产目的地；否则将值设置为 *false*。

```json
   {
      "params" : {
         "cert_type" : "p12",
         "is_sandbox" : true,
         "password": "apnspasswordvalue",
         "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- 以下示例显示了Chrome目标（push_chrome）的 `DestinationConfig` 对象的格式。 将布尔参数 `pre_prod` 设置为 *true*，将目的地配置为预生产目的地；否则将值设置为 *false*。

```json
   {
      "params" : {
         "api_key": "chromeapikey",
         "website_url" : "https://testwebsite.com",
         "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- 以下示例显示了 Firefox 目标（push_firefox）的 `DestinationConfig` 对象的格式。 将布尔参数 `pre_prod` 设置为 *true*，将目的地配置为预生产目的地；否则将值设置为 *false*。

```json
   {
      "params" : {
         "website_url" : "https://testwebsite.com",
         "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- 以下示例显示了Slack目标（slack）的 `DestinationConfig` 对象的格式，类型为incoming_webhook。

```json
   {
      "params" : {
         "type" : "incoming_webhook",
         "url" : "https://hooks.slack.com/services/G0gyhsush/TYodsjhs/GHTbfidsimkk"
      }
   }
   ```

- 以下示例显示了Slack目标（slack）中 `DestinationConfig` 对象的格式，类型为direct_message。

```json
   {
      "params" : {
         "type" : "direct_message",
         "token" : "vhdwvecwefwefewivcweivcwiwiciwcvwicwec"
      }
   }
   ```

- 以下示例显示了Safari目标（push_safari）的 `DestinationConfig` 对象的格式。 将布尔参数 `pre_prod` 设置为 *true*，将目的地配置为预生产目的地；否则将值设置为 *false*。

```json
   {
      "params": {
         "cert_type":"p12",
         "certificate_name":"Users/Testuser/Documents/safari.p12",
         "password":"safarinew",
         "url_format_string":"https://test.com",
         "website_name":"testwebsite",
         "website_push_id":"test",
         "website_url":"https://test.com",
         "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- 以下示例显示了 `DestinationConfig` 对象在MS Teams（msteams）目标中的格式。

```json
   {
      "params" : {
         "url" : "https://xyz.webhook.office.com"
      }
   }
   ```

- 以下示例显示了 PagerDuty(pagerduty ）目标的 `DestinationConfig` 对象的格式。

   建议在创建目的地时只使用路由键。 API 密钥已过时，今后将无法使用。
   {: attention}

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


- 以下示例显示了Webhook（webhook）的 `DestinationConfig` 对象的格式。

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

- 以下示例显示了Android（push_android）目标 `DestinationConfig` 对象的格式。

```json
   {
      "params" : {
         "project_id" : "6232305230320",
         "private_key" : "36e21epfweort823or8rt832pr8p2r832pr82pr382r8f",
         "client_email" : "testuser.123@gmail.com",
         "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```


- 以下示例显示了 ServiceNow(servicenow ）目标的 `DestinationConfig` 对象的格式。

```json
   {
      "params" : {
         "client_id" : "359705ceddd100eyfewyyw1f0f9e1c96",
         "client_secret": "testsecrets",
         "username": "testuser",
         "password": "user_password",
         "instance_name": "testinstancenje"
      }
   }
   ```

- 以下示例显示了 Code Engine （ibmce）目标的 `DestinationConfig` 对象的格式。

   代码 引擎 目的地 类型：应用程序

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

   代码 引擎 目的地 类型：工作

   ```json
   {
      "params" : {
         "type" : "job",
         "job_name" : "custom-job",
         "project_crn" : "crn:v1:bluemix:public:codeengine:us-south:a/e7e5820aeccb40efb78fd69a7858ef23:xxxxxxxxxxxxxx::"
      }
   }
   ```


- 以下示例显示了 IBM Cloud Object Storage （ibmcos）目标的 `DestinationConfig` 对象的格式。

```json
   {
      "params" : {
         "bucket_name" : "cos-destination-en-bucket",
         "instance_id" : "42e13636e-0548-41a0-a178-e95be28464773",
         "endpoint" : "https://s3.us-west.cloud-object-storage.appdomain.cloud"
      }
   }
   ```


- 以下示例显示了华为（push_huawei）目标地址的 `DestinationConfig` 对象的格式。

```json
   {
      "params" : {
         "client_id" : "359705ceddd100eyfew",
         "client_secret": "testsecrets",
         "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- 以下示例显示了自定义电子邮件（smtp_custom）目标的 `DestinationConfig` 对象的格式。 如果是自定义电子邮件沙盒（smtp_custom_sandbox）目标，则不需要目标配置参数。

   流程 进行自定义域名配置和验证：<https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify>

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

- 以下示例显示了 Event Streams （event_streams）目标的 `DestinationConfig` 对象的格式。

```json
   {
      "params" : {
        "crn": "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c13357373:a292db6e-af78-4c0b-b3db-7d6794b637g::",
        "endpoint": "https://n6627w6t7dgeh2cfgd.svc09.us-south.eventstreams.cloud.ibm.com",
        "topic": "demo_topic"
      }
   }
   ```

- 下面的示例显示了 App Configuration (app_configuration) 目的地 `DestinationConfig` 对象的格式。

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

注意：无需 `DestinationConfig` 即可创建自定义短信接收端，但在明确申请并配置所需的个性化号码之前，该接收端将无法正常工作。 如需申请个性化号码，请参阅 [“自定义短信个性化号码”](/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom#en-destinations-sms-custom-numbers)。

### ibmcloud 活动通知 目的地列表 {: #en-cli-destination-list-command}

- **操作：** 列出所有 `Destination`。

```sh {: pre}
ibmcloud event-notifications destinations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID

• 要提供的参数：

--limit LIMIT (int64)

分页结果的每页最大条数。

最大值为 100。 最小值为 1。

--offset OFFSET (int64)

分页结果的偏移量。

最小值为 0。

--search SEARCH （字符串）

用于筛选结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--instance-id （字符串）

IBM Cloud Event Notifications 实例的唯一标识符。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ 匹配。

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

目标的唯一标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

目标的唯一标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `32` 个字符。 最小长度为 `32` 个字符。 该值必须与正则表达式 `/[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 （字符串）

目标的唯一标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$/ 匹配。

--domain （字符串）

电子邮件域。 必需。

最大长度为 250 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /.*/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

目标的唯一标识。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

验证类型。 必需。

最大长度为 20 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-z]/ 匹配。

示例

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

示例

• 以下示例显示了定时器源代码中 TopicCreateSourcesItem[] 对象的格式。

    [
       {
          "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": "* * * * *"
                   }
             }
          ]
       }
    ]
   ```

- 以下示例展示了 `TopicCreateSourcesItem[]` 对象的格式。

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

- 以下示例展示了 `TopicUpdateSourcesItem[]` 对象的格式。

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

### ibmcloud 活动通知 主题列表 {: #en-cli-topic-list-command}

- **操作：** 列出所有 `Topic`。

```sh {: pre}
ibmcloud event-notifications topics [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID

• 要提供的参数：

--limit LIMIT (int64)

分页结果的每页最大条数。

最大值为 100。 最小值为 1。

--offset OFFSET (int64)

分页结果的偏移量。

最小值为 0。

--search SEARCH （字符串）

用于筛选结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--instance-id INSTANCE-ID （字符串）

IBM Cloud Event Notifications 实例的唯一标识符。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ 匹配。

示例

• 以下示例显示了用于网络挂钩的 SubscriptionCreateAttributes 对象的格式。

   {
      "signing_enabled" : true,
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13"
   }
   ```

- 以下示例显示了SMS中 `SubscriptionCreateAttributes` 对象的格式。

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

- 以下示例显示了 IBM `SubscriptionCreateAttributes` 对象的格式。

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
      "from_name":"ABC ORG"
   }
   ```

- 以下示例显示了Slack Destination类型为incoming_webhook的 `SubscriptionCreateAttributes` 对象的格式。

```json
   {
      "attachment_color" : "#FF0000",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

- 以下示例显示了Slack中 `SubscriptionCreateAttributes` 对象的格式，目标类型为direct_message。

```json
{
   "channels" : [{ "id": "GHIUIFJHGGH"},{"id": "TSFDIDFOFNF"}],
   "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}

• 以下示例显示了 ServiceNow 中 SubscriptionCreateAttributes 对象的格式。

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

- 以下示例显示了自定义电子邮件的 `SubscriptionCreateAttributes` 对象的格式。

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
   }
   ```
- 下面的示例显示了自定义电子邮件沙盒 `SubscriptionCreateAttributes` 对象的格式。

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
      "from_name":"ABC ORG",
      "from_email":"Testuser@mailx.com",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```
   - 以下示例显示了Pagerduty/ Event Streams 的 `SubscriptionCreateAttributes` 对象的格式。

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
   }
   ```
   - 下面的示例显示了 App Configuration 的 `SubscriptionCreateAttributes` 对象的格式。 在为目的地创建或更新订阅时 **App Configuration**`attributes` 对象有一个特定的规则：
      - 您必须**包括 **`feature_flag_enabled`**或者**`template_id_notification`
      - **不能**同时包含这两个属性

      这可确保为正确的使用场景创建订阅——无论是**功能开关评估**还是**通知模板生成**，但不会同时为两者创建订阅。

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

### ibmcloud 活动通知 订阅列表 {: #en-cli-subscription-list-command}

- **操作：** 列出所有 `Subscription`。

```sh {: pre}
ibmcloud event-notifications subscriptions [--offset OFFSET] [--limit LIMIT] [--search SEARCH] --instance-id INSTANCE-ID

• 要提供的参数：

--limit LIMIT (int64)

分页结果的每页最大条数。

最大值为 100。 最小值为 1。

--offset OFFSET (int64)

分页结果的偏移量。

最小值为 0。

--search SEARCH （字符串）

用于筛选结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--instance-id INSTANCE-ID （字符串）

IBM Cloud Event Notifications 实例的唯一标识符。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/ 匹配。

示例

• 以下示例显示了Webhook的 SubscriptionUpdateAttributes 对象的格式。

   {
      "signing_enabled": true
   }
   ```

- 以下示例显示了 IBM `SubscriptionUpdateAttributes` 对象的格式。

```json
   {
      "invited": {
         "add": ["+8xxxxxxxxxx"],
         "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
      },
      "subscribed": {
         "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
      },
      "unsubscribed": {
         "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
      }
   }
   ```

- 以下示例显示了 IBM `SubscriptionUpdateAttributes` 对象的格式。

```json
   {
      "invited": {
         "add": ["example1@gmail.com"],
         "remove": []
      },
      "subscribed": {
         "remove": ["example2@gmail.com"]
      },
      "unsubscribed": {
         "remove": ["example3@gmail.com"]
      },
      "reply_to_mail": "example@ibm.com",
      "reply_to_name": "USA news",
      "from_name": "IBM",
      "add_notification_payload": true
   }
   ```

- 以下示例显示了自定义电子邮件的 `SubscriptionUpdateAttributes` 对象的格式。

```json
   {
      "invited": {
         "add": ["example1@gmail.com"],
         "remove": []
      },
      "subscribed": {
         "remove": ["example2@gmail.com"]
      },
      "unsubscribed": {
         "remove": ["example3@gmail.com"]
      },
      "reply_to_mail": "example@ibm.com",
      "reply_to_name": "USA news",
      "from_name": "IBM",
      "from_email": "test@email.com",
      "add_notification_payload": true,
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```

- 下面的示例显示了自定义电子邮件沙盒 `SubscriptionUpdateAttributes` 对象的格式。

```json
   {
      "invited": {
         "add": ["example1@gmail.com"],
         "remove": []
      },
      "subscribed": {
         "remove": ["example2@gmail.com"]
      },
      "unsubscribed": {
         "remove": ["example3@gmail.com"]
      },
      "reply_to_mail": "example@ibm.com",
      "reply_to_name": "USA news",
      "add_notification_payload": true,
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```

- 以下示例显示了Slack中 `SubscriptionUpdateAttributes` 对象的格式，类型为 `incoming_webhook`。

```json
   {
      "attachment_color" : "#FF0000",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

- 以下示例显示了Slack中 `SubscriptionUpdateAttributes` 对象的格式，类型为 `direct_message`。

```json
   {
      "channels": [{"id": "D01CFDTYBH", "operation": "add"}, {"id": "D01GHUTYBH", "operation": "remove"}],
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

- 以下示例显示了Service Now中 `SubscriptionUpdateAttributes` 对象的格式。

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

   - 以下示例显示了Pagerduty/ Event Streams 的 `SubscriptionUpdateAttributes` 对象的格式。

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

   - 下面的示例显示了 App Configuration 的 `SubscriptionCreateAttributes` 对象的格式。 在为目的地创建或更新订阅时 **App Configuration**`attributes` 对象有一个特定的规则：
      - 您必须**包括 **`feature_flag_enabled`**或者**`template_id_notification`
      - **不能**同时包含这两个属性
               这可确保为正确的用例创建订阅——无论是**功能开关评估**还是**通知模板生成**，但不会同时为两者创建订阅。

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

## 集成 {: #en-cli-integration}

操作 IBM Cloud Event Notifications 集成。

### ibmcloud事件通知集成 创建 {: #en-cli-integration-create-command}

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

命令选项

--instance-id （字符串）

IBM Cloud Event Notifications 实例的唯一标识符。

 最大长度为 `36` 个字符。 最小长度为 `36` 个字符。 该值必须与正则表达式 `/[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 （字符串）

集成类型 collect_failed_events。

最大长度为 50 个字符。 最小长度为 1 个字符。 允许值为 collect_failed_events。

--metadata (IntegrationCreateAttributes)

更新集成方案

集成所需的元数据。

示例

• 以下示例展示了 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 事件通知 整合 替换 {: #en-cli-integration-update-command}

替换 `Integration`。

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

命令选项

--instance-id （字符串）

IBM Cloud Event Notifications 实例的唯一标识符。

 最大长度为 `36` 个字符。 最小长度为 `36` 个字符。 该值必须与正则表达式 `/[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 （字符串）

集成类型 KMS/hs-crypto（已废弃）。

最大长度为 50 个字符。 最小长度为 1 个字符。 允许的值是 KMS 和 collect_failed_events。 注意：hs-crypto 类型已被弃用。 不支持使用 hs-crypto 类型的新集成资源。

--metadata (IntegrationReplaceAttributes)

更新集成方案

集成所需的元数据。

--id （字符串）

集成的唯一标识符。 必需。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9-:_]*/ 匹配。

示例

• 下面的示例显示了 IntegrationReplaceAttributes kms 对象的格式。

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

### ibmcloud事件通知集成列表 {: #en-cli-integration-list-command}

列出所有 `Integrations`。

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

命令选项

--instance-id （字符串）

IBM Cloud Event Notifications 实例的唯一标识符。

 最大长度为 `36` 个字符。 最小长度为 `36` 个字符。 该值必须与正则表达式 `/[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)

分页结果的页面限制。

最大值为 100。 最小值为 1。

--offset (int64)

分页结果的偏移量。

最小值为 0。

--search （字符串）

用于过滤结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

命令选项

--instance-id （字符串）

IBM Cloud Event Notifications 实例的唯一标识符。

 最大长度为 `36` 个字符。 最小长度为 `36` 个字符。 该值必须与正则表达式 `/[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 （字符串）

集成的唯一标识符。 必需。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9-:_]*/ 匹配。

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

消息模板。 必需。

最大长度为 255 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

--type （字符串）

模板类型。 必需。

最大长度为 24 个字符。 最小长度为 22 个字符。 该值必须与正则表达式 /^(smtp_custom.notification|smtp_custom.invitation)$/ 匹配。

--params (TemplateConfig)

描述模板配置的有效载荷。 必需。

该JSON选项可以通过设置其他选项的单独字段来提供。 这些选项是相互排斥的。

提供一个JSON字符串选项，或通过提供一个以 @ 开头的文件路径选项来指定要读取的JSON文件，例如 --params=@path/to/file.json。

--description （字符串）

模板描述。

最大长度为 255 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

--params-body （字符串）

模板正文。 此选项为JSON选项“参数”的子字段提供值。 它与该选项互斥。

最大长度为 20000 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /.*/ 匹配。

--params-subject （字符串）

模板主题。 此选项为JSON选项“参数”的子字段提供值。 它与该选项互斥。

最大长度为 1000 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /.*/ 匹配。

示例

• 以下示例显示了电子邮件中 TemplateConfig 对象的格式。 支持的类型是 smtp_custom.notification|smtp_custom.invitation

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type smtp_custom.notification \
    --params '{"body": "exampleString", "subject": "exampleString"}' \
    --description exampleString

• 以下示例显示了Slack中 TemplateConfig 对象的格式。 支持的类型是 slack.notification。

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type slack.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString

• 以下示例显示了Webhook的 TemplateConfig 对象的格式。 支持的类型是 webhook.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type webhook.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString

• 以下示例显示了Pagerduty的 TemplateConfig 对象的格式。 支持的类型是 pagerduty.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type pagerduty.notification \
    --params '{"body": "ewogICJwYXlsb2FkIjogewogICAgInN1bW1hcnkiOiAie3sgZGF0YS5hbGVydF9kZWZpbml0aW9uLm5hbWV9fSIsCiAgICAidGltZXN0YW1wIjogInt7dGltZX19IiwKICAgICJzZXZlcml0eSI6ICJpbmZvIiwKICAgICJzb3VyY2UiOiAie3sgc291cmNlIH19IgogIH0sCiAgImRlZHVwX2tleSI6ICJ7eyBpZCB9fSIsCiAge3sjZXF1YWwgZGF0YS5zdGF0dXMgInRyaWdnZXJlZCJ9fQogICJldmVudF9hY3Rpb24iOiAidHJpZ2dlciIKICAge3svZXF1YWx9fQoKICB7eyNlcXVhbCBkYXRhLnN0YXR1cyAicmVzb2x2ZWQifX0KICAiZXZlbnRfYWN0aW9uIjogInJlc29sdmUiCiAge3svZXF1YWx9fQoKICAge3sjZXF1YWwgZGF0YS5zdGF0dXMgImFja25vd2xlZGdlZCJ9fQogICAiZXZlbnRfYWN0aW9uIjogImFja25vd2xlZGdlIgogICB7ey9lcXVhbH19Cn0="}' \
    --description exampleString

• 以下示例显示了 Event Streams 的 TemplateConfig 对象的格式。 支持的类型是 event_streams.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type event_streams.notification \
    --params '{"body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="}' \
    --description exampleString

• 下面的示例显示了 TemplateConfig 对象（ Code Engine Job）的格式。 支持的类型是 ibmcejob.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmcejob.notification\
    --params '{"body": "ewogInJ1bl9lbnZfdmFyaWFibGVzIjogWwogICB7ICJuYW1lIjogInJlZ2lvbiIsICJ2YWx1ZSI6ICJ7e2RhdGEucmVnaW9ufX0iLCJ0eXBlIjogImxpdGVyYWwifSwKeyJuYW1lIjoiVkFSMSIsInR5cGUiOiJsaXRlcmFsIiwidmFsdWUiOiJ7e2RhdGEudmFyMX19In0sCnsibmFtZSI6IlZBUjIiLCJ0eXBlIjoibGl0ZXJhbCIsInZhbHVlIjoie3tkYXRhLnZhcjJ9fSJ9Cl0KfQ=="}' \
    --description exampleString

• 下面的示例显示了 Code Engine Application/Function 的 TemplateConfig 对象格式。 支持的类型是 ibmceapp.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmceapp.notification\
    --params '{"body": "ewogICJ2YXIxIjogInt7ZGF0YS52YXIxfX0iLAogICJ2YXIyIjogInt7ZGF0YS52YXIyfX0iCn0="}' \
    --description exampleString

• 下面的示例显示了 App Configuration 的 TemplateConfig 对象的格式。 支持的类型是 app_configuration.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type app_configuration.notification\
    --params '{"body": "eyJlbmFibGVkIjogZmFsc2V9Cg=="}' \
    --description exampleString

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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)

分页结果的页面限制。

默认值为 10。 最大值为 100。 最小值为 1。

--offset (int64)

分页结果的偏移量。

默认值为 0。 最小值为 0。

--search （字符串）

用于过滤结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--all-pages （布尔值）

调用多个请求以显示模板集合中的所有页面。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `32` 个字符。 最小长度为 `32` 个字符。 该值必须与正则表达式 `/[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 （字符串）

模板的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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}/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

模板的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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 （字符串）

模板名。

最大长度为 255 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

--description （字符串）

模板描述。

最大长度为 255 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

--type （字符串）

模板类型。

最大长度为 24 个字符。 最小长度为 22 个字符。 该值必须与正则表达式 /^(smtp_custom.notification|smtp_custom.invitation)$/ 匹配。

--params (TemplateConfig)

描述模板配置的有效载荷。 该JSON选项可以通过设置其他选项的单独字段来提供。 这些选项是相互排斥的。

提供一个JSON字符串选项，或通过提供一个以 @ 开头的文件路径选项来指定要读取的JSON文件，例如 --params=@path/to/file.json。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

模板的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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}/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `32` 个字符。 最小长度为 `32` 个字符。 该值必须与正则表达式 `/[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 （字符串）

来源类型。 必需。

最大长度为 50 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /.*/ 匹配。

--type （字符串）

目标类型。 必需。

最大长度为 50 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /.*/ 匹配。

--limit (int64)

分页结果的页面限制。

默认值为 10。 最大值为 100。 最小值为 1。

--offset (int64)

分页结果的偏移量。

默认值为 0。 最小值为 0。

--search （字符串）

用于过滤结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--all-pages （布尔值）

调用多个请求，以显示预定义模板集合中的所有页面。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP配置的名称。 必需。

最大长度为 250 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

--domain （字符串）

域名。 必需。

最大长度为 512 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /.*/ 匹配。

--description （字符串）

SMTP 配置说明。

最大长度为 250 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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)

分页结果的页面限制。

默认值为 10。 最大值为 100。 最小值为 1。

--offset (int64)

分页结果的偏移量。

默认值为 0。 最小值为 0。

--search （字符串）

用于过滤结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--all-pages （布尔值）

调用多个请求以显示 smtp-configurations 集合的所有页面。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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 （字符串）

SMTP 配置说明。

最大长度为 250 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

--username-to-clone （字符串）

提供要克隆的用户名。

最大长度为 20 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /^[a-z0-9]{18}\\d{2}$/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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)

分页结果的页面限制。

默认值为 10。 最大值为 100。 最小值为 1。

--offset (int64)

分页结果的偏移量。

默认值为 0。 最小值为 0。

--search （字符串）

用于过滤结果的搜索字符串。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--all-pages （布尔值）

调用多个请求，以显示 smtp-users 集合的所有页面。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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}/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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 （字符串）

SMTP名称。

最大长度为 250 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

--description （字符串）

SMTP描述。

最大长度为 250 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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}/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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 （字符串）

UserID. 必需。

最大长度为 256 个字符。 最小长度为 5 个字符。 该值必须与正则表达式 /.*/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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 （字符串）

UserID. 必需。

最大长度为 256 个字符。 最小长度为 5 个字符。 该值必须与正则表达式 /.*/ 匹配。

--description （字符串）

SMTP用户描述。

最大长度为 250 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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 （字符串）

UserID. 必需。

最大长度为 256 个字符。 最小长度为 5 个字符。 该值必须与正则表达式 /.*/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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}/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

SMTP的唯一标识符。 必需。

最大长度为 32 个字符。 最小长度为 32 个字符。 该值必须与正则表达式 /[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 （字符串）

SMTP 验证类型。 必需。

最大长度为 20 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /.*/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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 （字符串）

GTE（大于等于），UTC时间戳。 必需。

最大长度为 28 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[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 （字符串）

LTE（小于等于），UTC时间戳。 必需。

最大长度为 28 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[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 （字符串）

SMTP 配置 ID。 查询 SMTP 接口目标的指标时，此参数为必填项。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

请求指标的目标类型。 支持的值：smtp_custom。 查询自定义电子邮件目标的指标时，此字段为必填项。

允许的取值范围为：smtp_custom。

--destination-id （字符串）

目标的唯一标识。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

预订的唯一标识。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

源的唯一标识。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9-:_]*/ 匹配。

--email-to （字符串）

收件人电子邮件ID。

最大长度为 256 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/ 匹配。

--notification-id （字符串）

通知编号

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

电子邮件主题。

最大长度为 256 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `32` 个字符。 最小长度为 `32` 个字符。 该值必须与正则表达式 `/[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 （字符串）

GTE（大于等于），UTC时间戳。 必需。

最大长度为 28 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[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 （字符串）

LTE（小于等于），UTC时间戳。 必需。

最大长度为 28 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[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 （字符串）

SMTP 配置 ID。 查询 SMTP 接口目标的指标时，此参数为必填项。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

请求指标的目标类型。 支持的值：smtp_custom。 查询自定义电子邮件目标的指标时，此字段为必填项。

允许的取值范围为：smtp_custom。

--destination-id （字符串）

目标的唯一标识。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

预订的唯一标识。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

源的唯一标识。

最大长度为 100 个字符。 最小长度为 1 个字符。 该值必须与正则表达式 /[a-zA-Z0-9-:_]*/ 匹配。

--email-to （字符串）

收件人电子邮件ID。

最大长度为 256 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/ 匹配。

--notification-id （字符串）

通知编号

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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 （字符串）

电子邮件主题。

最大长度为 256 个字符。 最小长度为 0 个字符。 该值必须与正则表达式 /[a-zA-Z0-9]/ 匹配。

--limit (int64)

分页结果的页面限制。

默认值为 10。 最大值为 100。 最小值为 1。

--offset (int64)

分页结果的偏移量。

默认值为 0。 最小值为 0。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `32` 个字符。 最小长度为 `32` 个字符。 该值必须与正则表达式 `/[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 （字符串）

测试 webhook 目标时返回的通知 ID。 此 ID 专用于发送到 webhook 接收端的测试通知。 必需。

最大长度为 36 个字符。 最小长度为 36 个字符。 该值必须与正则表达式 /[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}/ 匹配。

示例

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

命令选项

--instance-id （字符串）

IBM Cloud 事件通知实例的唯一标识。 必需。

 最大长度为 `256` 个字符。 最小长度为 `10` 个字符。 该值必须与正则表达式 `/[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)

有效载荷描述通知创建请求。

提供一个JSON字符串选项，或通过提供一个以 @ 开头的文件路径选项来指定要读取的JSON文件，例如 --body=@path/to/file.json。

示例

带必填参数：

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

包含所有参数：

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

iOS可配置的其他属性

可配置的FCM通知附加属性