UIで適用されたインテリジェンスの宛先 を管理することに加えて、NerdGraphAPIを使用できます。
ヒント NerdGraphの使用を開始するためのヘルプについては、NerdGraphの概要を 参照してください。
宛先のリストとフィルター destinations
クエリを使用すると、アカウントごとにすべての宛先をページ分割できます。また、いくつかのフィルタリング機能を許可します。
アカウントのすべての宛先を一覧表示する 次の例を見てみましょう。
account ( id : YOUR_ACCOUNT_ID ) {
カーソルページ付けを使用した宛先のページ付け 宛先をページ分割するには、最初のクエリでnextCursor
フィールドをリクエストする必要があります。
カーソルページネーションを使用すると、応答から返されるnextCursor
が空に戻るまで、結果セットを介して要求を続けます。これは、結果の最後に到達したことを意味します。
次の例を見てみましょう。
account ( id : YOUR_ACCOUNT_ID ) {
destinations ( cursor : "" ) {
上のコードは、次のような結果のセットを返します。
"nextCursor" : "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=" ,
"id" : "01c0cbe7-3d70-47c1-99e0-adf906eed6c2" ,
"name" : "Destination Name"
"id" : "05db0207-c137-4985-8cb5-f21e7e57b8cc" ,
"name" : "Another Destination Name"
そのため、その後のリクエストでは、カーソルが空になるまで、このようにカーソルを提供します。
account ( id : YOUR_ACCOUNT_ID ) {
destinations ( cursor : "" ) {
名前ですべての目的地を検索 APIは、名前による宛先クエリを許可します。name
フィルターは、完全一致と部分一致を返します。大文字と小文字は区別されません。これにより、指定された名前に一致する宛先の情報のみが返されます。
この例では、名前に"DevOps"
が含まれる宛先を検索します。
account ( id : YOUR_ACCOUNT_ID ) {
destinations ( filters : { name : "DevOps" } ) {
IDで目的地を探す APIを使用すると、宛先IDでクエリを実行できます。
account ( id : YOUR_ACCOUNT_ID ) {
destinations ( filters : { id : YOUR_DESTINATION_ID } ) {
タイプですべての目的地を検索 APIを使用すると、宛先タイプでクエリを実行できます。次のクエリは、選択したアカウントのすべての電子メールの宛先を返します。
account ( id : YOUR_ACCOUNT_ID ) {
destinations ( filters : { type : EMAIL } ) {
目的地を作成する 宛先を作成するには、宛先タイプごとに異なる入力を指定する必要があります。オプションのtwo_way_integration
プロパティは、双方向の統合を可能にする統合に使用できます。
アトラシアン Jira aiNotificationsCreateDestination ( accountId : YOUR_ACCOUNT_ID , destination : {
name : "Destination Name" ,
"password" : YOUR_PASSWORD
value : "https://YOUR_INSTANCE.atlassian.net"
key : "two_way_integration" ,
ServiceNow(インシデント・マネジメント) aiNotificationsCreateDestination ( accountId : YOUR_ACCOUNT_ID , destination : {
name : "Destination Name" ,
"password" : YOUR_PASSWORD
value : "https://YOUR_INSTANCE.service-now.com"
key : "two_way_integration" ,
スラック slackとの統合はOAuth2認証でのみ利用可能であるため、変更を使用して宛先を作成することはできません。
Webhook この例では、統合されるサービスに応じて、 auth
はオプションです。
aiNotificationsCreateDestination ( accountId : YOUR_ACCOUNT_ID , destination : {
name : "Destination Name" ,
"password" : YOUR_PASSWORD
key : "two_way_integration" ,
メール aiNotificationsCreateDestination (
accountId : YOUR_ACCOUNT_ID
properties : [ { key : "email" , value : YOUR_EMAIL } ]
AWS EventBridge aiNotificationsCreateDestination ( accountId : YOUR_ACCOUNT_ID , destination : {
name : "Destination Name" ,
"password" : YOUR_PASSWORD
value : YOUR_AWS_ACCOUNT_ID
PagerDutyには、サービスレベルとアカウントレベルの2種類の統合があります。詳細については、 PagerDutyIntegrationDocs を参照してください。
サービスレベル:
aiNotificationsCreateDestination (
accountId : YOUR_ACCOUNT_ID
type : PAGERDUTY_SERVICE_INTEGRATION
basic : { token : YOUR_INTEGRATION_TOKEN , prefix : "Token token=" }
アカウントレベル:
aiNotificationsCreateDestination (
accountId : YOUR_ACCOUNT_ID
type : PAGERDUTY_ACCOUNT_INTEGRATION
basic : { token : YOUR_API_KEY , prefix : "Token token=" }
properties : [ { key : "two_way_integration" , value : "true" } ]
宛先を更新する 宛先を更新するときは、宛先のすべての属性を指定する必要はないことに注意してください。たとえば、名前を更新するだけの場合は、名前を指定するだけで済みます。
aiNotificationsUpdateDestination (
accountId : YOUR_ACCOUNT_ID
destinationId : YOUR_destination_ID
destination : { name : "Updated destination Name" }
目的地のテスト NerdGraphAPIを介して宛先をテストできます。これは、宛先を作成する前または後に実行できます。
aiNotificationsTestDestination (
accountId : YOUR_ACCOUNT_ID
properties : [ { key : "email" , value : YOUR_EMAIL } ]
aiNotificationsTestDestinationById (
accountId : YOUR_ACCOUNT_ID
destinationId : YOUR_DESTINATION_ID
宛先を削除する NerdGraphAPIを介して宛先を削除できます。
aiNotificationsDeleteDestination (
accountId : YOUR_ACCOUNT_ID
destinationId : YOUR_DESTINATION_ID
重要 Entity type channel is in use
というエラー メッセージを受け取った場合は、続行する前に宛先で使用されているチャネルを特定し、それらを削除する必要があります。 これを行うには、まず宛先に関連付けられたすべてのチャネルを見つけてから、各チャネルを個別に削除します。
account ( id : YOUR_ACCOUNT_ID ) {
channels ( filters : { destinationId : YOUR_DESTINATION_ID } ) {
aiNotificationsDeleteChannel (
accountId : YOUR_ACCOUNT_ID
channelId : YOUR_CHANNEL_ID