atlas api rollingIndex createRollingIndex

Atlas CLI对使用Atlas Administration API运行命令的支持处于预览状态。在预览期间，功能和相应的文档可能随时更改。要学习；了解详情，请参阅预览功能。

公共预览版：请提供反馈：以滚动方式在名称标识的集群上创建索引。

公共预览版： Atlas API子命令从MongoDB Atlas Admin API自动生成，全面覆盖 Admin API ，目前处于公共预览版（请通过以下网址提供反馈：https://反馈.mongodb.com/forums/930808-Atlas-cli）。Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。

以这种方式创建索引，支持从从节点开始，一次在一个副本集节点上作为单节点进行索引构建。以这种方式创建索引，至少需要一次副本集选举。要使用此资源，请求的服务账户或 API 密钥必须具有项目数据访问管理员角色。

1此命令是自动生成的，对应:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 /operation/operation-createrollingindex 。

有关更多信息和示例，请参阅上面链接的参考API文档。

语法

命令语法

atlas api rollingIndex createRollingIndex [options]

选项

名称	类型	必需	说明
--clusterName	字符串	true	可读的标签，用于标识 MongoDB Cloud 创建索引的集群。
--envelope	envelope	false	指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。
--file	字符串	false	API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。
--groupId	字符串	true	用于标识项目的唯一 24-十六进制数字字符串。使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
-h，--help		false	createRollingIndex 帮助
-o, --output	字符串	false	首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。
--outputFile	字符串	false	要将API输出写入其中的文件。当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志
--pretty		false	指示响应正文是否应采用 prettyprint 格式的标记。
--version	字符串	false	进行API调用时要使用的API版本 [选项："2023-01-01"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-01-01"。

继承选项

名称	类型	必需	说明
-P, --profile	字符串	false	要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。

示例

2dspere Index

创建以下文件并将其另存为 payload.json

{
  "collation": {
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "locale": "af",
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false,
    "strength": 3
  },
  "collection": "accounts",
  "db": "sample_airbnb",
  "keys": [
    {
      "property_type": "1"
    }
  ],
  "options": {
    "name": "PartialIndexTest",
    "partialFilterExpression": {
      "limit": {
        "$gt": 900
      }
    }
  }
}

创建 payload.json 后，在同一目录中运行以下命令。

atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

部分索引

创建以下文件并将其另存为 payload.json

{
  "collation": {
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "locale": "af",
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false,
    "strength": 3
  },
  "collection": "accounts",
  "db": "sample_airbnb",
  "keys": [
    {
      "property_type": "1"
    }
  ],
  "options": {
    "name": "PartialIndexTest",
    "partialFilterExpression": {
      "limit": {
        "$gt": 900
      }
    }
  }
}

创建 payload.json 后，在同一目录中运行以下命令。

atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

Sparse Index

创建以下文件并将其另存为 payload.json

{
  "collation": {
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "locale": "af",
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false,
    "strength": 3
  },
  "collection": "accounts",
  "db": "sample_airbnb",
  "keys": [
    {
      "test_field": "1"
    }
  ],
  "options": {
    "name": "SparseIndexTest",
    "sparse": true
  }
}

创建 payload.json 后，在同一目录中运行以下命令。

atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8