NerdGraph チュートリアル: アラートの送信先

UIで集計先を管理するだけでなく、NerdGraph APIを使用することもできます。

ヒント

NerdGraphの使用を開始するためのヘルプについては、NerdGraphの概要を参照してください。

宛先のリストとフィルター

destinationsクエリを使用すると、アカウントごとにすべての宛先をページ分割できます。また、いくつかのフィルタリング機能を許可します。

次の例を見てみましょう。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations {
          entities {
            id
            name
          }
          error {
            details
          }
        }
      }
    }
  }
}

宛先をページ分割するには、最初のクエリでnextCursorフィールドをリクエストする必要があります。

カーソルページネーションを使用すると、応答から返されるnextCursorが空に戻るまで、結果セットを介して要求を続けます。これは、結果の最後に到達したことを意味します。

次の例を見てみましょう。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
          }
          totalCount
        }
      }
    }
  }
}

上のコードは、次のような結果のセットを返します。

{
  "data": {
    "actor": {
      "account": {
        "aiNotifications": {
          "destinations": {
            "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=",
            "entities": [
              {
                "id": "01c0cbe7-3d70-47c1-99e0-adf906eed6c2",
                "name": "Destination Name"
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name"
              }
              // ... more destinations here in reality
            ],
            "totalCount": 807
          }
        }
      }
    }
  }
}

そのため、その後のリクエストでは、カーソルが空になるまで、このようにカーソルを提供します。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
          }
          totalCount
        }
      }
    }
  }
}

APIは、名前による宛先クエリを許可します。nameフィルターは、完全一致と部分一致を返します。大文字と小文字は区別されません。これにより、指定された名前に一致する宛先の情報のみが返されます。

この例では、名前に"DevOps"が含まれる宛先を検索します。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { name: "DevOps" }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

APIを使用すると、宛先IDでクエリを実行できます。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { id: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

APIを使用すると、宛先タイプでクエリを実行できます。次のクエリは、選択したアカウントのすべての電子メールの宛先を返します。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { type: EMAIL }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

目的地を作成する

宛先を作成するには、宛先タイプごとに異なる入力を指定する必要があります。オプションのtwo_way_integrationプロパティは、双方向の統合を可能にする統合に使用できます。

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: JIRA,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_EMAIL,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "url",
        value: "https://YOUR_INSTANCE.atlassian.net"
      },
      {
        key: "two_way_integration",
        value: "true"
      }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: SERVICE_NOW,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_EMAIL,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "url",
        value: "https://YOUR_INSTANCE.service-now.com"
      },
     {
       key: "two_way_integration",
       value: "true"
     }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

この例では、統合されるサービスに応じて、 authはオプションです。

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: WEBHOOK,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_EMAIL,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "url",
        value: YOUR_WEBHOOK
      },
     {
       key: "two_way_integration",
       value: "true"
     }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(accountId: YOUR_ACCOUNT_ID, destination: {
    type: EVENT_BRIDGE,
    name: "Destination Name",
    auth: {
      type: BASIC,
      basic: {
        "user": YOUR_IAM_USER,
        "password": YOUR_PASSWORD
      }
    },
    properties: [
      {
        key: "AWSAccountId",
        value:  YOUR_AWS_ACCOUNT_ID
      },
      {
        key: "AWSRegion",
        value:  YOUR_AWS_REGION
      }
    ]
  }) {
    destination {
      id
      name
    }
  }
}

PagerDutyには、サービスレベルとアカウントレベルの2種類の統合があります。詳細については、 PagerDutyIntegrationDocsを参照してください。

サービスレベル：

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: PAGERDUTY_SERVICE_INTEGRATION
      name: "Destination Name"
      auth: {
        type: TOKEN
        basic: { token: YOUR_INTEGRATION_TOKEN, prefix: "Token token=" }
      }
      properties: []
    }
  ) {
    destination {
      id
      name
    }
  }
}

アカウントレベル：

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: PAGERDUTY_ACCOUNT_INTEGRATION
      name: "Destination Name"
      auth: {
        type: TOKEN
        basic: { token: YOUR_API_KEY, prefix: "Token token=" }
      }
      properties: [{ key: "two_way_integration", value: "true" }]
    }
  ) {
    destination {
      id
      name
    }
  }
}

宛先を更新する

宛先を更新するときは、宛先のすべての属性を指定する必要はないことに注意してください。たとえば、名前を更新するだけの場合は、名前を指定するだけで済みます。

mutation {
  aiNotificationsUpdateDestination(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_destination_ID
    destination: { name: "Updated destination Name" }
  ) {
    destination {
      id
      name
    }
  }
}

目的地のテスト

NerdGraphAPIを介して宛先をテストできます。これは、宛先を作成する前または後に実行できます。

mutation {
  aiNotificationsTestDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    error {
      details
    }
    details
    result
  }
}

mutation {
  aiNotificationsTestDestinationById(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_DESTINATION_ID
  ) {
    error {
      details
    }
    details
    result
  }
}

宛先を削除する

NerdGraphAPIを介して宛先を削除できます。

mutation {
  aiNotificationsDeleteDestination(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_DESTINATION_ID
  ) {
    ids
    error {
      details
    }
  }
}

重要

Entity type channel is in useというエラーメッセージを受け取った場合は、続行する前に宛先で使用されているチャネルを特定し、それらを削除する必要があります。これを行うには、まず宛先に関連付けられたすべてのチャネルを見つけてから、各チャネルを個別に削除します。

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        channels(filters: { destinationId: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

mutation {
  aiNotificationsDeleteChannel(
    accountId: YOUR_ACCOUNT_ID
    channelId: YOUR_CHANNEL_ID
  ) {
    ids
    error {
      details
    }
  }
}

この機械翻訳は、参考として提供されています。

NerdGraph チュートリアル: アラートの送信先

ヒント

宛先のリストとフィルター

アカウントのすべての宛先を一覧表示する

カーソルページ付けを使用した宛先のページ付け

名前ですべての目的地を検索

IDで目的地を探す

タイプですべての目的地を検索

目的地を作成する

アトラシアン Jira

ServiceNow（インシデント・マネジメント）

スラック

Webhook

メール

AWS EventBridge

PagerDuty

宛先を更新する

目的地のテスト

宛先を削除する

重要

この機械翻訳は、参考として提供されています。

NerdGraph チュートリアル: アラートの送信先

ヒント

宛先のリストとフィルター .css-21sua1{background:none;border:none;width:0;padding:0;}

カーソルページ付けを使用した宛先のページ付け

名前ですべての目的地を検索

IDで目的地を探す

タイプですべての目的地を検索

目的地を作成する

アトラシアン Jira

ServiceNow（インシデント・マネジメント）

スラック

Webhook

メール

AWS EventBridge

PagerDuty

宛先を更新する

目的地のテスト

宛先を削除する

重要

宛先のリストとフィルター