返回集群的搜索索引的详细信息。
要使用此命令，您必须使用具有项目数据访问读/写角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas clusters search indexes describe <indexId> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
indexId | 字符串 | true | 索引的 ID。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--clusterName | 字符串 | true | 集群名称。要学习；了解详情，请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
-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 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
ID NAME DATABASE COLLECTION TYPE <IndexID> <Name> <Database> <CollectionName> <Type>
示例
# Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster: atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json