範例

• 以下範例顯示 iOS 目的地(push_ios) 使用 P8 憑證的 DestinationConfig 物件格式。 將 pre_prod Boolean 參數設定為 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)
      }
   }
   ```


- 以下範例顯示 iOS 目的地(push_ios) 使用 P12 憑證的 `DestinationConfig` 物件格式。 將 `pre_prod` Boolean 參數設定為 *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` Boolean 參數設定為 *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` Boolean 參數設定為 *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 目的地 `DestinationConfig` 物件的格式(push_safari)。 將 `pre_prod` Boolean 參數設定為 *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)
      }
   }
   ```

- 以下範例顯示 MS Teams(msteams) 目的地 `DestinationConfig` 物件的格式。

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


- 以下範例顯示 Huawei(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)
      }
   }
   ```

- 以下範例顯示 `DestinationConfig` 自訂電子郵件(smtp_custom) 目的地物件的格式。 如果是自訂電子郵件沙盒(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`，仍可建立自訂 SMS 收件端，但除非明確申請並設定所需的個人化號碼，否則該收件端將無法運作。 如需申請個人化號碼，請參閱「[自訂 SMS 個人化號碼](/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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 (字串)

目的地的唯一 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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 (字串)

目的地的唯一 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 事件通知實例的唯一 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}/`。

--id (字串)

目的地的唯一 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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 (字串)

目的地的唯一 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]/。

範例

• 以下範例顯示 Webhook SubscriptionCreateAttributes 物件的格式。

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

- 以下範例顯示 SMS `SubscriptionCreateAttributes` 物件的格式。

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

- 以下範例顯示 IBM Email `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 Destination 類型為 direct_message 的 `SubscriptionCreateAttributes` 物件格式。

```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 SMS 的 `SubscriptionUpdateAttributes` 物件格式。

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

- 以下範例顯示 IBM Email `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",
   }
   ```

- 以下範例顯示立即服務 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 字串選項，或透過提供一個以 @ 開頭的 filepath 選項，指定要從中讀取的 JSON 檔案，例如 --params=@path/to/file.json。

--description (字串)

範本說明。

最大長度為 255 個字元。 最小長度為 1 個字元。 值必須符合正規表達式 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/。

--params-body (字串)

模板正文。 此選項為 JSON 選項 'params' 的子欄位提供一個值。 它與該選項相互排斥。

最大長度為 20000 個字元。 最小長度為 1 個字元。 值必須符合正規表達式 /.*/。

--params-subject (字串)

範本主題。 此選項為 JSON 選項 'params' 的子欄位提供一個值。 它與該選項相互排斥。

最大長度為 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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 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}/`。

--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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 字串選項，或透過提供一個以 @ 開頭的 filepath 選項，指定要從中讀取的 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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 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}/`。

--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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 (字串)

目的地的唯一 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 (字串)

目的地的唯一 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 (字串)

來源的唯一 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 事件通知實例的唯一 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}/`。

--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 (字串)

目的地的唯一 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 (字串)

目的地的唯一 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 (字串)

來源的唯一 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 事件通知實例的唯一 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}/`。

--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 事件通知實例的唯一 ID。 必要。

 最大長度為 `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 字串選項，或透過提供一個以 @ 開頭的 filepath 選項，指定要從中讀取的 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 通知設定的其他屬性