クロスアカウントの宛先を管理する

プレビュー

この機能はまだ開発中ですが、ぜひお試しください。

この機能は現在、弊社のプレリリースポリシーに従ってプレビュープログラムの一部として提供されています。

NerdGraph APIを使用してcross account destinationsを作成、テスト、一覧表示、更新、削除します。Cross account destinations組織レベルで通知管理を一元化できます。

目的地を作成する

宛先を作成するには、宛先の種類ごとに異なる入力情報を提供する必要があります。

重要

宛先がどこに作成されるかを指定するスコープオブジェクトを指定する必要があります。スコープオブジェクトには以下が必要です。

id: アカウントまたは組織のID。
タイプ：スコープの種類（アカウントまたは組織）。
オプションの two_way_integration プロパティは、双方向統合を可能にする統合に使用できます。

aiNotificationsCreateDestinationミューテーションを使用して、New Relic アラートから課題を作成および管理するために、Atlassian Jira インスタンスと統合する Jira 宛先を作成します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が作成される範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination.type`	イナム	（必須）Atlassian Jira の宛先の場合は`JIRA`ある必要があります。
`destination.name`	弦	（必須）Jiraの宛先を表す分かりやすい名前。
`destination.auth`	オブジェクト	(必須) Jira インスタンスに接続するための認証設定。
`destination.auth.type`	イナム	(必須) ユーザー名とパスワード/ API認証を使用した Jira 統合の場合は、 `BASIC`ある必要があります。
`destination.auth.basic`	オブジェクト	(必須) Jira 認証資格情報 (電子メールとパスワード/ APIウイルス) が含まれます。
`destination.auth.basic.user`	弦	（必須）Jiraアカウントのメールアドレス。
`destination.auth.basic.password`	弦	(必須) Jira アカウントのパスワードまたはAPIパスワード。セキュリティのため、アカウントのパスワードの代わりにAPIパスワードを使用してください。
`destination.properties`	オブジェクトの配列	(必須) Jira インスタンス URL と統合オプションを含む設定プロパティ。
`destination.properties[].key: "url"`	弦	(必須) キー「url」と値が Jira インスタンス URL (例: 「 https://yourcompany.atlassian.net 」) に設定されたプロパティを含める必要があります。
`destination.properties[].key: "two_way_integration"`	弦	(オプション) New Relicと Jira 間の双方向統合を有効にするには、「true」に設定します。

アカウントと組織に関するクエリ例：

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

組織に関するクエリ例：

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ORGANIZATION_ID, type: ORGANIZATION }
    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
      scope {
        id
        type
      }
    }
  }
}

aiNotificationsCreateDestinationミューテーションを使用して、通知アラートをメールアドレスに送信するメール送信先を作成します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が作成される範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination.type`	イナム	（必須）メール送信先の場合は`EMAIL`指定する必要があります。
`destination.name`	弦	（必須）メール送信先の分かりやすい名前。
`destination.properties`	オブジェクトの配列	(必須) メール設定を含むキーの値のペア。対象の電子メールアドレスを値として持つ`email`キーを含める必要があります。

サンプルクエリ:

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

aiNotificationsCreateDestinationミューテーションを使用して、アラートがトリガーされたときに HTTP POST requests外部エンドポイントに送信するための Webhook 宛先を作成します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が作成される範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination.type`	イナム	（必須）Webhookの宛先には`WEBHOOK`する必要があります。
`destination.name`	弦	（必須）Webhookの宛先を表す分かりやすい名前。
`destination.auth`	オブジェクト	（オプション）認証設定。ウェブフックのエンドポイントが認証を必要とする場合にのみ必要です。
`destination.auth.type`	イナム	（認証情報が提供されている場合に必須）認証方法。オプション: `BASIC` 、 `TOKEN` 。
`destination.auth.basic`	オブジェクト	(BASIC およびウイルス認証に必要) ユーザー名/パスワードまたはウイルス情報などの認証資格情報が含まれます。
`destination.properties`	オブジェクトの配列	(必須) Webhook 設定を含むキーの値のペア。 Webhook エンドポイント URL には`url`キーを含める必要があります。双方向通信の場合は、オプションの`two_way_integration`指定します。

サンプルクエリ:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

aiNotificationsCreateDestinationミューテーションを使用して、統合キーを使用して特定のPagerDutyサービスと統合するPagerDutyサービスレベル宛先を作成します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が作成される範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination.type`	イナム	（必須）PagerDuty サービスレベルの宛先の場合は`PAGERDUTY_SERVICE_INTEGRATION`ある必要があります。
`destination.name`	弦	（必須）PagerDutyサービスの宛先を表す分かりやすい名前。
`destination.auth`	オブジェクト	(必須) PagerDutyインテグレーションキーを含む認証設定。
`destination.auth.type`	イナム	(必須) PagerDutyサービス統合の場合は`TOKEN`ある必要があります。
`destination.auth.basic`	オブジェクト	(必須) PagerDuty認証用の統合 Windows とプレフィックスが含まれます。
`destination.auth.basic.token`	弦	(必須) PagerDutyサービス設定から取得したPagerDutyインテグレーションキー。
`destination.auth.basic.prefix`	弦	(必須) PagerDutyサービス統合の場合は`"Token token="`ある必要があります。
`destination.properties`	オブジェクトの配列	（オプション）追加の設定プロパティ。基本サービス統合の場合は空の配列にすることができます。

サンプルクエリ:

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

aiNotificationsCreateDestinationミューテーションを使用して、 APIキーを使用してPagerDutyアカウント全体と統合するPagerDutyアカウントレベルの宛先を作成し、より広範なインシデント管理機能を可能にします。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が作成される範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination.type`	イナム	（必須）PagerDutyアカウントレベルの宛先の場合は`PAGERDUTY_ACCOUNT_INTEGRATION`ある必要があります。
`destination.name`	弦	（必須）PagerDutyアカウントの宛先を示す分かりやすい名前。
`destination.auth`	オブジェクト	（必須）PagerDutyアカウントのAPIキーを含む認証設定。
`destination.auth.type`	イナム	(必須) PagerDutyアカウント統合の場合は`TOKEN`ある必要があります。
`destination.auth.basic`	オブジェクト	(必須) PagerDutyアカウント認証用のAPIとプレフィックスが含まれます。
`destination.auth.basic.token`	弦	（必須）PagerDutyアカウント設定から取得したPagerDutyアカウントAPIキー。
`destination.auth.basic.prefix`	弦	(必須) PagerDutyアカウント統合の場合は`"Token token="`ある必要があります。
`destination.properties`	オブジェクトの配列	(オプション) アカウント統合のプロパティを設定します。共通プロパティ: `two_way_integration`双方向通信のために「true」に設定されます。

サンプルクエリ:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: PAGERDUTY_ACCOUNT_INTEGRATION
      name: "Global PagerDuty Account"
      auth: {
        type: TOKEN
        basic: { token: YOUR_API_KEY, prefix: "Token token=" }
      }
      properties: [{ key: "two_way_integration", value: "true" }]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

New RelicでクロスアカウントのSlack宛先を作成するには、 NerdGraph APIとSlack間のOAuth認証が必要です。以下の手順では、認証URLを生成して設定を完了する方法を説明します。

OAuth URLを生成する

NerdGraph Explorerを開き、次のクエリをクエリエディタに貼り付けます。このクエリは、組織固有のSlack OAuth URLを生成します。

{
  actor {
    organization {
      aiNotifications {
        oAuthUrl(type: SLACK) {
          url
          transactionId
          error {
            description
            details
            type
          }
        }
      }
    }
  }
}

エクスプローラー上部のPlay (Execute Query)をクリックしてください。

認証リンクにアクセスしてください

クエリが実行されると、画面右側にURLを含むJSONレスポンスが表示されます。
レスポンス内のurlフィールドを探してください。
URL文字列全体（引用符で囲まれた部分すべて）をコピーしてください。
ブラウザで新しいタブを開き、URLを貼り付けてください。

Slackの認証を完了する

このリンクをクリックすると、Slackの認証ページに移動します。
プロンプトの場合は、接続する Slack ワークスペースにサインインします。
New Relicが要求する権限を確認してください。
接続を承認するには、 Allowをクリックしてください。
New Relicの「成功」ページにリダイレクトされるはずです。

目的地を確認する

OAuth認証が成功すると、宛先は組織レベルで自動的に作成され、組織内のすべてのアカウントで利用できるようになります。

one.newrelic.com > Alerts > Destinationsに移動します。
Destinationsリストに、先ほど認証した Slack ワークスペースの新しいエントリが表示されているはずです。

aiNotificationsCreateDestinationミューテーションを使用して、ServiceNow インスタンスと統合し、New Relic アラートからインシデントを作成および管理するための ServiceNow 宛先を作成します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が作成される範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination.type`	イナム	（必須）ServiceNowの宛先の場合は`SERVICE_NOW`ある必要があります。
`destination.name`	弦	（必須）ServiceNowの宛先を表す分かりやすい名前。
`destination.auth`	オブジェクト	(必須) ServiceNow インスタンスに接続するための認証設定。
`destination.auth.type`	イナム	(必須) ユーザー名とパスワードの認証を使用した ServiceNow 統合の場合は、 `BASIC`ある必要があります。
`destination.auth.basic`	オブジェクト	（必須）ServiceNowの認証情報（ユーザー名とパスワード）が含まれます。
`destination.auth.basic.user`	弦	（必須）ServiceNowアカウントのユーザー名またはメールアドレス。
`destination.auth.basic.password`	弦	（必須）ServiceNowアカウントのパスワード。セキュリティ強化のため、サービスアカウントのご利用をご検討ください。
`destination.properties`	オブジェクトの配列	(必須) ServiceNow インスタンス URL と統合オプションを含む設定プロパティ。
`destination.properties[].key: "url"`	弦	(必須) キー「url」と値が ServiceNow インスタンス URL (例: 「 https://yourcompany.service-now.com 」) に設定されたプロパティを含める必要があります。
`destination.properties[].key: "two_way_integration"`	弦	(オプション) New Relicと ServiceNow 間の双方向統合を有効にするには、「true」に設定します。

サンプルクエリ:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

aiNotificationsCreateDestinationミューテーションを使用して、 AWSエコシステム内でさらなる処理とルーティングを行うためにNew RelicまとめイベントをAWS EventBridge に送信するAWS EventBridge 宛先を作成します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が作成される範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination.type`	イナム	（必須）AWS EventBridge の宛先の場合は`EVENT_BRIDGE`ある必要があります。
`destination.name`	弦	（必須）AWS EventBridgeの宛先を表す分かりやすい名前。
`destination.auth`	オブジェクト	（必須）IAM認証情報を使用してAWS EventBridgeに接続するための認証設定。
`destination.auth.type`	イナム	(必須) IAM ユーザー認証情報を使用したAWS EventBridge 統合の場合は、 `BASIC`ある必要があります。
`destination.auth.basic`	オブジェクト	（必須）AWS IAM認証情報（アクセスキーIDとシークレットアクセスキー）が含まれています。
`destination.auth.basic.user`	弦	（必須）AWS IAMアクセスキーID。IAM ユーザーに EventBridge 権限があることを確認してください。
`destination.auth.basic.password`	弦	（必須）AWS IAMシークレットアクセスキー。この情報は安全に保管し、可能な場合はIAMロールの使用を検討してください。
`destination.properties`	オブジェクトの配列	（必須）EventBridgeのAWSアカウントIDとリージョンを含む設定プロパティ。
`destination.properties[].key: "AWSAccountId"`	弦	（必須）キーが「AWSAccountId」で、値がAWSアカウントID（12桁の数字）に設定されたプロパティを含める必要があります。
`destination.properties[].key: "AWSRegion"`	弦	（必須）キーが「AWSRegion」で、値がAWSリージョン（例：「us-east-1」、「eu-west-1」）に設定されたプロパティを含める必要があります。

サンプルクエリ:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

クロスアカウントの宛先をテストする

cross account destinations作成前でも作成後でもテストできます。スコープオブジェクトを指定する必要があります。

作成前に宛先設定をテストするには、 aiNotificationsTestDestinationミューテーションを使用します。これにより、実際に宛先を作成することなく、設定と認証情報を検証できます。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）テストの範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destination`	オブジェクト	（必須）テスト対象の宛先設定オブジェクト。タイプ、名前、認証情報、プロパティなどが含まれます。
`destination.type`	イナム	（必須）テスト対象の宛先タイプ。オプション: `EMAIL` 、 `WEBHOOK` 、 `PAGERDUTY_SERVICE_INTEGRATION` 、 `PAGERDUTY_ACCOUNT_INTEGRATION` 、 `SLACK` 、 `JIRA` 、 `SERVICE_NOW` 、 `EVENT_BRIDGE` 。
`destination.name`	弦	（必須）テスト対象の宛先の名前。
`destination.auth`	オブジェクト	（オプション）認証情報が必要な宛先に対する認証設定。WEBHOOK、PagerDuty、JIRA、SERVICE_NOW、およびEVENT_BRIDGEへの送信に必要です。
`destination.properties`	オブジェクトの配列	(必須) URL、電子メールアドレス、統合オプションなどの宛先固有の設定を構成するキーの値のペア。

サンプルクエリ:

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

既存の宛先をそのIDでテストするには、 aiNotificationsTestDestinationByIdミューテーションを使用します。これにより、宛先が正しく設定されており、通知を正常に配信できることが検証されます。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が存在する範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destinationId`	弦	（必須）テスト対象の既存の宛先の一意の識別子。このIDは、目的地を作成する際に返されるか、目的地の一覧表示によって確認できます。

サンプルクエリ:

mutation {
  aiNotificationsTestDestinationById(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
  ) {
    error {
      details
    }
    details
    result
  }
}

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

destinationsクエリを使用すると、アカウントレベルと組織レベルの両方で、すべての宛先をページ分割して表示できます。また、 cross account destinationsのフィルタリング機能も提供します。

actor.organization.aiNotifications.destinationsクエリを使用して、組織レベルのすべての宛先を取得します。これには、組織内のすべてのアカウントで使用できるcross account destinationsも含まれます。

入力

この文章ではGraphQL actor.organizationコンテキストを使用しており、明示的な入力は必要ありません。このクエリは、組織レベルでアクセス可能なすべての宛先を自動的に返します。

クエリフィールド	データ型	説明
`actor`	オブジェクト	認証済みユーザーのコンテキストを表すルートクエリオブジェクト。
`organization`	オブジェクト	組織レベルのリソースとcross account destinationsへのアクセスを提供する組織コンテキスト。
`aiNotifications`	オブジェクト	通知関連リソースにアクセスするための AI 通知サービスコンテキスト。
`destinations`	オブジェクト	組織レベルでアクセス可能なすべての宛先を返すクエリフィールド (cross account destinationsを含む)。

サンプルクエリ:

{
  actor {
    organization {
      aiNotifications {
        destinations {
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          error {
            details
          }
        }
      }
    }
  }
}

actor.account.aiNotifications.destinationsクエリを使用して、アカウントスコープの宛先と、そのアカウントで使用可能なcross account destinationsの両方を含む、特定のアカウントからアクセス可能なすべての宛先を取得します。

入力

問題の名前	データ型	説明
`account.id`	文字列/ID	（必須）宛先を取得する特定のアカウントID。このアカウントは、認証されたユーザーがアクセスできる必要があります。

クエリフィールド

クエリフィールド	データ型	説明
`actor`	オブジェクト	認証済みユーザーのコンテキストを表すルートクエリオブジェクト。
`account`	オブジェクト	アカウント固有のリソースへのアクセスを提供するアカウントコンテキストと、このアカウントで利用可能なcross account destinations 。
`aiNotifications`	オブジェクト	通知関連リソースにアクセスするための AI 通知サービスコンテキスト。
`destinations`	オブジェクト	指定されたアカウントからアクセス可能なすべての宛先（アカウントスコープと組織スコープの両方）を返すクエリフィールド。

サンプルクエリ:

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

カーソルページネーションを使用すると、多数の目的地を効率的にナビゲートできます。ページネーションを有効にするには、クエリでnextCursorフィールドを指定する必要があります。

入力

問題の名前	データ型	説明
`account.id`	文字列/ID	（必須）宛先を取得する特定のアカウントID。このアカウントは、認証されたユーザーがアクセスできる必要があります。
`destinations.cursor`	弦	（オプション）ページネーション用のカーソル。最初の要求には空の文字列`""`を使用し、その後、以前の応答から取得した`nextCursor`値を使用して後続のページを取得します。

ページネーションワークフロー

カーソルページネーションでは、レスポンスから返されるnextCursorが空になるまで、結果セットに対してrequestsを続けます。これは、検索結果のすべてを表示し終えたことを意味します。

アカウントの例を以下に示します（組織にも同じロジックが適用されます）。

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

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

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

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

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(
          cursor: "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
        ) {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

組織の別の例を挙げます

{
  actor {
    organization {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

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

{
  "data": {
    "actor": {
      "organization": {
        "aiNotifications": {
          "destinations": {
            "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=",
            "entities": [
              {
                "id": "01c0cbe7-3d70-47c1-99e0-adf906eed6c2",
                "name": "Destination Name",
                "scope": {
                  "type": "ORGANIZATION",
                  "id": "01ddcbe7-3d70-47c1-99e0-adf906eed6c2"
                }
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name",
                "scope": {
                  "type": "ORGANIZATION",
                  "id": "01ddcbe7-3d70-47c1-99e0-adf906eed6c2"
                }
              }
            ],
            "totalCount": 807
          }
        }
      }
    }
  }
}

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

{
  actor {
    organization {
      aiNotifications {
        destinations(
          cursor: "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
        ) {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

名前による絞り込み検索を使用して、目的地を名前で検索できます。名前フィルターは完全一致と部分一致の両方をサポートし、大文字と小文字を区別しません。

入力

問題の名前	データ型	説明
`account.id`	文字列/ID	（必須）宛先を取得する特定のアカウントID。このアカウントは、認証されたユーザーがアクセスできる必要があります。
`destinations.filters`	オブジェクト	（必須）結果を絞り込むためのフィルター条件オブジェクト。
`destinations.filters.name`	弦	（必須）宛先名で絞り込みます。部分一致に対応しており、大文字と小文字を区別しません。指定された文字列を含む名前の宛先を返します。

サンプルクエリ:

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

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

IDフィルタリングを使用して、一意の識別子によって特定の宛先を取得します。このフィルターは完全一致のみを返します。

入力

問題の名前	データ型	説明
`account.id`	文字列/ID	（必須）宛先を取得する特定のアカウントID。このアカウントは、認証されたユーザーがアクセスできる必要があります。
`destinations.filters`	オブジェクト	（必須）取得先の正確な場所を指定するためのフィルタ条件オブジェクト。
`destinations.filters.id`	弦	（必須）宛先IDでフィルタリングします。指定されたアカウントからアクセス可能で、かつ存在する場合、完全に一致するIDを持つ宛先を返します。

サンプルクエリ:

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

特定のタイプの宛先を取得するには、タイプフィルタリングを使用します。このフィルターは、指定された宛先タイプに一致するすべての宛先を返します。

入力

問題の名前	データ型	説明
`account.id`	文字列/ID	（必須）宛先を取得する特定のアカウントID。このアカウントは、認証されたユーザーがアクセスできる必要があります。
`destinations.filters`	オブジェクト	（必須）宛先タイプで結果を絞り込むためのフィルター条件オブジェクト。
`destinations.filters.type`	イナム	（必須）宛先タイプで絞り込みます。有効な値: `EMAIL` 、 `WEBHOOK` 、 `PAGERDUTY_SERVICE_INTEGRATION` 、 `PAGERDUTY_ACCOUNT_INTEGRATION` 、 `SLACK` 、 `JIRA` 、 `SERVICE_NOW` 、 `EVENT_BRIDGE` 。

サンプルクエリ:

以下のクエリを実行すると、選択したアカウントのすべてのメール送信先が返されます。

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

クロスアカウントの宛先を更新する

既存のcross-account destinationを更新するには、組織スコープと宛先IDを指定する必要があります。

既存のcross-account destination更新するには、 aiNotificationsUpdateDestination変異を使用します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が存在する範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destinationId`	弦	（必須）更新対象の宛先の一意の識別子。このIDは、目的地を作成する際に返されるか、目的地の一覧表示によって確認できます。
`destination`	オブジェクト	（必須）変更するフィールドを含む、更新先のオブジェクト。変更したい項目のみを含めてください。
`destination.name`	弦	（オプション）宛先の更新された名前。
`destination.auth`	オブジェクト	（オプション）認証情報が必要な宛先に対する認証設定を更新します。
`destination.properties`	オブジェクトの配列	(オプション) URL、電子メールアドレス、統合オプションなどの宛先固有の設定のキーの値のペアを更新しました。

サンプルクエリ:

mutation {
  aiNotificationsUpdateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
    destination: { name: "Updated destination Name" }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

クロスアカウントの宛先を削除します

scopeとdestination IDを指定してcross account destinationsを削除します。

重要

削除する前に：「エンティティタイプチャネルが使用中です」というエラーが表示された場合は、まず宛先に関連付けられているすべてのチャネルを削除する必要があります。関連チャンネルを見つけて、宛先削除に進む前に個別に削除してください。

aiNotificationsDeleteDestination変異を使用してcross account destinationを完全に削除します。

入力

問題の名前	データ型	説明
`scope`	オブジェクト	（必須）宛先が存在する範囲を定義します。cross account destinationsの場合は`type: ORGANIZATION` `type: ACCOUNT` 使用してください。
`scope.id`	弦	（必須） cross account destinationsの組織 ID、またはアカウントレベルの宛先の場合はアカウント ID。
`scope.type`	イナム	（必須） cross account destinationsの場合は`ORGANIZATION` 、アカウントレベルの宛先の場合は`ACCOUNT`である必要があります。
`destinationId`	弦	（必須）削除したい宛先の一意の識別子。このIDは、目的地を作成する際に返されるか、目的地の一覧表示によって確認できます。

サンプルクエリ:

mutation {
  aiNotificationsDeleteDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
  ) {
    ids
    error {
      details
    }
  }
}

このクエリを使用して、現在特定の宛先を使用しているすべてのチャネルを検索します。これは、宛先を削除する前に、アクティブなチャネルに影響がないことを確認するのに役立ちます。

入力

問題の名前	データ型	説明
`account.id`	文字列/ID	（必須）チャンネルを検索するための特定のアカウントID。このアカウントは、認証されたユーザーがアクセスできる必要があります。
`channels.filters`	オブジェクト	（必須）特定の宛先を使用するチャンネルを検索するためのフィルタ条件オブジェクト。
`channels.filters.destinationId`	弦	（必須）検索対象の宛先の固有識別子。この宛先を使用するように設定されているすべてのチャネルを返します。

サンプルクエリ:

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

宛先を使用しているチャネルを削除するには、 aiNotificationsDeleteChannelミューテーションを使用します。宛先自体を削除する前に、関連するすべてのチャンネルを削除する必要があります。

入力

問題の名前	データ型	説明
`accountId`	文字列/ID	（必須）チャンネルが存在するアカウントID。このアカウントは、認証されたユーザーがアクセスできる必要があります。
`channelId`	弦	（必須）削除したいチャンネルの一意の識別子。このIDは、宛先IDを使用してチャネルを照会することで見つけることができます。

サンプルクエリ:

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

次のステップ

クロスアカウントの宛先概要

cross account destinations概念と主要機能について学びましょう。

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

クロスアカウントの宛先を管理する

プレビュー

目的地を作成する .css-21sua1{background:none;border:none;width:0;padding:0;}

重要

メール送信先を作成する

ウェブフックの宛先を作成する

PagerDutyのサービスレベル宛先を作成する

PagerDutyアカウントレベルの宛先を作成する

Slack宛先を作成する

ServiceNow宛先を作成する

AWS EventBridge の宛先を作成する

クロスアカウントの宛先をテストする

テスト先設定

IDによる既存の宛先のテスト

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

組織のすべてのクロスアカウント宛先を一覧表示します。

特定のアカウントの宛先一覧

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

目的地を名前で絞り込む

IDで目的地を絞り込む

目的地を種類別に絞り込む

クロスアカウントの宛先を更新する

クロスアカウントの宛先を更新する

クロスアカウントの宛先を削除します

重要

クロスアカウントの宛先を削除します

目的地を使用してチャンネルを検索する

関連付けられたチャンネルを削除します

次のステップ

クロスアカウントの宛先概要

目的地を作成する