实验：更新您使用其数据库、集合名称和索引名称标识的一个Atlas Search索引。
Atlas Search索引定义了创建索引的字段以及创建索引时使用的分析器。要使用此资源，请求的API密钥必须具有项目数据访问管理员角色。此命令正在调用 OperationID 为“updateAtlasSearchIndexByName”的端点。有关标志、文件格式和示例的更多信息，请参阅：https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Atlas-Search/operation/updateAtlasSearchIndexByName
语法
atlas api atlasSearch updateAtlasSearchIndexByName [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--clusterName | 字符串 | true | 集群的名称，该集群包含要更新其Atlas Search索引的集合 |
--collectionName | 字符串 | true | 包含一个或多个Atlas Search索引的集合名称 |
--databaseName | 字符串 | true | 标签，用于标识包含具有一个或多个Atlas Search索引的集合的数据库 |
--envelope | false | 标志，指示应用程序是否将响应包装在信封JSON对象中 | |
--file | 字符串 | false | 包含API请求内容的文件的路径 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串 |
-h，--help | false | updateAtlasSearchIndexByName 帮助 | |
--indexName | 字符串 | true | 要更新的Atlas Search索引的名称 |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 标志，指示响应正文是否应采用美观打印格式 | |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2024-05-30"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2024-05-30"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |