Get All User-Defined Analyzers for a Cluster¶
The fts resource allows you to retrieve and edit Atlas Search
index configurations for the specified cluster.
The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
To learn how to configure API access for an Atlas project, see Configure Atlas API Access.
Groups and projects are synonymous terms. Your {GROUP-ID} is the
same as your project ID. For existing groups, your group/project ID
remains the same. The resource and corresponding endpoints use the
term groups.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/analyzers
Request Parameters¶
Request Path Parameters¶
| Path Element | Type | Necessity | Description |
|---|---|---|---|
GROUP-ID | string | Required | Unique identifier for the project that contains the specified cluster. |
CLUSTER-NAME | string | Required | Name of the cluster containing the collection with one or more Atlas Search indexes. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.
| Name | Type | Necessity | Description | Default |
|---|---|---|---|---|
| pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the total number of objects. | 1 |
| itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum of 500. | 100 |
| includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount parameter in the response body. | true |
| pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON response in the prettyprint format. | false |
| envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response Elements¶
The HTTP response returns a JSON document that includes an array of analyzer definitions. An analyzer definition contains some or all of the following elements:
| Name | Type | Description |
|---|---|---|
baseAnalyzer | string | Analyzer on which the user-defined analyzer is based. |
ignoreCase | boolean | Specify whether the index is case-sensitive. |
maxTokenLength | integer | Longest text unit to analyze. Atlas Search excludes anything longer from the index. |
name | string | Name of the user-defined analyzer. |
stemExclusionSet | array of strings | Words to exclude from stemming by the language analyzer. |
stopwords | array of strings | Strings to ignore when creating the index. |
Example Request¶
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/analyzers?pretty=true"
Example Response¶
Response Header¶
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
HTTP/1.1 200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Response Body¶
The following example response contains an array of two analyzer definitions.
1 [ 2 { 3 "baseAnalyzer" : "lucene.standard", 4 "maxTokenLength" : 32, 5 "name" : "my_new_analyzer" 6 }, 7 { 8 "baseAnalyzer" : "lucene.english", 9 "name" : "my_new_analyzer2", 10 "stopwords" : [ "first", "second", "third", "etc" ] 11 } 12 ]