プライベートロケーションの管理

プライベートロケーションを使用すると、ファイアウォールの背後または制限されたネットワーク内でアプリケーションを監視できます。 プライベートロケーションを作成するときは、プライベートミニオンをインストールして構成し、そのプライベートロケーションに割り当てられたモニターを実行します。 このチュートリアルでは、NerdGraph API使用してプログラムでプライベート位置を管理する方法の例を示します。

プライベートロケーションの作成

syntheticsCreatePrivateLocation変異を使用してプライベートロケーションを作成できます。 この変更により、監視インフラストラクチャに新しいプライベート ロケーションをセットアップして、プライベート ミニオンまたはジョブ マネージャーをデプロイできるようになります。

入力

サンプルリクエスト

mutation {
  syntheticsCreatePrivateLocation(
    accountId: ACCOUNT_ID
    name: "PrivateLocationName"
    description: "Optional description"
    shared: true
    verifiedScriptExecution: false
  ) {
    guid
    errors {
      description
      type
    }
  }
}

サンプル回答

成功した応答は、新しく作成されたプライベートロケーションの GUID を返します。

{
  "data": {
    "syntheticsCreatePrivateLocation": {
      "guid": "PRIVATE_LOCATION_GUID",
      "errors": null
    }
  }
}

プライベートロケーションの作成に問題がある場合、 errors配列には、問題の原因を説明するdescriptionフィールドとtypeフィールドを持つオブジェクトが含まれます。

プライベートロケーションを更新する

syntheticsUpdatePrivateLocationミューテーションを使用して、既存のプライベート位置を更新できます。 すでに作成されているプライベートロケーションの設定を変更することができます。

入力

サンプルリクエスト

mutation {
  syntheticsUpdatePrivateLocation(
    guid: "ENTITY_GUID"
    description: "EnterYourDescription"
    shared: false
    verifiedScriptExecution: true
  ) {
    description
    verifiedScriptExecution
    errors {
      description
      type
    }
  }
}

サンプル回答

成功した応答では更新されたフィールドが返され、エラーの場合はnull返されます。

{
  "data": {
    "syntheticsUpdatePrivateLocation": {
      "description": "EnterYourDescription",
      "verifiedScriptExecution": true,
      "errors": null
    }
  }
}

プライベートロケーションの更新で問題が発生した場合、 errors配列には、問題の原因を説明するdescriptionフィールドとtypeフィールドを持つオブジェクトが含まれます。

プライベートロケーションのジョブキューを削除します

syntheticsPurgePrivateLocationQueueミューテーションを使用して、プライベートロケーションのジョブ キューをクリアできます。 これは、パフォーマンスの問題や一時的な接続の問題により蓄積された可能性のある、キューに入れられた合成モニター ジョブのバックログを削除する必要がある場合に役立ちます。

入力

サンプルリクエスト

mutation {
  syntheticsPurgePrivateLocationQueue(guid: "PRIVATE_LOCATION_ENTITY_GUID") {
    errors {
      description
      type
    }
  }
}

サンプル回答

成功した応答はエラーに対してnullを返します:

{
  "data": {
    "syntheticsPurgePrivateLocationQueue": {
      "errors": null
    }
  }
}

キューの消去中に問題が発生した場合、 errors配列には、何が問題であったかを説明するdescriptionとtypeフィールドを持つオブジェクトが含まれます。

プライベートロケーションを削除する

プライベートロケーションが不要になった場合は、 syntheticsDeletePrivateLocationミューテーションを使用して完全に削除できます。

入力

サンプルリクエスト

mutation {
  syntheticsDeletePrivateLocation(guid: "ENTITY_GUID") {
    errors {
      description
      type
    }
  }
}

サンプル回答

成功した応答はエラーに対してnullを返します:

{
  "data": {
    "syntheticsDeletePrivateLocation": {
      "errors": null
    }
  }
}

プライベートロケーションの削除中に問題が発生した場合、 errors配列には、問題の原因を説明するdescriptionフィールドとtypeフィールドを持つオブジェクトが含まれます。