为集群创建搜索索引。
公共预览版： Atlas API子命令从MongoDB Atlas Admin API自动生成，提供对 Admin API的全面覆盖，目前处于公共预览阶段（请通过以下网址提供反馈：https://反馈.mongodb.com/forum/930808-Atlas-cli）。Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
要使用此命令，您必须使用具有项目数据访问管理员角色的用户帐户或 API 密钥进行身份验证。
语法
atlas clusters search indexes create [indexName] [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
indexName | 字符串 | false | 索引名称。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--clusterName | 字符串 | true | 集群名称。要学习；了解更多信息，请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
-f, --file | 字符串 | false | 要使用的JSON索引配置文件的名称。要学习；了解Atlas Search和Atlas Vector Search索引配置文件，请参阅 https://dochub.mongodb.org/core/search-index-config-file-atlascli。要学习；了解可在配置文件中定义的Atlas Search索引语法和选项，请参阅 https://dochub.mongodb.org/core/index-definitions-fts。要学习；了解可在配置文件中定义的Atlas Vector Search索引语法和选项，请参阅 https://dochub.mongodb.org/core/index-definition-avs. |
-h，--help | false | 创建帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Index <Name> created.
示例
# Create a search index for the cluster named myCluster using a JSON index configuration file named search-config.json: atlas clusters search indexes create --clusterName myCluster --file search-config.json --output json