1 つのローリング インデックスを作成
名前で識別されるクラスターにローリング方式でインデックスを作成します。この方法でインデックスを作成すると、セカンダリ ノードから始めて、一度に 1 つのレプリカ セット ノードに対してスタンドアロンとしてインデックスを構築できます。この方法でインデックスを作成するには、少なくとも 1 つのレプリカ セットを選択する必要があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データ アクセス管理者ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
MongoDB Cloud がインデックスを作成するクラスターを識別する、人間に判読可能なラベル。
形式は次のパターンと一致する必要があります:
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
指定したクラスターに作成するローリング インデックス。
-
このインデックス内の文字列を比較するための言語固有のルールを指定する 1 つ以上の設定。
Collation Options -
MongoDB Cloud がインデックスを作成するコレクションの、人間に判読可能なラベル。
-
MongoDB Cloud がインデックスを作成するコレクションを保持するデータベースの、人間に判読可能なラベル。
-
インデックスを作成するパラメータを記述する 1 つ以上のオブジェクトを含むリスト。
インデックスを作成するパラメーターをキーとして設定し、インデックスのタイプをその値として設定するキーと値のペア。マルチキーインデックスを作成するには、この配列内の独自のオブジェクトに各パラメータを一覧表示します。
-
MongoDB Cloud がこの MongoDB インデックスを作成する方法を決定する 1 つまたは複数の設定。
インデックス オプション
atlas api rollingIndex createGroupClusterIndexRollingIndex --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupClusterIndexRollingIndexApiParams{}
sdkResp, httpResp, err := client.RollingIndexApi.
CreateGroupClusterIndexRollingIndexWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \
-d '{ <Payload> }'{
"db": "sample_airbnb",
"keys": [
{
"property_type": "1"
}
],
"options": {
"name": "PartialIndexTest",
"partialFilterExpression": {
"limit": {
"$gt": 900
}
}
},
"collation": {
"locale": "af",
"strength": 3,
"alternate": "non-ignorable",
"backwards": false,
"caseFirst": "lower",
"caseLevel": false,
"maxVariable": "punct",
"normalization": false,
"numericOrdering": false
},
"collection": "accounts"
}{
"db": "sample_airbnb",
"keys": [
{
"property_type": "1"
}
],
"options": {
"name": "PartialIndexTest",
"partialFilterExpression": {
"limit": {
"$gt": 900
}
}
},
"collation": {
"locale": "af",
"strength": 3,
"alternate": "non-ignorable",
"backwards": false,
"caseFirst": "lower",
"caseLevel": false,
"maxVariable": "punct",
"normalization": false,
"numericOrdering": false
},
"collection": "accounts"
}{
"db": "sample_airbnb",
"keys": [
{
"test_field": "1"
}
],
"options": {
"name": "SparseIndexTest",
"sparse": true
},
"collation": {
"locale": "af",
"strength": 3,
"alternate": "non-ignorable",
"backwards": false,
"caseFirst": "lower",
"caseLevel": false,
"maxVariable": "punct",
"normalization": false,
"numericOrdering": false
},
"collection": "accounts"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}