1 つのオンライン アーカイブを作成
1 つのオンライン アーカイブを作成します。このアーカイブには、1 つのプロジェクト内の 1 つのクラスターのデータが格納されています。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
1 つのオンラインアーカイブを作成するコレクションを持つクラスターを識別する、人間が判読可能なラベル。
形式は次のパターンと一致する必要があります:
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
1 つのオンライン アーカイブを作成します。
-
オンラインアーカイブを作成したコレクションを識別する、人間が判読可能なラベル。
-
返却対象の MongoDB データベース コレクションの分類。
このパラメーターを
TIMESERIESに設定する場合は、"criteria.type" : "date"と"criteria.dateFormat" : "ISODATE"を設定します。値は
TIMESERIESまたはSTANDARDです。デフォルト値はSTANDARDです。 -
アーカイブからデータを削除するタイミングを指定するためのルール。
-
オンライン アーカイブを含むコレクションを格納するデータベースの、人間が判読可能なラベル。
-
コレクション内のデータを論理的に分割するために使用するドキュメント パラメーターを格納したリスト。パーティションは、基礎となるコレクション データの大まかなレベルのフィルタリングを提供します。データを分割するには、頻繁にクエリを実行するパラメーターを指定します。CREATE ONE ONLINE ARCHIVE エンドポイントで "criteria.type": "DATE" を指定した場合には、クエリに使用するパラメーターを最大 3 つ指定できます。これらのパラメーターの 1 つは DATE 値である必要があり、この場合は必須です。CREATE ONE ONLINE ARCHIVE エンドポイントで "criteria.type": "CUSTOM" を指定した場合には、クエリに使用するパラメーターを最大 2 つ指定できます。"criteria.type": "DATE" または "criteria.type": "CUSTOM" パラメーターを使用しないクエリでは、MongoDBはアーカイブされたすべてのドキュメントのコレクション全体をスキャンします。これには時間がかかり、コストが増加します。
このオンライン アーカイブを分割するためのメタデータ。
少なくとも
1要素。 -
このオンライン アーカイブが一時停止状態で存在するかどうかを示すフラグ。コレクションに別のアクティブなオンライン アーカイブがある場合、再開要求は失敗します。アクティブなオンライン アーカイブを一時停止したり、一時停止したオンライン アーカイブを再開したりするには、このパラメーターを含める必要があります。アクティブなアーカイブを一時停止するには、true に設定します。一時停止したアーカイブを再開するには、false に設定します。
atlas api onlineArchive createGroupClusterOnlineArchive --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/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.CreateGroupClusterOnlineArchiveApiParams{}
sdkResp, httpResp, err := client.OnlineArchiveApi.
CreateGroupClusterOnlineArchiveWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \
-d '{ <Payload> }'{
"collName": "string",
"collectionType": "STANDARD",
"criteria": {
"type": "CUSTOM",
"query": "string"
},
"dataExpirationRule": {
"expireAfterDays": 42
},
"dataProcessRegion": {
"cloudProvider": "AWS",
"region": "US_EAST_1"
},
"dbName": "string",
"partitionFields": [
{
"fieldName": "string",
"order": 0
}
],
"paused": true,
"schedule": {
"type": "DEFAULT"
}
}{
"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"collName": "string",
"collectionType": "STANDARD",
"criteria": {
"type": "CUSTOM",
"query": "string"
},
"dataExpirationRule": {
"expireAfterDays": 42
},
"dataProcessRegion": {
"cloudProvider": "AWS",
"region": "US_EAST_1"
},
"dataSetName": "string",
"dbName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"partitionFields": [
{
"fieldName": "string",
"fieldType": "date",
"order": 0
}
],
"paused": true,
"schedule": {
"type": "DEFAULT"
},
"state": "PENDING"
}{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}