Atlas 部署搜索索引描述
公共预览版。
atlas deployments命令和后续相关命令以公共预览版形式提供。 在公共预览阶段，该功能和相应的文档可能随时更改。 要提问和提供反馈，请参阅 Atlas CLI本地开发社区论坛。描述指定部署的搜索索引。
语法
命令语法
atlas deployments search indexes describe [indexId] [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
indexId | 字符串 | false | 索引的 ID。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--deploymentName | 字符串 | false | 部署的名称。 |
-h，--help | false | 描述帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--password | 字符串 | false | 用户的密码。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--type | 字符串 | false | 部署类型。 有效值为 ATLAS 或 LOCAL。 |
--username | 字符串 | false | 用于向 MongoDB 进行身份验证的用户名。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
ID NAME DATABASE COLLECTION STATUS TYPE <IndexID> <Name> <Database> <CollectionName> <Status> <Type>