1 つのクラスターのすべてのユーザー定義アナライザを返す

GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers
サービス アカウント DigestAuth

指定されたクラスターが指定されたプロジェクトで使用するすべての Atlas Search カスタムアナライザを返します。カスタムアナライザは、フィールドをインデックスために実行する操作を定義します。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーにプロジェクトのデータアクセスに関する読み取りおよび書込みロールが必要です。

カスタムアナライザ

path パラメータ

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

    注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

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

  • clusterName string 必須

    1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。

    形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。

クエリ パラメータ

  • envelope ブール値

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

    デフォルト値はfalseです。

  • pretty ブール値

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

    デフォルト値はfalseです。

    Prettyprint

応答

  • 200 application/ JSON

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • charFilters array[オブジェクト]

      テキストを 1 文字ずつ検査し、フィルタリング操作を実行するフィルター。

      次の 1 つ：
      charFilterhtmlStopオブジェクト charFiltercuNormalizeオブジェクト charFilterマッピングオブジェクト charFilterpersianオブジェクト
    • name string 必須

      カスタムアナライザを識別する、人間が判読できる名前。 名前はインデックス内で一意である必要があり、次のいずれかの文字列で始まらない必要があります。

      • lucene.
      • builtin.
      • mongodb.
    • トークン フィルター array[オブジェクト]

      次のような操作を実行するフィルター。

      • ステミング 。これにより、「toring」、「thaled」、「torages」などの関連単語を語幹単語の「torage」に減らします。

      • 編集 : 公開ドキュメントから機密情報を排除します。

      次のいずれか:
      tokenFilterSCIIBuildingオブジェクト tokenFilterdwitchMokoffStringオブジェクト tokenFilteredgeGramオブジェクト TokenFilterenglishPassiveオブジェクト TokenFilterFlattenGraphオブジェクト tokenFiltericForwardingオブジェクト tokenFiltercuNormalizerオブジェクト TokenFilterkStemming object tokenFilterLengthオブジェクト tokenFilterLowercaseオブジェクト tokenFilterGramオブジェクト TokenFilterPorterStemingオブジェクト tokenFilterregexオブジェクト tokenFilterreverseオブジェクト tokenFilterishleオブジェクト tokenFiltersnowballStringオブジェクト TokenFilterSpanishPluralStemingオブジェクト TokenFilterStempel object tokenFilterストップオブジェクト tokenFiltertrimオブジェクト TokenFilterWiredTigerGraphオブジェクト

    • トークナイザ オブジェクト 必須

      トークンを作成するために使用する トークナイザ 。 トークンは、Atlas Search がインデックスを作成するためにテキストを個別のチャンクに分割する方法を決定します。

      次の 1 つ：
      EdgeGramオブジェクト キーワードオブジェクト nGramオブジェクト regexCaptureGroupオブジェクト regexSplitオブジェクト 標準オブジェクト uixUrlEmailオブジェクト 空白オブジェクト
  • 404 application/ JSON

    見つかりません。

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

    内部サーバーエラー。

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。
GET /API/Atlas/v1.0/groups/{groupId}/clusters/{clusterName}/fts/analyzers 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/fts/analyzers' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
応答の例（200） 
[
  {
    "charFilters": [
      {
        "ignoredTags": [
          "string"
        ],
        "type": "htmlStrip"
      }
    ],
    "name": "string",
    "tokenFilters": [
      {
        "originalTokens": "omit",
        "type": "asciiFolding"
      }
    ],
    "tokenizer": {
      "maxGram": 42,
      "minGram": 42,
      "type": "edgeGram"
    }
  }
]
応答の例（404） 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
応答の例（500） 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}