すべてのアラート構成一致するフィールド名を返します

GET /api/atlas/v1.0/alertConfigs/matchers/fieldNames
サービス アカウント DigestAuth

アラート構成を作成または更新するときに matchers.fieldName パラメータが受け入れるすべてのフィールド名を取得します。割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。

クエリ パラメータ

  • envelope ブール値

    アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

    デフォルト値はfalseです。

  • pretty ブール値

    レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

    デフォルト値はfalseです。

    Prettyprint

応答

  • 200 application/ JSON

    OK

    次の 1 つ：
    App Services メトリクス マッチャー フィールド string クラスター マッチャー フィールド string ホストマッチャー フィールド string レプリカセット マッチャー フィールド string ストリーム マッチャー フィールド string Streams Private Link エンドポイントとなる接続されたデバイスの照合フィールド string ログ取り込みマッチャー フィールド string グローバル ソフトウェア タイプ マッチャー フィールド string NDS オートスケーリング マッチャー フィールド string

    値は APPLICATION_ID です。

    値は CLUSTER_NAME です。

    値は、TYPE_NAME、HOSTNAME、PORT、HOSTNAME_AND_PORT、REPLICA_SET_NAME、または ATLAS_NODE_TYPE です。

    値は REPLICA_SET_NAME、SHARD_NAME、または CLUSTER_NAME です。

    値は INSTANCE_NAME または PROCESSOR_NAME です。

    値は ENDPOINT_ID です。

    値は RULE_ID です。

    値は SOFTWARE_TYPE です。

    値は CLUSTER_NAME です。
  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • policiesCa usingDecision array[オブジェクト]

      リクエストが拒否される原因となった Atlas リソース ポリシー 。 errorCode が ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED の場合にのみ返されます。

      100 要素以下

      policiesCa usingDecision 属性を非表示 policiesCa usingDecision 属性の表示 オブジェクト

      リクエストが拒否される原因となった Atlas リソース ポリシー。

      • id string 必須

        Atlas リソース ポリシーを識別する一意の 24 16 進数文字列。

        形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

      • name string 必須

        Atlas リソース ポリシーを識別する、人間が判読可能なラベル。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。
  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • policiesCa usingDecision array[オブジェクト]

      リクエストが拒否される原因となった Atlas リソース ポリシー 。 errorCode が ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED の場合にのみ返されます。

      100 要素以下

      policiesCa usingDecision 属性を非表示 policiesCa usingDecision 属性の表示 オブジェクト

      リクエストが拒否される原因となった Atlas リソース ポリシー。

      • id string 必須

        Atlas リソース ポリシーを識別する一意の 24 16 進数文字列。

        形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

      • name string 必須

        Atlas リソース ポリシーを識別する、人間が判読可能なラベル。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。
  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • policiesCa usingDecision array[オブジェクト]

      リクエストが拒否される原因となった Atlas リソース ポリシー 。 errorCode が ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED の場合にのみ返されます。

      100 要素以下

      policiesCa usingDecision 属性を非表示 policiesCa usingDecision 属性の表示 オブジェクト

      リクエストが拒否される原因となった Atlas リソース ポリシー。

      • id string 必須

        Atlas リソース ポリシーを識別する一意の 24 16 進数文字列。

        形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

      • name string 必須

        Atlas リソース ポリシーを識別する、人間が判読可能なラベル。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。
GET /API/Atlas/v1.0/alertConfigs/matchers/fieldNames 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/alertConfigs/matchers/fieldNames' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
応答の例（200） 
[
  "APPLICATION_ID"
]
応答の例（401） 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
応答の例（403） 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
応答の例（500） 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}