NerdGraph チュートリアル: 公開共有ダッシュボード URL の作成、更新、取り消し

1. NerdGraph API エクスプローラーに移動します。
2. 次の点でdashboardCreateLiveUrl変異を使用してグラフAPIコールを構築します。

• GUID: ダッシュボードのエンティティ GUID を入力します。

• Options(オプション) > ttl : URL を有効にする期間を秒単位で入力します。

  • 最小値: 300秒(5分)
  • 最大値: 631152000秒 (20年)
  • デフォルト値: 2592000秒 (30日)

• url: 応答でライブ ダッシュボードの URL を取得するには、これを選択します。

• 応答に必要なその他のフィールドを選択します。

  サンプル変異

  mutation {
    dashboardCreateLiveUrl(
      options: {ttl: time in seconds}
      guid: "YOUR_DASHBOARD_GUID"
    ) {
      url
    }
  }

  コピー

  ライブ ダッシュボードの URL が応答に表示されます。 これはパブリック URL なので、誰とでも共有できます。

  サンプル回答

  {
    "data": {
      "dashboardCreateLiveUrl": {
        "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
      }
    }
  }

  コピー

  PUBLIC_LINK_ID共有ダッシュボードの ID です。 これを使用して、NerdGraph を通じて共有ダッシュボード URL を更新または取り消すことができます。

  重要

  New Relic プラットフォームのダッシュボードのコンテンツの更新は、共有ダッシュボード ページに反映されます。

共有ダッシュボードへの不要なアクセスを回避するために、パスワード保護されたライブ ダッシュボード URL を作成できます。

1. NerdGraph API エクスプローラーに移動します。
2. 次の点でdashboardCreateLiveUrl変異を使用してグラフAPIコールを構築します。

• auth > factors > type : ライブダッシュボード URL のパスワード保護を有効にするには、 PASSWORD選択します。

• GUID: ダッシュボードのエンティティ GUID を入力します。

• Options(オプション) > ttl : URL を有効にする期間を秒単位で入力します。

  • 最小値: 300秒(5分)
  • 最大値: 631152000秒 (20年)
  • デフォルト値: 2592000秒 (30日)

• auth > factors > password > value : 応答でライブダッシュボードのパスワードを取得するには、これを選択します。

• url: 応答でライブ ダッシュボードの URL を取得するには、これを選択します。

• 応答に必要なその他のフィールドを選択します。

  サンプル変異

  mutation {
    dashboardCreateLiveUrl(
      guid: "YOUR_DASHBOARD_GUID"
      options: { ttl: 3600 } # Optional: Set a time-to-live for the URL
      auth: { factors: [{ type: PASSWORD }] }
    ) {
      url
      uuid
      auth {
        factors {
          type
          password {
            value # REQUEST THE PASSWORD VALUE HERE
          }
        }
      }
    }
  }

  コピー

  ライブ ダッシュボードの URL とパスワードが応答に表示されます。

  サンプル回答

  {
    "data": {
      "dashboardCreateLiveUrl": {
        "auth": {
          "factors": [
            {
              "password": {
                "value": "pfd-3ZZ46#3a4On5p%&¿"
              },
              "type": "PASSWORD"
            }
          ]
        },
        "url": "https://one.newrelic.com/dashboard/f6c730bf-fced-4890-ad6e-86ab6a6e8159",
        "uuid": "f6c730bf-fced-4890-ad6e-86ab6a6e8159"
      }
    }
  }

  コピー

  uuid共有ダッシュボードの ID です。これを使用して、NerdGraph を通じて共有ダッシュボードの URL を更新または取り消すことができます。ダッシュボードを外部ユーザーと共有するには、応答から URL とパスワードをコピーします。パスワードは後で取得できません。パスワードを紛失した場合は、パスワードをリセットしてユーザーと再度共有するだけです。パスワード管理ベストプラクティスに従ってパスワードを安全に管理してください。

共有ダッシュボードの設定を変更する権限があることを確認してください。

URL の有効期間を更新するには:

1. NerdGraph API エクスプローラーに移動します。
2. 次の点でdashboardUpdateLiveUrl変異を使用してグラフAPIコールを構築します。

• id: 共有ダッシュボードの URL から ID をコピーして入力します。

• Options (オプション) > ttl : URL を有効にする期間を秒単位で入力します。

  • 最小値: 300秒(5分)
  • 最大値: 631152000秒 (20年)
  • デフォルト値: 2592000秒 (30日)

  サンプル変異

  mutation {
    dashboardUpdateLiveUrl(
      id: "enter the public URL ID"
      options: { ttl: "updated duration in seconds" }
    )
  }

  コピー

  応答内の URL は次のように表示されます。 これで、URL は更新された期間にわたって有効のままになります。

  サンプル回答

  {
    "data": {
      "dashboardUpdateLiveUrl": {
        "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
      }
    }
  }

  コピー

共有ダッシュボードの設定を変更するための権限があることを確認してください。ライブ ダッシュボード URL のパスワード保護を有効にするには:

1. NerdGraph API エクスプローラーに移動します。
2. 次の点でdashboardUpdateLiveUrlAuth変異を使用してグラフAPIコールを構築します。

• auth > factors > type : ライブダッシュボード URL のパスワード保護を有効にするには、 PASSWORD選択します。

• id: 共有ダッシュボードの URL から ID をコピーして入力します。

• auth > factors > password > value : 応答でライブダッシュボードのパスワードを取得するには、これを選択します。

• 応答に必要なその他のフィールドを選択します。

  サンプル変異

  mutation {
    dashboardUpdateLiveUrlAuth(
      id: "YOUR_PUBLIC_LINK_UUID"
      auth: { factors: [{ type: PASSWORD }] }
    ) {
      factors {
        password {
          value # A NEW PASSWORD WILL BE GENERATED AND RETURNED
        }
        type
      }
    }
  }

  コピー

  サンプル回答

  応答には次のようにパスワードが表示されます。

  {
    "data": {
      "dashboardUpdateLiveUrlAuth": {
        "factors": [
          {
            "password": {
              "value": "system generated password"
            },
            "type": "PASSWORD"
          }
        ]
      }
    }
  }

  コピー

  共有ダッシュボードのパスワードを有効にした後、そのパスワードをユーザーと共有する必要があります。パスワードは後で取得できないため、コピーして保存してください。パスワードを紛失した場合は、パスワードをリセットしてユーザーと再度共有するだけです。パスワード管理ベストプラクティスに従ってパスワードを安全に管理してください。

共有ダッシュボードの設定を変更するための権限があることを確認してください。ライブ ダッシュボード URL のパスワード保護を無効にするには:

1. NerdGraph API エクスプローラーに移動します。
2. 次のプロパティ値を持つdashboardUpdateLiveUrlAuth変異を使用して、グラフAPIコールを構築します。

• auth > factors > type : ライブダッシュボード URL のパスワード保護を有効にするには、 PASSWORD選択します。

• id: 共有ダッシュボードの URL から ID をコピーして入力します。

• auth > factors : 空のままにしておきます。

• factors > type : パスワード値が削除されたことを確認するには、これを選択します。

  サンプル変異

  mutation {
    dashboardUpdateLiveUrlAuth(
      id: "YOUR_PUBLIC_LINK_UUID"
      auth: { factors: [] } # Send an empty array to remove all authentication
    ) {
      factors {
        # This will be empty
        type
      }
    }
  }

  コピー

  サンプル回答

  応答が次のように表示されることを確認します。パスワードが削除され、ライブ ダッシュボードの URL はパスワードで保護されなくなります。

  {
    "data": {
      "dashboardUpdateLiveUrlAuth": {
        "factors": []
      }
    }
  }

  コピー

共有ダッシュボードの設定を変更するための権限があることを確認してください。ライブダッシュボード URL のパスワードをリセットするには:

1. NerdGraph API エクスプローラーに移動します。
2. 次のプロパティ値を持つdashboardResetLiveUrlPassword変異を使用して、グラフAPIコールを構築します。

• id: 共有ダッシュボードの URL から ID をコピーして入力します。

• password: 応答で新しいライブ ダッシュボード パスワードを取得するには、これを選択します。

  サンプル変異

  mutation {
    dashboardResetLiveUrlPassword(id: "YOUR_PUBLIC_LINK_UUID") {
      password
    }
  }

  コピー

  サンプル回答

  新しいパスワードは次のように応答に表示されます。

  {
    "data": {
      "dashboardResetLiveUrlPassword": {
        "password": "system generated password"
      }
    }
  }

  コピー

  共有ダッシュボードのパスワードをリセットした後、新しいパスワードをユーザーと共有する必要があります。パスワードは後で取得できないため、コピーして保存してください。紛失した場合は、再度リセットするだけです。パスワード管理ベストプラクティスに従ってパスワードを安全に管理してください。

持っている権限に基づいて、自分が作成した URL のみを取り消すことも、アカウント内のユーザーが作成したすべての URL を取り消すこともできます。 共有ダッシュボード URL を取り消すには:

1. NerdGraph API エクスプローラーに移動します。
2. 次のプロパティ値を持つdashboardRevokeLiveUrl変異を使用して、グラフAPIコールを構築します。

• id: 共有ダッシュボードの URL から ID をコピーして入力します。

  サンプル変異

  mutation {
    dashboardRevokeLiveUrl(id: "PUBLIC_LINK_ID") {
      id
    }
  }

  コピー

  サンプル回答

  共有ダッシュボードの URL は取り消され、アクセスできなくなります。 応答は次のようになります。

  {
    "data": {
      "dashboardRevokeLiveUrl": {
        "id": "PUBLIC_LINK_ID" //the one you passed to the mutation
      }
    }
  }

  コピー

保有する権限に基づいて、自分が作成した URL のリスト、またはアカウント内のユーザーが作成したすべての URL のリストを取得できます。共有ダッシュボードの URL のリストを取得するには:

1. NerdGraph API エクスプローラーに移動します。
2. 次の詳細を使用してグラフAPIを構築します。

• actor > dashboard > liveUrls : これを使用して、共有ダッシュボードの URL のリストを取得します。

• filter > type : ダッシュボード URL の結果をフィルターするには、 DASHBOARDを選択します。

• 応答に必要なその他のフィールドを選択します。

  サンプルクエリ

  {
    actor {
      user {
        name
      }
      dashboard {
        liveUrls(filter: { type: DASHBOARD }) {
          liveUrls {
            createdAt
            type
            uuid
          }
        }
      }
    }
  }

  コピー

  応答として、共有ダッシュボード URL のリストが表示されます。