リソース バージョン 2025-03-12
OpenAPI 仕様をダウンロード: ダウンロード
MongoDB Atlas Administration API を使用すると、開発者は MongoDB Atlas のすべてのコンポーネントを管理できます。
Atlas Administration API では、リクエストの認証に HTTP ダイジェスト認証を使用します。HTTP リクエストを作成する際は、ユーザー名とパスワードとして、プログラマティック API 公開キーと、それに対応する秘密キーを指定する必要があります。たとえば、cURL を使用して データベース アクセス履歴を返すには、ターミナルで次のコマンドを実行します。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
--digest \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"
詳細については、「Atlas Administration API の使い始める」を参照してください。サポートについては、MongoDB サポートを参照してください。
MongoDB のPostman ワークスペースの Atlas Administration API を通じて利用可能なさまざまなエンドポイントを確認することもできます。
Atlas データベース配置に対して行われた認証試行のアクセス ログを返します。データベース アクセス履歴を表示するには、プロジェクト オーナーまたは組織オーナー ロールが必要です。
クラスター名で識別される 1 つのクラスターのアクセス ログを返します。 アクセス ログには、クラスターに対して行われた認証リクエストのリストが含まれます。 この機能は、テナント階層クラスター(M0、M2、M5)では使用できません。 このリソースを使用するには、リクエスト元のAPIキーに プロジェクト モニタリング 管理者ロールまたはプロジェクト データベース アクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
authResult | ブール値 レスポンスが成功した認証試行のみを返すかどうかを示すフラグ。 |
end | integer <int64> データベース履歴の取得を停止する日時。end を指定する場合は、start も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。 |
ipAddress | string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))... データベースへの認証を試みた 1 つのインターネット プロトコル アドレス。 |
nLogs | integer <int32> [ 0 .. 20000 ] デフォルト: 20000 ログから返される最大行数。 |
始める | integer <int64> MongoDB Cloud がデータベース履歴の取得を開始する日時。start を指定する場合は、end も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。 |
{- "accessLogs": [
- {
- "authResult": true,
- "authSource": "string",
- "failureReason": "string",
- "groupId": "string",
- "hostname": "string",
- "ipAddress": "string",
- "logLine": "string",
- "timestamp": "string",
- "username": "string"
}
]
}
クラスターのホスト名で識別される 1 つのクラスターのアクセス ログを返します。 アクセス ログには、クラスターに対して行われた認証リクエストのリストが含まれます。 この機能は、テナント階層クラスター(M0、M2、M5)では使用できません。 このリソースを使用するには、リクエスト元のAPIキーに プロジェクト モニタリング 管理者ロールまたはプロジェクト データベース アクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
Hostname 必須 | string ダウンロード対象のログファイルを保存する MongoDB ホストの完全修飾ドメイン名または IP アドレス。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
authResult | ブール値 レスポンスが成功した認証試行のみを返すかどうかを示すフラグ。 |
end | integer <int64> データベース履歴の取得を停止する日時。end を指定する場合は、start も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。 |
ipAddress | string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))... データベースへの認証を試みた 1 つのインターネット プロトコル アドレス。 |
nLogs | integer <int32> [ 0 .. 20000 ] デフォルト: 20000 ログから返される最大行数。 |
始める | integer <int64> MongoDB Cloud がデータベース履歴の取得を開始する日時。start を指定する場合は、end も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。 |
{- "accessLogs": [
- {
- "authResult": true,
- "authSource": "string",
- "failureReason": "string",
- "groupId": "string",
- "hostname": "string",
- "ipAddress": "string",
- "logLine": "string",
- "timestamp": "string",
- "username": "string"
}
]
}
アラートをトリガーする条件と、MongoDB Cloud がユーザーに通知する方法を返したり編集したりします。このコレクションは現在も改訂中であり、変更される可能性があります。
アラート構成を作成または更新するときに matchers.fieldName
パラメータが受け入れるすべてのフィールド名を取得します。割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- "APPLICATION_ID"
]
1 つのプロジェクトのすべてのアラート構成を返します。これらのアラート構成は、プロジェクト内のどのコンポーネントにも適用されます。アラート構成では、アラートの Triggers と通知方法を定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}
指定されたプロジェクトに対して 1 つのアラート構成を作成します。アラート構成では、アラートの Triggers と通知方法を定義します。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクトに対して 1 つのアラート構成を作成します。
enabled | ブール値 デフォルト: false 指定されたプロジェクトに対して誰かがこのアラート構成を有効にしたかどうかを示すフラグ。 |
必須 | 請求イベント タイプ(オブジェクト)または Cps バックアップ イベント タイプ(オブジェクト)またはデータ保護イベント タイプ(オブジェクト)または FTS インデックス監査タイプ(オブジェクト)またはグループ イベント タイプ(オブジェクト)または NDS監査タイプ(オブジェクト)または NDS メンテナンスウィンドウ監査タイプ(オブジェクト)または「オンラインアーカイブイベント タイプ」(オブジェクト)または「 ユーザー イベント タイプ 」(オブジェクト)または「 リソース イベントタイプ 」(オブジェクト)または「 ストリームプロセッサ イベントタイプ 」(オブジェクト)または NDS オートスケーリング監査タイプ(オブジェクト) このアラートをトリガーしたインシデント。 |
の配列 オブジェクト (マッチャー) ターゲット リソースの一致条件。 | |
必須 | の配列 Datadog 通知(オブジェクト)、メール通知(オブジェクト)、グループ通知(オブジェクト)、HipChat 通知(オブジェクト)、Microsoft Teams 通知(オブジェクト)、OpsGenie 通知(オブジェクト)、OpsGenie 通知(オブジェクト)、組織通知(オブジェクト)、PagerDuty 通知(オブジェクト)、Slack 通知(オブジェクト)、SMS 通知(オブジェクト)、チーム通知(オブジェクト)、ユーザー通知(オブジェクト)、VictorOps 通知(オブジェクト)、Webhook 通知(オブジェクト)のいずれか (AlertsNotificationRootForGroup) MongoDB Cloud が通知を送信するターゲットを含むリスト。 |
{- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
]
}
{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "updated": "2019-08-24T14:15:22Z"
}
指定されたプロジェクトから 1 つのアラート構成を削除します。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertConfigId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "detail": "(This is just an example, the exception may not be related to this endpoint)",
- "error": 401,
- "errorCode": "NOT_ORG_GROUP_CREATOR",
- "reason": "Unauthorized"
}
指定されたプロジェクトから指定されたアラート構成を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertConfigId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "updated": "2019-08-24T14:15:22Z"
}
指定されたプロジェクト内の指定されたアラート構成を有効または無効にします。リソースは、指定されたアラート構成が現在有効になっている場合は有効にします。リソースは、指定されたアラート構成が現在無効になっている場合は無効にします。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。
注: このエンドポイントは、アラート構成の有効/無効状態のみを更新します。この構成以外を更新するには、「1 つのアラート構成の更新」を参照してください。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertConfigId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 このアラートをトリガーしたアラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクト内の指定されたアラート構成を有効または無効にします。
enabled | ブール値 指定されたプロジェクトで指定されたアラート構成を有効にするか無効にするかを示すフラグ。 |
{- "enabled": true
}
{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "updated": "2019-08-24T14:15:22Z"
}
指定されたプロジェクト内の 1 つのアラート構成を更新します。アラート構成では、アラートの Triggers と通知方法を定義します。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。
注: アラート構成を有効または無効にするには、「1 つのプロジェクトで 1 つのアラート構成の 1 つの状態を切り替える」を参照してください。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertConfigId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクト内の 1 つのアラート構成を更新します。
enabled | ブール値 デフォルト: false 指定されたプロジェクトに対して誰かがこのアラート構成を有効にしたかどうかを示すフラグ。 |
必須 | 請求イベント タイプ(オブジェクト)または Cps バックアップ イベント タイプ(オブジェクト)またはデータ保護イベント タイプ(オブジェクト)または FTS インデックス監査タイプ(オブジェクト)またはグループ イベント タイプ(オブジェクト)または NDS監査タイプ(オブジェクト)または NDS メンテナンスウィンドウ監査タイプ(オブジェクト)または「オンラインアーカイブイベント タイプ」(オブジェクト)または「 ユーザー イベント タイプ 」(オブジェクト)または「 リソース イベントタイプ 」(オブジェクト)または「 ストリームプロセッサ イベントタイプ 」(オブジェクト)または NDS オートスケーリング監査タイプ(オブジェクト) このアラートをトリガーしたインシデント。 |
の配列 オブジェクト (マッチャー) ターゲット リソースの一致条件。 | |
必須 | の配列 Datadog 通知(オブジェクト)、メール通知(オブジェクト)、グループ通知(オブジェクト)、HipChat 通知(オブジェクト)、Microsoft Teams 通知(オブジェクト)、OpsGenie 通知(オブジェクト)、OpsGenie 通知(オブジェクト)、組織通知(オブジェクト)、PagerDuty 通知(オブジェクト)、Slack 通知(オブジェクト)、SMS 通知(オブジェクト)、チーム通知(オブジェクト)、ユーザー通知(オブジェクト)、VictorOps 通知(オブジェクト)、Webhook 通知(オブジェクト)のいずれか (AlertsNotificationRootForGroup) MongoDB Cloud が通知を送信するターゲットを含むリスト。 |
{- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
]
}
{- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "updated": "2019-08-24T14:15:22Z"
}
指定されたアラートに設定されているすべてのアラート構成を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertId 必須 | string^([a-f0-9]{24})$ アラートを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのアラートを取得するには、/alerts エンドポイントを使用します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
{- "results": [
- {
- "created": "2019-08-24T14:15:22Z",
- "enabled": false,
- "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "matchers": [
- {
- "fieldName": "string",
- "operator": "EQUALS",
- "value": "event-replica-set"
}
], - "notifications": [
- {
- "datadogApiKey": "****************************a23c",
- "datadogRegion": "US",
- "delayMin": 0,
- "integrationId": "32b6e34b3d91647abb20e7b8",
- "intervalMin": 5,
- "notifierId": "32b6e34b3d91647abb20e7b8",
- "typeName": "DATADOG"
}
], - "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}
指定されたアラート構成がトリガーするすべてのオープン アラートを返します。これらのアラート構成は、指定されたプロジェクトにのみ適用されます。アラート構成では、アラートの Triggers と通知方法を定義します。オープン アラートは、トリガーされていても、まだ未確認です。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertConfigId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 アラート構成を識別するユニークな 24 桁の 16 進数の文字列。/alertConfigs エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのアラート構成を取得します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "acknowledgingUsername": "user@example.com",
- "alertConfigId": "32b6e34b3d91647abb20e7b8",
- "created": "2019-08-24T14:15:22Z",
- "eventTypeName": "DEPLOYMENT_FAILURE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "lastNotified": "2019-08-24T14:15:22Z",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}
すべてのアラートを返します。これらのアラートは、1 つのプロジェクト内のすべてのコンポーネントに適用されます。モニター対象のコンポーネントが設定した値を満たすか超過すると、アラートを受け取ります。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty | |
状態 | string 列挙: "OPEN" "TRACKING" "CLOSED" 返すアラートのステータス。省略すると、すべてのステータスのすべてのアラートが返されます。 |
{- "results": [
- {
- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "acknowledgingUsername": "user@example.com",
- "alertConfigId": "32b6e34b3d91647abb20e7b8",
- "created": "2019-08-24T14:15:22Z",
- "eventTypeName": "DEPLOYMENT_FAILURE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "lastNotified": "2019-08-24T14:15:22Z",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}
アラートを 1 つ返します。このアラートは、1 つのプロジェクト内の任意のコンポーネントに適用されます。モニター対象のコンポーネントが設定した値を満たすか超過すると、アラートを受け取ります。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertId 必須 | string^([a-f0-9]{24})$ アラートを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのアラートを取得するには、/alerts エンドポイントを使用します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "acknowledgingUsername": "user@example.com",
- "alertConfigId": "32b6e34b3d91647abb20e7b8",
- "created": "2019-08-24T14:15:22Z",
- "eventTypeName": "DEPLOYMENT_FAILURE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "lastNotified": "2019-08-24T14:15:22Z",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}
既存のアラートを 1 つ受信していることを確認します。このアラートは、1 つのプロジェクト内の任意のコンポーネントに適用されます。アラートを確認すると、通知が連続して行われなくなります。モニター対象コンポーネントが設定した値を満たすか上回ると、アラートを確認するまでアラートが送信されます。このリソースを使用するには、リクエスト元の API キーに組織オーナーまたはプロジェクト オーナーのロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。非推奨のバージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
alertId 必須 | string^([a-f0-9]{24})$ アラートを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのアラートを取得するには、/alerts エンドポイントを使用します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
1 つのアラートを確認または未確認にします。
acknowledgedUntil | string <date-time> このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。 |
acknowledgementComment | string <= 200 文字 MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。 |
unacknowledgeAlert | ブール値 以前に確認されたアラートを未確認にすることを示すフラグ。この値は、デフォルトで false に設定されています。true に設定されると、acknowledgedUntil パラメータが上書きされます。 |
{- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "unacknowledgeAlert": true
}
{- "acknowledgedUntil": "2019-08-24T14:15:22Z",
- "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
- "acknowledgingUsername": "user@example.com",
- "alertConfigId": "32b6e34b3d91647abb20e7b8",
- "created": "2019-08-24T14:15:22Z",
- "eventTypeName": "DEPLOYMENT_FAILURE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "lastNotified": "2019-08-24T14:15:22Z",
- "orgId": "32b6e34b3d91647abb20e7b8",
- "resolved": "2019-08-24T14:15:22Z",
- "status": "OPEN",
- "updated": "2019-08-24T14:15:22Z"
}
指定されたコレクションに 1 つの Atlas Search インデックスを作成します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。MongoDB v4.2 以降を実行しているクラスターのみが Atlas Search を使用できます。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search インデックスを作成するコレクションを含むクラスターの名前。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたコレクションに 1 つの Atlas Search インデックスを作成します。
コレクション名 必須 | string 1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。 |
database 必須 | string 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。 |
name 必須 | string このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。 |
numPartitions | integer <int32> デフォルト: 1 インデックスパーティションの数。 注:この機能は現在プレビュー段階です。 |
タイプ | string インデックスのタイプ。デフォルトのタイプは検索です。 |
analyzer | string デフォルト: "lucene.standard" 列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" データベース フィールド テキストを検索可能な単語に変換するために選択された特定の定義済みメソッド。この変換により、フィールドのテキストが最小のテキスト単位に縮小されます。これらの単位はタームまたはトークンと呼ばれます。トークン化と呼ばれるこのプロセスでは、フィールド内のテキストにさまざまな変更が加えられます。
|
オブジェクト (マッピング) コレクションのフィールドのインデックス仕様。 | |
searchAnalyzer | string デフォルト: "lucene.standard" 列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" このインデックスを検索するときに単語を識別するために適用される方法。 |
storedSource | オブジェクト Atlas Search にすべてのフィールド (true) を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません (false)。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか (include)、または保存しないフィールドのリストを含む (exclude) オブジェクトを指定することもできます。詳細については、ドキュメントを参照してください。 |
{- "collectionName": "string",
- "database": "string",
- "name": "string",
- "numPartitions": 1,
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
指定されたコレクションにすべての Atlas Search インデックスを返します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス読み取り書込みロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。 |
コレクション名 必須 | string 1 つ以上の Atlas Search インデックスを含むコレクションの名前。 |
databaseName 必須 | string 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- {
- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search"
}
]
ユニークな ID で識別した 1 つの Atlas Search インデックスを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上のアプリケーション検索インデックスを持つデータベースとコレクションを含むクラスターの名前。 |
indexId 必須 | string^([a-f0-9]{24})$ Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクト内の 1 つの Atlas Search インデックスを返します。このインデックスは、ユニークな ID を使用して識別します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス読み取り書込みロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。 |
indexId 必須 | string^([a-f0-9]{24})$ アプリケーション検索インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべてのアプリケーション検索インデックスを取得するエンドポイントを使用して、すべてのアプリケーション検索インデックスの ID を検索します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
ユニークな ID で識別した 1 つの Atlas Search インデックスを更新します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search インデックスを更新するコレクションを含むクラスターの名前。 |
indexId 必須 | string^([a-f0-9]{24})$ Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
Atlas Search インデックスに更新する詳細。
コレクション名 必須 | string 1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。 |
database 必須 | string 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。 |
name 必須 | string このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。 |
numPartitions | integer <int32> デフォルト: 1 インデックスパーティションの数。 注:この機能は現在プレビュー段階です。 |
タイプ | string インデックスのタイプ。デフォルトのタイプは検索です。 |
analyzer | string デフォルト: "lucene.standard" 列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" データベース フィールド テキストを検索可能な単語に変換するために選択された特定の定義済みメソッド。この変換により、フィールドのテキストが最小のテキスト単位に縮小されます。これらの単位はタームまたはトークンと呼ばれます。トークン化と呼ばれるこのプロセスでは、フィールド内のテキストにさまざまな変更が加えられます。
|
オブジェクト (マッピング) コレクションのフィールドのインデックス仕様。 | |
searchAnalyzer | string デフォルト: "lucene.standard" 列挙: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian" このインデックスを検索するときに単語を識別するために適用される方法。 |
storedSource | オブジェクト Atlas Search にすべてのフィールド (true) を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません (false)。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか (include)、または保存しないフィールドのリストを含む (exclude) オブジェクトを指定することもできます。詳細については、ドキュメントを参照してください。 |
{- "collectionName": "string",
- "database": "string",
- "name": "string",
- "numPartitions": 1,
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "name": "string",
- "numPartitions": 1,
- "status": "IN_PROGRESS",
- "type": "search",
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "ignoredTags": [
- "string"
], - "type": "htmlStrip"
}
], - "name": "string",
- "tokenFilters": [
- {
- "originalTokens": "omit",
- "type": "asciiFolding"
}
], - "tokenizer": {
- "maxGram": 0,
- "minGram": 0,
- "type": "edgeGram"
}
}
], - "mappings": {
- "dynamic": false,
- "fields": {
- "property1": { },
- "property2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
指定されたクラスターの検索ノードを削除します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 削除するクラスターを識別するラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたクラスターの検索ノードを返します。非推奨バージョン: v2-{2024-05-30}、v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 検索ノードを返すクラスターを識別するラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "encryptionAtRestProvider": "NONE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
], - "stateName": "IDLE"
}
指定されたクラスターの検索ノードを更新します。非推奨のバージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 検索ノードを更新するクラスターを識別するラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたクラスターの検索ノードを更新します。
必須 | の配列 オブジェクト (ApiSearchDeploymentSpecView) = 1 アイテム クラスターの検索ノードを構成する設定のリスト。 注: 現在、すべてのノードに対して単一の構成を受け入れています。 |
{- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
]
}
{- "encryptionAtRestProvider": "NONE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
], - "stateName": "IDLE"
}
指定されたクラスターの検索ノードを作成します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 検索ノードを作成するクラスターを識別するラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたクラスターの検索ノードを作成します。
必須 | の配列 オブジェクト (ApiSearchDeploymentSpecView) = 1 アイテム クラスターの検索ノードを構成する設定のリスト。 注: 現在、すべてのノードに対して単一の構成を受け入れています。 |
{- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
]
}
{- "encryptionAtRestProvider": "NONE",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "specs": [
- {
- "instanceSize": "S20_HIGHCPU_NVME",
- "nodeCount": 2
}
], - "stateName": "IDLE"
}
指定されたクラスター上のすべての Atlas Search インデックスを返します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス読み取り書込みロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- {
- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "status": "DELETING"
}
], - "type": "search"
}
]
指定されたコレクションに 1 つの Atlas Search インデックスを作成します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。MongoDB v4.2 以降を実行しているクラスターのみが Atlas Search を使用できます。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search インデックスを作成するコレクションを含むクラスターの名前。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたコレクションに 1 つの Atlas Search インデックスを作成します。
コレクション名 必須 | string Atlas Search インデックスを作成するコレクションを識別するラベル。 |
database 必須 | string Atlas Search インデックスを作成するコレクションを含むデータベースを識別するラベル。 |
name 必須 | string このインデックスを識別するラベル。 各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。 |
タイプ | string インデックスのタイプ。デフォルトのタイプは検索です。 |
必須 | オブジェクト (テキスト検索インデックスの定義) ユーザーが設定したテキスト検索インデックスの定義。 |
{- "collectionName": "string",
- "database": "string",
- "name": "string",
- "type": "search",
- "definition": {
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "numPartitions": 1,
- "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
}
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}
指定されたコレクションにすべての Atlas Search インデックスを返します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス読み取り書込みロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。 |
コレクション名 必須 | string 1 つ以上の Atlas Search インデックスを含むコレクションの名前。 |
databaseName 必須 | string 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- {
- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING"
}, - "status": "DELETING"
}
], - "type": "search"
}
]
データベース、コレクション、および名前で識別した Atlas Search インデックスを 1 つ削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。この削除は結果整合性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上のアプリケーション検索インデックスを持つデータベースとコレクションを含むクラスターの名前。 |
コレクション名 必須 | string 1 つ以上の Atlas Search インデックスを含むコレクションの名前。 |
databaseName 必須 | string 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。 |
indexName 必須 | string 削除する Atlas Search インデックスの名前。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクト内の 1 つの Atlas Search インデックスを返します。このインデックスは、データベース、コレクション、および名前を使用して識別します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス読み取り書込みロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。 |
コレクション名 必須 | string 1 つ以上の Atlas Search インデックスを含むコレクションの名前。 |
databaseName 必須 | string 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。 |
indexName 必須 | string 返す対象の Atlas Search インデックスの名前。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}
データベース、コレクション、名前、およびインデックス名で識別した Atlas Search インデックスを 1 つ削除します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search インデックスを更新するコレクションを含むクラスターの名前。 |
コレクション名 必須 | string 1 つ以上の Atlas Search インデックスを含むコレクションの名前。 |
databaseName 必須 | string 1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別するラベル。 |
indexName 必須 | string 更新する Atlas Search インデックスの名前。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
Atlas Search インデックスに更新する詳細。
必須 | テキスト検索インデックス定義(オブジェクト)またはベクトル検索インデックス定義(オブジェクト) 検索インデックスを更新するインデックス定義。 |
{- "definition": {
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "numPartitions": 1,
- "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
}
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}
ユニークな ID で識別した 1 つの Atlas Search インデックスを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。この削除は結果整合性があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上のアプリケーション検索インデックスを持つデータベースとコレクションを含むクラスターの名前。 |
indexId 必須 | string^([a-f0-9]{24})$ Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクト内の 1 つの Atlas Search インデックスを返します。このインデックスは、ユニークな ID を使用して識別します。Atlas Search インデックスには、インデックス付きフィールドと、インデックスの作成に使用されたアナライザが含まれています。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス読み取り書込みロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 1 つ以上の Atlas Search インデックスを持つコレクションを含むクラスターの名前。 |
indexId 必須 | string^([a-f0-9]{24})$ アプリケーション検索インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべてのアプリケーション検索インデックスを取得するエンドポイントを使用して、すべてのアプリケーション検索インデックスの ID を検索します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}
ユニークな ID で識別した 1 つの Atlas Search インデックスを更新します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクト データアクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search インデックスを更新するコレクションを含むクラスターの名前。 |
indexId 必須 | string^([a-f0-9]{24})$ Atlas Search インデックスを識別するユニークな 24 桁の 16 進数文字列。コレクション API のすべての Atlas Search インデックスを取得するエンドポイントを使用して、すべての Atlas Search インデックスの ID を検索します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
Atlas Search インデックスに更新する詳細。
必須 | テキスト検索インデックス定義(オブジェクト)またはベクトル検索インデックス定義(オブジェクト) 検索インデックスを更新するインデックス定義。 |
{- "definition": {
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "numPartitions": 1,
- "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}
}
{- "collectionName": "string",
- "database": "string",
- "indexID": "32b6e34b3d91647abb20e7b8",
- "latestDefinition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "latestDefinitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "name": "string",
- "queryable": true,
- "status": "DELETING",
- "statusDetail": [
- {
- "hostname": "string",
- "mainIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "queryable": true,
- "stagedIndex": {
- "definition": {
- "numPartitions": 1,
- "analyzer": "lucene.standard",
- "analyzers": [
- {
- "charFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "name": "string",
- "tokenFilters": [
- {
- "property1": { },
- "property2": { }
}
], - "tokenizer": {
- "property1": { },
- "property2": { }
}
}
], - "mappings": {
- "dynamic": true,
- "fields": {
- "Field Name1": { },
- "Field Name2": { }
}
}, - "searchAnalyzer": "lucene.standard",
- "storedSource": {
- "include | exclude": [
- "field1",
- "field2"
]
}, - "synonyms": [
- {
- "analyzer": "lucene.standard",
- "name": "string",
- "source": {
- "collection": "string"
}
}
]
}, - "definitionVersion": {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": 0
}, - "message": "string",
- "queryable": true,
- "status": "DELETING",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}, - "status": "DELETING"
}
], - "type": "search",
- "synonymMappingStatus": "FAILED",
- "synonymMappingStatusDetail": [
- {
- "property1": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}, - "property2": {
- "message": "string",
- "queryable": true,
- "status": "FAILED"
}
}
]
}
指定したプロジェクトの監査構成を返します。監査構成は、MongoDB Cloud が監査ログに記録するイベントを定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。この機能は、M0
、M2
、M5
、またはサーバーレス クラスターでは使用できません。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "auditAuthorizationSuccess": false,
- "auditFilter": "string",
- "configurationType": "NONE",
- "enabled": false
}
指定したプロジェクトの監査構成を更新します。監査構成は、MongoDB Cloud が監査ログに記録するイベントを定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。この機能は、M0
、M2
、M5
、またはサーバーレス クラスターでは使用できません。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定したプロジェクトの更新された監査構成。
auditAuthorizationSuccess | ブール値 デフォルト: false 成功した認証を追跡するように監査を誰かが設定したかどうかを示すフラグ。これは、 |
auditFilter | string レコードするイベントを指定する JSON ドキュメント。一重引用符や二重引用符など、解析を妨げる可能性のある文字は、バックスラッシュ( |
enabled | ブール値 デフォルト: false 指定されたプロジェクトに対して誰かがデータベース監査を有効にしたかどうかを示すフラグ。 |
{- "auditAuthorizationSuccess": false,
- "auditFilter": "string",
- "enabled": false
}
{- "auditAuthorizationSuccess": false,
- "auditFilter": "string",
- "configurationType": "NONE",
- "enabled": false
}
AWS での MongoDB Cloud データベース配置のカスタム DNS 構成の返却と編集を行います。リソースにはプロジェクト ID が必要です。AWS で VPC ピアリングを使用し、Amazon Route 53 の代わりに独自の DNS サーバーを使用する場合は、カスタム DNS を有効にします。2020 年 3 月 31 日より前は、カスタム DNS サービスを使用して AWS 内に配置され、MongoDB Cloud と VPC ピアリングされたアプリケーションは、プライベート IP アドレス経由で接続できませんでした。カスタム DNS はパブリック IP アドレスに解決されました。AWS の内部 DNS がプライベート IP アドレスに解決されました。カスタム DNS サービスを使用して AWS に配置されたアプリケーションは、ピアリング接続文字列にプライベート IP を使用する必要があります。
指定されたプロジェクト内の AWS クラスターのカスタム DNS 構成を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "enabled": true
}
指定されたプロジェクト内の AWS クラスターのカスタム DNS 構成を有効または無効にします。AWS VPC ピアリングを使用し、独自の DNS サーバーを使用する場合は、カスタム DNS を有効にします。このリソースを使用するには、リクエスト元の API キーに Project Atlas の管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクト内の AWS クラスターのカスタム DNS 構成を有効または無効にします。
enabled 必須 | ブール値 AWS(Amazon Web Services)に配置されたプロジェクトのクラスターがカスタム DNS(Domain Name System)を使用するかどうかを示すフラグ。 |
{- "enabled": true
}
{- "enabled": true
}
クラウドバックアップ スナップショット、スナップショット エクスポート バケット、復元ジョブ、およびスケジュールを管理します。このリソースは、クラウドバックアップを使用するクラスターにのみ適用されます。
指定されたプロジェクトに関連付けられているすべてのエクスポート バケットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "_id": "32b6e34b3d91647abb20e7b8",
- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
- "iamRoleId": "32b6e34b3d91647abb20e7b8"
}
], - "totalCount": 0
}
AWS S3 バケットまたは Azure Blob ストレージ コンテナのスナップショット エクスポート バケットを作成します。作成が完了すると、スナップショットはエクスポート バケットと、その参照先の AWS S 3 バケットまたは Azure Blob ストレージ コンテナにエクスポートできます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
エクスポート バケットが参照するロールと AWS S3 バケットまたは Azure Blob ストレージ コンテナを指定します。
bucketName 必須 | string [ 3 .. 63 ] 文字 ロールがエクスポートを許可されているAmazon Web Services S3 バケットまたはAzureストレージ コンテナを識別する、人間が判読できるラベル。 |
cloudProvider 必須 | string スナップショットがエクスポートされるクラウドプロバイダーを識別する、人間が判読可能なラベル。 |
iamRoleId 必須 | string^([a-f0-9]{24})$ MongoDB Cloud が AWS S3 バケットにアクセスするために使用する Unified AWS Access ロール ID を識別する、一意の 24 桁の 16 進文字列。 |
Amazon Web Services
{- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
- "iamRoleId": "668c5f0ed436263134491592"
}
Amazon Web Services
{- "_id": "32b6e34b3d91647abb20e7b8",
- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
- "iamRoleId": "668c5f0ed436263134491592",
}
エクスポートバケットを削除します。アクセスを取り消す前に、このエクスポートバケットにエクスポートしているこのプロジェクトのすべてのクラスターで、自動エクスポートを無効にする必要があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
exportBucketId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 エクスポート バケットを識別する一意の 24 16 進数文字string 。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{ }
指定されたプロジェクトに関連付けられた 1 つのエクスポート バケットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
exportBucketId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 エクスポート バケットを識別する一意の 24 16 進数文字string 。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
Amazon Web Services
{- "_id": "32b6e34b3d91647abb20e7b8",
- "bucketName": "export-bucket",
- "cloudProvider": "AWS",
- "iamRoleId": "668c5f0ed436263134491592",
}
指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を無効にします。前提条件として、サポートチケットを最初にファイルする必要があります。手順は https://www.mongodb.com/ja-jp/docs/atlas/backup/cloud-backup/backup-compliance-policy/ で閲覧できます。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "authorizedEmail": "user@example.com",
- "authorizedUserFirstName": "string",
- "authorizedUserLastName": "string",
- "copyProtectionEnabled": false,
- "deletable": false,
- "encryptionAtRestEnabled": false,
- "onDemandPolicyItem": {
- "frequencyInterval": 0,
- "frequencyType": "ondemand",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}, - "pitEnabled": false,
- "projectId": "32b6e34b3d91647abb20e7b8",
- "restoreWindowDays": 0,
- "scheduledPolicyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
], - "state": "ACTIVE",
- "updatedDate": "2019-08-24T14:15:22Z",
- "updatedUser": "user@example.com"
}
指定されたプロジェクトのバックアップ コンプライアンス ポリシー設定を更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
overwriteBackupPolicies | ブール値 デフォルト: true 非準拠のバックアップ ポリシーを新しいデータ保護設定で上書きするかどうかを示すフラグ。 |
pretty |
新しいバックアップ コンプライアンス ポリシー設定。
authorizedEmail 必須 | string <email> バックアップ コンプライアンス ポリシー設定の更新を許可したユーザーのメールアドレス。 |
authorizedUserFirstName 必須 | string バックアップ コンプライアンス ポリシー設定の更新を許可したユーザーの名。 |
authorizedUserLastName 必須 | string バックアップ コンプライアンス ポリシー設定の更新を許可したユーザーの姓。 |
copyProtectionEnabled | ブール値 デフォルト: false 追加のスナップショット リージョンが削除された場合でも、クラスター ユーザーが他のリージョンにコピーされたバックアップを削除できないようにするかどうかを示すフラグ。指定されていない場合、デフォルト値は false です。 |
encryptionAtRestEnabled | ブール値 デフォルト: false バックアップ コンプライアンス ポリシーが設定されているすべてのクラスターで、カスタマー キー管理を使用した保管時の暗号化が必要かどうかを示すフラグ。指定されていない場合、デフォルト値は false です。 |
オブジェクト (BackupComplianceOnDemandPolicyItem) オンデマンド ポリシーの仕様。 | |
pitEnabled | ブール値 デフォルト: false クラスターがバックアップ コンプライアンス ポリシーを使用して継続的なクラウドバックアップを使用するかどうかを示すフラグ。指定されていない場合、デフォルト値は false です。 |
projectId | string^([a-f0-9]{24})$ バックアップ コンプライアンス ポリシーの対象となるプロジェクトを識別するユニークな 24 桁の 16 進数の文字列。 |
restoreWindowDays | integer <int32> バックアップ コンプライアンス ポリシーを使用して継続的なクラウドバックアップで復元できる過去の日数。0 以外の正の整数を指定する必要があります。また、最大保持期間は 1 時間あたりの保持期間を超えることはできません。このパラメータは、バックアップ コンプライアンス ポリシーが設定された継続的なクラウドバックアップにのみ適用されます。 |
の配列 オブジェクト (BackupComplianceScheduledPolicyItem) 1 つのスケジュールされたポリシーの仕様を含むリスト。 |
{- "authorizedEmail": "user@example.com",
- "authorizedUserFirstName": "string",
- "authorizedUserLastName": "string",
- "copyProtectionEnabled": false,
- "encryptionAtRestEnabled": false,
- "onDemandPolicyItem": {
- "frequencyInterval": 0,
- "frequencyType": "ondemand",
- "retentionUnit": "days",
- "retentionValue": 0
}, - "pitEnabled": false,
- "projectId": "32b6e34b3d91647abb20e7b8",
- "restoreWindowDays": 0,
- "scheduledPolicyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
{- "authorizedEmail": "user@example.com",
- "authorizedUserFirstName": "string",
- "authorizedUserLastName": "string",
- "copyProtectionEnabled": false,
- "deletable": false,
- "encryptionAtRestEnabled": false,
- "onDemandPolicyItem": {
- "frequencyInterval": 0,
- "frequencyType": "ondemand",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}, - "pitEnabled": false,
- "projectId": "32b6e34b3d91647abb20e7b8",
- "restoreWindowDays": 0,
- "scheduledPolicyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
], - "state": "ACTIVE",
- "updatedDate": "2019-08-24T14:15:22Z",
- "updatedUser": "user@example.com"
}
指定した Atlas クラスターに関連付けられているすべてのクラウドバックアップ スナップショットのエクスポート ジョブを返します。このリソースを使用するには、リクエスト元の API キーに Project Atlas の管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
{- "results": [
- {
- "components": [
- {
- "exportId": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "exportStatus": {
- "exportedCollections": 0,
- "totalCollections": 0
}, - "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "prefix": "string",
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "state": "Cancelled",
- "stateReason": {
- "errorCode": "string",
- "message": "string"
}
}
], - "totalCount": 0
}
クラウドバックアップを使用して専用の Atlas クラスターの 1 つのバックアップスナップショットをエクスポート バケットにエクスポートします。 このリソースを使用するには、リクエスト元のAPIキーに Project Atlas の管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
作成するクラウドバックアップ スナップショットのエクスポート ジョブに関する情報。
の配列 オブジェクト (BackupLabel) エクスポート ジョブの完了時に MongoDB Cloud がバケットにアップロードするメタデータ ファイルに追加するカスタム データを表すキーと値のペアのコレクション。 | |
exportBucketId 必須 | string^([a-f0-9]{24})$ エクスポート バケットを識別する一意の 24 16 進数文字string 。 |
snapshotId 必須 | string^([a-f0-9]{24})$ エクスポートするクラウドバックアップ スナップショットを識別する一意の 24 桁の 16 進数文字string 。 |
{- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "snapshotId": "32b6e34b3d91647abb20e7b8"
}
{- "components": [
- {
- "exportId": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "exportStatus": {
- "exportedCollections": 0,
- "totalCollections": 0
}, - "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "prefix": "string",
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "state": "Cancelled",
- "stateReason": {
- "errorCode": "string",
- "message": "string"
}
}
指定した Atlas クラスターに関連付けられている 1 つのクラウドバックアップ スナップショットのエクスポート ジョブを返します。このリソースを使用するには、リクエスト元の API キーに Project Atlas の管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
exportId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 24エクスポートstring ジョブを識別する一意の 16 進数文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "components": [
- {
- "exportId": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "customData": [
- {
- "key": "string",
- "value": "string"
}
], - "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "exportStatus": {
- "exportedCollections": 0,
- "totalCollections": 0
}, - "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "prefix": "string",
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "state": "Cancelled",
- "stateReason": {
- "errorCode": "string",
- "message": "string"
}
}
指定されたプロジェクトから、1 つのクラスターに対するすべてのクラウドバックアップ復元ジョブを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 返す対象である復元ジョブを持つクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "cancelled": true,
- "components": [
- {
- "downloadUrl": "string",
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "replicaSetName": "string"
}
], - "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}
指定したプロジェクトから 1 つのクラスターの 1 つのスナップショットを復元します。Atlas は、オンデマンド スナップショットをすぐに取得し、スケジュールされたスナップショットを定期的に取得します。ステータスが queued または inProgress のオンデマンド スナップショットが存在する場合は、別のスナップショットを作成する前に、Atlas が以前に取得したオンデマンド スナップショットの処理を完了するまで待ちます。
このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定したプロジェクトから 1 つのクラスターの 1 つのスナップショットを復元します。
deliveryType 必須 | string 列挙: "automated" 「ダウンロード」 "pointInTime" 作成する復元ジョブを分類する、人間が判読できるラベル。 |
oplogInc | integer <int32> >= 1 このスナップショットを復元したい Oplog 操作の番号。この数字は Oplog タイムスタンプの 2 番目の部分を表します。 |
oplogTs | integer <int32> >= 1199145600 このスナップショットを復元する日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。この数字は Oplog タイムスタンプの最初の部分を表します。 |
pointInTimeUTCSeconds | integer <int32> >= 1199145600 MongoDB Cloud がこのスナップショットを復元した日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。 |
snapshotId | string^([a-f0-9]{24})$ スナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
targetClusterName | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 復元ジョブがスナップショットを復元するターゲット クラスターを識別する、人間が判読できるラベル。リソースは、 |
targetGroupId | string^([a-f0-9]{24})$ 指定された targetClusterNameの のターゲット プロジェクトを識別する、ユニークな 24 桁 16 進数の文字列。 |
{- "deliveryType": "automated",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8"
}
{- "cancelled": true,
- "components": [
- {
- "downloadUrl": "string",
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "replicaSetName": "string"
}
], - "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
指定されたプロジェクトからの 1 つのクラスターの、クラウドバックアップ復元ジョブを 1 件キャンセルします。このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
restoreJobId 必須 | string^([a-f0-9]{24})$ 削除する復元ジョブを識別するユニークな 24 桁の 16 進数文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクトからの 1 つのクラスターの、クラウドバックアップ復元ジョブを 1 件返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 返す対象である復元ジョブを持つクラスターを識別する、人間が判読できるラベル。 |
restoreJobId 必須 | string^([a-f0-9]{24})$ 返す対象である復元ジョブを識別するユニークな 24 桁の 16 進数文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "cancelled": true,
- "components": [
- {
- "downloadUrl": "string",
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "replicaSetName": "string"
}
], - "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "privateDownloadDeliveryUrls": [
- {
- "deliveryUrl": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1"
}
], - "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
指定したクラスターのすべてのクラウドバックアップ スケジュールを削除します。このスケジュールは、MongoDB Cloud がスケジュールされたスナップショットをいつ取得するか、またそれらのスナップショットをどのくらいの期間保存するかを定義します。このリソースを使用するには、リクエスト元の API キーに Project Atlas の管理者ロールが必要です。 非推奨のバージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "autoExportEnabled": true,
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "nextSnapshot": "2019-08-24T14:15:22Z",
- "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "useOrgAndGroupNamesInExportPrefix": true
}
指定したプロジェクト内の指定したクラスターのクラウドバックアップ スケジュールを返します。このスケジュールは、MongoDB Cloud がスケジュールされたスナップショットをいつ取得するか、またそれらのスナップショットをどのくらいの期間保存するかを定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。非推奨のバージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "autoExportEnabled": true,
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "nextSnapshot": "2019-08-24T14:15:22Z",
- "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "useOrgAndGroupNamesInExportPrefix": true
}
指定されたプロジェクト内の 1 つのクラスターのクラウドバックアップ スケジュールを更新します。このスケジュールは、MongoDB Cloud がスケジュールされたスナップショットをいつ取得するか、またそれらのスナップショットをどのくらいの期間保存するかを定義します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。非推奨のバージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクト内の 1 つのクラスターのクラウドバックアップ スケジュールを更新します。
注: リクエスト本文には、更新するフィールドのみを指定します。
autoExportEnabled | ブール値 MongoDB Cloud がクラウドバックアップ スナップショットをエクスポート バケットに自動的にエクスポートするかどうかを示すフラグ。 |
の配列 オブジェクト (DiskBackupCopySetting 20240805 ) 目的のバックアップ ポリシー内の各コピー設定アイテムのドキュメントを含むリスト。 | |
の配列 オブジェクト (DeleteCopiedBackups 20240805 ) 削除対象のバックアップ コピーを持つ削除済みコピー設定ごとのドキュメントを含むリスト。 | |
オブジェクト (エクスポート) クラウドバックアップのスナップショットを自動的にエクスポートするポリシー。 | |
の配列 オブジェクト (ExtraRetentionSetting) 目的のバックアップ ポリシー内の余分な保持設定アイテムごとのドキュメントを含むリスト。 | |
の配列 オブジェクト (AdvancedDiskBackupSnapshotSchedulePolicy) <= 1 アイテム このバックアップ スケジュールに設定されたルール。 | |
referenceHourOfDay | integer <int32> MongoDB Cloud がスナップショットを取得する時刻を表す UTC(Coordinated Universal Time、協定世界時)の時刻。 |
referenceMinuteOfHour | integer <int32> MongoDB Cloud がスナップショットを取得する時間を表す referenceHourOfDay の分の単位。 |
restoreWindowDays | integer <int32> 継続的なクラウドバックアップの精度で復元できる過去の日数。0 以外の正の整数を指定する必要があります。このパラメータは継続的なクラウドバックアップにのみ適用されます。 |
updateSnapshots | ブール値 更新されたバックアップ ポリシーの保持の変更を、MongoDB Cloud が以前に取得したスナップショットに適用するかどうかを示すフラグ。 |
useOrgAndGroupNamesInExportPrefix | ブール値 MongoDB Cloud がエクスポート バケットにアップロードするメタデータ ファイルのパスに、組織 UUID とプロジェクト UUID の代わりに組織名とプロジェクト名を使用するかどうかを示すフラグ。 |
{- "autoExportEnabled": true,
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "deleteCopiedBackups": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "updateSnapshots": true,
- "useOrgAndGroupNamesInExportPrefix": true
}
{- "autoExportEnabled": true,
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "copySettings": [
- {
- "cloudProvider": "AWS",
- "frequencies": [
- "HOURLY"
], - "regionName": "string",
- "shouldCopyOplogs": true,
- "zoneId": "32b6e34b3d91647abb20e7b8"
}
], - "export": {
- "exportBucketId": "32b6e34b3d91647abb20e7b8",
- "frequencyType": "monthly"
}, - "extraRetentionSettings": [
- {
- "frequencyType": "HOURLY",
- "retentionDays": 0
}
], - "nextSnapshot": "2019-08-24T14:15:22Z",
- "policies": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "policyItems": [
- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
}
], - "referenceHourOfDay": 0,
- "referenceMinuteOfHour": 0,
- "restoreWindowDays": 0,
- "useOrgAndGroupNamesInExportPrefix": true
}
指定されたプロジェクトから 1 つのクラスターのすべてのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
], - "totalCount": 0
}
指定されたクラスターのオンデマンド スナップショットを 1 つ取得します。Atlas は、オンデマンド スナップショットをすぐに取得し、スケジュールされたスナップショットを定期的に取得します。ステータスが queued または inProgress のオンデマンド スナップショットが存在する場合は、別のスナップショットを作成する前に、Atlas が以前に取得したオンデマンド スナップショットの処理を完了するまで待ちます。
このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
1 つのオンデマンド スナップショットを取得します。
説明 | string スナップショットの目的を説明する、人間が判読できるフレーズまたは文章。 |
retentionInDays | integer <int32> >= 1 MongoDB Cloud がスナップショットを保持する必要がある日数。最低でも 1 である必要があります。 |
{- "description": "string",
- "retentionInDays": 1
}
{- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
指定されたプロジェクトから 1 つのシャーディングされたクラスターのスナップショットを 1 つ削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
snapshotId 必須 | string^([a-f0-9]{24})$ 目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクトから 1 つのシャーディングされたクラスターの 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
snapshotId 必須 | string^([a-f0-9]{24})$ 目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "configServerType": "EMBEDDED",
- "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "members": [
- {
- "cloudProvider": "AWS",
- "id": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotIds": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
指定されたプロジェクトの 1 つのシャーディングされたクラスターのすべてのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "results": [
- {
- "configServerType": "EMBEDDED",
- "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "members": [
- {
- "cloudProvider": "AWS",
- "id": "32b6e34b3d91647abb20e7b8",
- "replicaSetName": "string"
}
], - "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotIds": [
- "32b6e34b3d91647abb20e7b8"
], - "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
], - "totalCount": 0
}
指定されたスナップショットを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
snapshotId 必須 | string^([a-f0-9]{24})$ 目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたクラスターから 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
snapshotId 必須 | string^([a-f0-9]{24})$ 目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
指定されたプロジェクトの 1 つのクラスターに対する 1 つのクラウド バックアップ スナップショットの有効期限を変更します。リクエストする API キーにはプロジェクト バックアップ マネージャー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
snapshotId 必須 | string^([a-f0-9]{24})$ 目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクトの 1 つのクラスターの 1 つのクラウドバックアップ スナップショットの有効期限を変更します。
retentionUnit 必須 | string 列挙: "DAYS" "WEEKS" "MONTHS" 「年」 MongoDB Cloud がスナップショットの保持を測定する時間の量。 |
retentionValue 必須 | integer <int32> MongoDB Cloud がスナップショットを保持する日数、週数、月数、または年数を示す数値。頻度の低いポリシーアイテムの場合、MongoDB Cloud では、頻度の高いポリシーアイテムに指定された値以上の値を指定する必要があります。時間単位のポリシーアイテムで 2 日間の保存が指定されている場合は、週単位のポリシーアイテムの保存期間として 2 日以上を指定します。 |
{- "retentionUnit": "DAYS",
- "retentionValue": 5
}
{- "cloudProvider": "AWS",
- "copyRegions": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
- "mongodVersion": "string",
- "policyItems": [
- "32b6e34b3d91647abb20e7b8"
], - "replicaSetName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0,
- "type": "replicaSet"
}
指定されたプロジェクトから 1 つのサーバーレスインスタンスのすべての復元ジョブを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに listFlexBackupRestoreJobs エンドポイントを使用してください。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ サーバーレスインスタンスを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "cancelled": true,
- "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
], - "totalCount": 0
}
指定されたプロジェクトから 1 つのサーバーレスインスタンスの 1 つのスナップショットを復元します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに createFlexBackupRestoreJob エンドポイントを使用してください。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 復元対象のスナップショットを持つサーバーレスインスタンスを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクトから 1 つのサーバーレスインスタンスの 1 つのスナップショットを復元します。
deliveryType 必須 | string 列挙: "automated" 「ダウンロード」 "pointInTime" 作成する復元ジョブを分類する、人間が判読できるラベル。 |
oplogInc | integer <int32> >= 1 このスナップショットを復元したい Oplog 操作の番号。この数字は Oplog タイムスタンプの 2 番目の部分を表します。 |
oplogTs | integer <int32> >= 1199145600 このスナップショットを復元する日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。この数字は Oplog タイムスタンプの最初の部分を表します。 |
pointInTimeUTCSeconds | integer <int32> >= 1199145600 MongoDB Cloud がこのスナップショットを復元した日時。このパラメータは、このタイムスタンプを UNIX エポックからの経過秒数で表します。 |
snapshotId | string^([a-f0-9]{24})$ スナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
targetClusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 復元ジョブがスナップショットを復元するターゲット クラスターを識別する、人間が判読できるラベル。リソースは、 |
targetGroupId 必須 | string^([a-f0-9]{24})$ 指定された targetClusterName のターゲット プロジェクトを識別する、ユニークな 24 桁 16 進数の文字列。 |
{- "deliveryType": "automated",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8"
}
{- "cancelled": true,
- "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
指定されたプロジェクトから 1 つのサーバーレスインスタンスの 1 つの復元ジョブを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに getFlexBackupRestoreJob エンドポイントを使用してください。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ サーバーレスインスタンスを識別する、人間が判読できるラベル。 |
restoreJobId 必須 | string^([a-f0-9]{24})$ 返す対象である復元ジョブを識別するユニークな 24 桁の 16 進数文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "cancelled": true,
- "deliveryType": "automated",
- "deliveryUrl": [
- "string"
], - "desiredTimestamp": {
- "date": "2019-08-24T14:15:22Z",
- "increment": 1199145600
}, - "expired": true,
- "expiresAt": "2019-08-24T14:15:22Z",
- "failed": true,
- "finishedAt": "2019-08-24T14:15:22Z",
- "id": "32b6e34b3d91647abb20e7b8",
- "oplogInc": 1,
- "oplogTs": 1199145600,
- "pointInTimeUTCSeconds": 1199145600,
- "snapshotId": "32b6e34b3d91647abb20e7b8",
- "targetClusterName": "string",
- "targetGroupId": "32b6e34b3d91647abb20e7b8",
- "timestamp": "2019-08-24T14:15:22Z"
}
指定されたプロジェクトから 1 つのサーバーレスインスタンスのすべてのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
この API は、createServerlessInstance エンドポイントを使用して作成された Flex クラスター、またはサーバーレスインスタンスから移行された Flex クラスターでも使用できます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに listFlexBackups エンドポイントを使用してください。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ サーバーレスインスタンスを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
{- "results": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "mongodVersion": "string",
- "serverlessInstanceName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0
}
], - "totalCount": 0
}
指定されたプロジェクトの 1 つのサーバーレスインスタンスの 1 つのスナップショットを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このエンドポイントは、createServerlessInstance API で作成された Flex クラスターや、サーバーレスインスタンスから移行された Flex クラスターでもご利用いただけます。このエンドポイントは 2026 年 1 月に廃止されます。代わりに getFlexBackup エンドポイントをご使用ください。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ サーバーレスインスタンスを識別する、人間が判読できるラベル。 |
snapshotId 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 目的のスナップショットを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z",
- "frequencyType": "hourly",
- "id": "32b6e34b3d91647abb20e7b8",
- "mongodVersion": "string",
- "serverlessInstanceName": "string",
- "snapshotType": "onDemand",
- "status": "queued",
- "storageSizeBytes": 0
}
クラウド移行サービスを管理します。移行元の組織、プロジェクト、MongoDB クラスターは、Cloud Manager または Ops Manager に存在します。移行先の組織、プロジェクト、MongoDB クラスターは MongoDBngoDB Cloud に存在します。移行元のデータベースでは、SCRAM-SHA 以外の認証は使用できません。
Cloud Manager または Ops Manager が管理する 1 つのクラスターを MongoDB Atlas に移行します。
移行を開始する前には、必ず移行を検証してください。
この API エンドポイントは、プッシュ ライブ移行にのみ使用できます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。
注意: 時系列コレクションの移行は、MongoDB 6.0 以降ではまだサポートされていません。MongoDB 6.0 以降での移行では、ソースクラスター上の時系列コレクションはすべてスキップされます。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
1 つの移行が作成されます。
必須 | オブジェクト (移行先) 移行の宛先を説明するドキュメント。 |
dropDestinationData | ブール値 デフォルト: false 移行を開始する前に、移行プロセスが宛先クラスターからすべてのコレクションを削除するかどうかを示すフラグ。 |
migrationHosts | の配列 string = 1 アイテム この移行に使用された移行ホストのリスト。 |
オブジェクト (ShardingRequest) レプリカセット ソースから MongoDB 6.0 以降のシャーディングされたクラスターの宛先に移行する場合に、宛先クラスターでシャーディングを構成するドキュメント。宛先クラスターでコレクションをシャーディングしない場合は、これを空のままにします。 | |
必須 | オブジェクト (移行元) 移行の移行元を説明するドキュメント。 |
{- "destination": {
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnameSchemaType": "PUBLIC",
- "privateLinkId": "string"
}, - "dropDestinationData": false,
- "migrationHosts": [
- "vm001.example.com"
], - "sharding": {
- "createSupportingIndexes": true,
- "shardingEntries": [
- {
- "collection": "string",
- "database": "string",
- "shardCollection": {
- "key": [
- {
- "property1": { },
- "property2": { }
}
]
}
}
]
}, - "source": {
- "caCertificatePath": "string",
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "managedAuthentication": true,
- "password": "string",
- "ssl": true,
- "username": "string"
}
}
{- "_id": "32b6e34b3d91647abb20e7b8",
- "lagTimeSeconds": 0,
- "migrationHosts": [
- "vm001.example.com"
], - "readyForCutover": true,
- "status": "NEW"
}
提供された認証情報、使用可能なディスク容量、MongoDB のバージョンなどが移行リクエストの要件を満たしているかどうかを確認します。確認に合格すると、移行を続行できます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。非推奨のバージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
1 つの移行が検証されます。
必須 | オブジェクト (移行先) 移行の宛先を説明するドキュメント。 |
dropDestinationData | ブール値 デフォルト: false 移行を開始する前に、移行プロセスが宛先クラスターからすべてのコレクションを削除するかどうかを示すフラグ。 |
migrationHosts | の配列 string = 1 アイテム この移行に使用された移行ホストのリスト。 |
オブジェクト (ShardingRequest) レプリカセット ソースから MongoDB 6.0 以降のシャーディングされたクラスターの宛先に移行する場合に、宛先クラスターでシャーディングを構成するドキュメント。宛先クラスターでコレクションをシャーディングしない場合は、これを空のままにします。 | |
必須 | オブジェクト (移行元) 移行の移行元を説明するドキュメント。 |
{- "destination": {
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnameSchemaType": "PUBLIC",
- "privateLinkId": "string"
}, - "dropDestinationData": false,
- "migrationHosts": [
- "vm001.example.com"
], - "sharding": {
- "createSupportingIndexes": true,
- "shardingEntries": [
- {
- "collection": "string",
- "database": "string",
- "shardCollection": {
- "key": [
- {
- "property1": { },
- "property2": { }
}
]
}
}
]
}, - "source": {
- "caCertificatePath": "string",
- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "managedAuthentication": true,
- "password": "string",
- "ssl": true,
- "username": "string"
}
}
{- "_id": "32b6e34b3d91647abb20e7b8",
- "errorMessage": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "sourceGroupId": "32b6e34b3d91647abb20e7b8",
- "status": "PENDING"
}
1 つの移行検証ジョブの状態を返します。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
validationId 必須 | string^([a-f0-9]{24})$ 例: 507f1f77bcf86cd799439011 検証ジョブを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "errorMessage": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "sourceGroupId": "32b6e34b3d91647abb20e7b8",
- "status": "PENDING"
}
1 つのクラスター移行ジョブの詳細を返します。各プッシュ ライブ移行ジョブは、1 つの移行ホストを使用します。このリソースを正常に呼び出すには、API キーに組織ノード ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
liveMigrationId 必須 | string^([a-f0-9]{24})$ 例: 6296fb4c7c7aa997cf94e9a8 移行を識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "lagTimeSeconds": 0,
- "migrationHosts": [
- "vm001.example.com"
], - "readyForCutover": true,
- "status": "NEW"
}
移行されたクラスターを MongoDB Atlas にカットオーバーします。カットオーバーが完了したことを確認します。カットオーバーが完了すると、MongoDB Atlas はライブ移行プロセスを完了し、ソースクラスターとの同期を停止します。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
liveMigrationId 必須 | string^([a-f0-9]{24})$ 例: 6296fb4c7c7aa997cf94e9a8 移行を識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
- "error": 400,
- "errorCode": "VALIDATION_ERROR",
- "reason": "Bad Request"
}
指定された組織に移行できるすべてのプロジェクトを返します。
orgId 必須 | string^([a-f0-9]{24})$ 例: 4888442a3354817a7320eb61 プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- {
- "deployments": [
- {
- "agentVersion": "string",
- "clusterId": "32b6e34b3d91647abb20e7b8",
- "dbSizeBytes": 8192,
- "featureCompatibilityVersion": "string",
- "managed": true,
- "mongoDBVersion": "string",
- "name": "Project X sharded cluster",
- "oplogSizeMB": 3,
- "sharded": true,
- "shardsSize": 3,
- "tlsEnabled": true
}
], - "migrationHosts": [
- "string"
], - "name": "string",
- "projectId": "32b6e34b3d91647abb20e7b8"
}
]
1 つの組織リンクとそれに関連付けられた公開APIキーを削除します。MongoDB Atlas は、プッシュ ライブ移行にのみトークンリンクを使用します。ライブ移行(プッシュ)により、Cloud Manager または Ops Manager から MongoDB Atlas にデータを安全にプッシュできます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。
orgId 必須 | string^([a-f0-9]{24})$ 例: 4888442a3354817a7320eb61 プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{ }
リンクを完了するために必要なすべての情報を含む 1 つのトークンリンクを作成します。MongoDB Atlas は、プッシュ ライブ移行にのみトークンリンクを使用します。ライブ移行(プッシュ)により、Cloud Manager または Ops Manager から MongoDB Atlas にデータを安全にプッシュできます。このリソースを正常に呼び出すには、API キーに組織オーナー ロールが必要です。
orgId 必須 | string^([a-f0-9]{24})$ 例: 4888442a3354817a7320eb61 プロジェクトを含む組織を識別するユニークな 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、/orgs エンドポイントを使用します。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
移行に関連付けられた IP アドレス アクセス リスト エントリ。
accessListIps | の配列 string API キーに関連付けられた IP アドレス アクセス リスト エントリ。 |
{- "accessListIps": [
- "string"
]
}
{- "linkToken": "string"
}
指定されたプロジェクトへのアクセス権を持つすべてのクラウドプロバイダー アクセス ロールを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "awsIamRoles": [
- {
- "providerName": "AWS",
- "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
- "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
- "authorizedDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
], - "azureServicePrincipals": [
- {
- "providerName": "AWS",
- "_id": "32b6e34b3d91647abb20e7b8",
- "atlasAzureAppId": "fa987465-057e-40db-aba0-9f2d4cc5853c",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "servicePrincipalId": "f25408bf-fda4-449e-87e7-67cf2d3e5615",
- "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
]
}
指定されたクラウドプロバイダーに対して 1 つのアクセス ロールを作成します。一部の MongoDB Cloud 機能では、認証にこれらのクラウドプロバイダー アクセス ロールを使用します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたクラウドプロバイダーの 1 つのロールを作成します。
providerName 必須 | string ロールのクラウドプロバイダーを識別する、人間が判読できるラベル。 |
{- "providerName": "AWS"
}
{- "providerName": "AWS",
- "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
- "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
- "authorizedDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
指定された ID と、指定されたプロジェクトへのアクセス権を持つアクセス ロールを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
roleId 必須 | string^([a-f0-9]{24})$ ロールを識別するユニークな 24 桁の 16 進数の文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "providerName": "AWS",
- "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
- "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
- "authorizedDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z",
- "featureUsages": [
- {
- "featureType": "ATLAS_DATA_LAKE"
}
], - "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
クラスターの停止時シミュレーションを終了します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 停止時シミュレーションを実行しているクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
], - "startRequestDate": "2019-08-24T14:15:22Z",
- "state": "START_REQUESTED"
}
1 つのクラスターの 1 つの停止時シミュレーションを返します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 停止時シミュレーションを実行しているクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
], - "startRequestDate": "2019-08-24T14:15:22Z",
- "state": "START_REQUESTED"
}
クラスターの停止時シミュレーションを開始します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 停止時シミュレーションを実行するクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
停止時シミュレーションについて説明します。
の配列 オブジェクト (AtlasClusterOutageSimulationOutageFilter) non-empty クラスターの停止時シミュレーションのタイプを指定する設定のリスト。 |
{- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
]
}
{- "clusterName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "outageFilters": [
- {
- "cloudProvider": "AWS",
- "regionName": "string",
- "type": "REGION"
}
], - "startRequestDate": "2019-08-24T14:15:22Z",
- "state": "START_REQUESTED"
}
アクセス可能なすべてのプロジェクトのすべてのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このレスポンスには、マルチクラウド クラスターは含まれません。このリソースは、リクエスト元の API キーがどのようなクラスターレベルのロールを持っていても使用できます。
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "clusters": [
- {
- "alertCount": 0,
- "authEnabled": true,
- "availability": "available",
- "backupEnabled": true,
- "clusterId": "string",
- "dataSizeBytes": 0,
- "name": "string",
- "nodeCount": 0,
- "sslEnabled": true,
- "type": "REPLICA_SET",
- "versions": [
- "string"
]
}
], - "groupId": "string",
- "groupName": "string",
- "orgId": "string",
- "orgName": "string",
- "planType": "string",
- "tags": [
- "string"
]
}
], - "totalCount": 0
}
アクセス可能な特定のプロジェクトのすべてのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。レスポンスには、非対称サイズのシャードがあるクラスターが含まれます。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。この機能はサーバーレス クラスターでは利用できません。
このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2/M5 クラスターでも使用できます。Flex クラスターには、代わりに listFlexClusters エンドポイントを使用してください。非推奨バージョン: v2-{2023-02-01}、v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty | |
includeDeletedWithRetainedBackups | ブール値 デフォルト: false バックアップを保持するクラスターを返すかどうかを示すフラグ。 |
{- "results": [
- {
- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}
], - "totalCount": 0
}
指定されたプロジェクトに 1 つのクラスターを作成します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このリソースは、非対称サイズのシャードを持つクラスターを作成できます。各プロジェクトは最大 25 データベース配置をサポートします。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。この機能はサーバーレス クラスターでは利用できません。
M2 または M5 の instanceSize を使用すると、代わりに Flex クラスターが作成されることにご注意ください。M2 または M5 のインスタンスサイズのサポートは、1月2026に終了します。今後、このような構成には createFlexCluster API を使用することをお勧めします。非推奨バージョン: v2-{2024-08-05}、v2-{2023-02-01}、v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
このプロジェクトで作成するクラスター。
acceptDataRisksAndForceReplicaSetReconfig | string <date-time> リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み(過半数がコミットされた書込みであっても)が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 |
オブジェクト (ApiAtlasClusterAdvancedConfigurationView) 詳細構成の詳細のサブセットを構成する設定のグループ。 | |
backupEnabled | ブール値 デフォルト: false クラスターがバックアップを実行できるかどうかを示すフラグ。 |
オブジェクト (MongoDB Connector for Business Intelligence の設定) このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。 | |
clusterType | string 列挙: "REPLICASET" "SHARDED" "GEOSHARDED" クラスターを構成するノードの構成。 |
configServerManagementMode | string デフォルト: "ATLAS_MANAGED" 列挙: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。 ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。 FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。 |
diskWarmingMode | string デフォルト: "FULLY_WARMED" 列挙: "FULLY_WARMED" "VISIBLE_EARLIER" ディスク ウォーミング モードの選択。 |
encryptionAtRestProvider | string 列挙: "NONE" "AWS" "AZURE" "GCP" カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、 |
globalClusterSelfManagedSharding | ブール値 新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。 false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。 true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。 この設定は、クラスターが配置されると変更できません。 |
の配列 オブジェクト (コンポーネント ラベル) 非推奨 クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。 クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めています。 | |
オブジェクト (EmployeeAccessGrantView) MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。 | |
mongoDBMajorVersion | string クラスターのMongoDBメジャー バージョン。 バイナリ メジャー バージョンに設定します。 作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。 更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。 |
name | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
paused | ブール値 クラスターが一時停止しているかどうかを示すフラグ。 |
pitEnabled | |
redactClientLogData | ブール値 ログリダクションを有効または無効にします。 この設定では、ロギング前に特定のログ イベントに付随するメッセージからドキュメント フィールドの内容をすべて編集するように 規制要件へのコンプライアンスを支援するため、 注: クラスターでこの設定を変更すると、クラスターの更新後すぐにローリング再起動がトリガーされます。 |
replicaSetScalingStratey | string デフォルト: "WORKLOAD_Type" 列挙: "SEQENTIAL" "WORKLOAD_Type" "NOde_type" クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。 デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。 SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。 Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。 |
の配列 オブジェクト (レプリケーションの仕様) クラスター リージョンを構成する設定のリスト。 この配列には、各シャードのノード構成を表すシャードごとに 1 つのオブジェクトが含まれます。 レプリカセットの場合、ノード構成を表すオブジェクトは 1 つだけです。 | |
rootCertType | string デフォルト: "ISRGROOTX1" 値: "ISRGROOTX1" MongoDB Cloud クラスターが使用するルート認証局。MongoDB Cloud は Internet Security Research Group をサポートしています。 |
terminationProtectionEnabled | ブール値 デフォルト: false クラスターで終了保護が有効になっているかどうかを示すフラグ。 |
versionReleaseSystem | string デフォルト: "LTS" 列挙: "LTS" "CONTINUOUS" クラスターが MongoDB のバージョンを管理する方法。値が |
クラスター
{- "clusterType": "SHARDED",
- "name": "myCluster",
- "replicationSpecs": [
- {
- "regionConfigs": [
- {
- "analyticsAutoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M40",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M40",
- "nodeCount": 0
}, - "autoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M60",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "electableSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M60",
- "nodeCount": 3
}, - "priority": 7,
- "providerName": "AWS",
- "readOnlySpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M60",
- "nodeCount": 0
}, - "regionName": "US_EAST_1"
}
], - "zoneName": "Zone 1"
}, - {
- "regionConfigs": [
- {
- "analyticsAutoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M40",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M30",
- "nodeCount": 0
}, - "autoScaling": {
- "autoIndexing": {
- "enabled": false
}, - "compute": {
- "enabled": true,
- "maxInstanceSize": "M60",
- "minInstanceSize": "M30",
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "electableSpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M40",
- "nodeCount": 3
}, - "priority": 7,
- "providerName": "AWS",
- "readOnlySpecs": {
- "diskSizeGB": 10,
- "instanceSize": "M40",
- "nodeCount": 0
}, - "regionName": "US_EAST_1"
}
], - "zoneName": "Zone 1"
}
]
}
{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}
指定された階層の指定されたクラウドプロバイダーで利用可能なリージョンのリストを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty | |
providers | の配列 string 取得対象のリージョンを持つクラウドプロバイダー。複数のプロバイダーを指定した場合、レスポンスではマルチクラウド クラスターをサポートする階層とリージョンのみが返されます。 |
tier | string リージョンを取得するクラスター階層。 |
{- "results": [
- {
- "instanceSizes": [
- {
- "availableRegions": [
- {
- "default": true,
- "name": "string"
}
], - "name": "string"
}
], - "provider": "AWS"
}
], - "totalCount": 0
}
指定したプロジェクトからクラスターを 1 つ削除します。クラスターを削除するには、終了保護を無効にする必要があります。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。この機能はサーバーレス クラスターでは利用できません。
このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2/M5 クラスターでも使用できます。Flex クラスターには、代わりに deleteFlexCluster エンドポイントを使用してください。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
retainBackups | ブール値 削除された専有クラスターのバックアップ スナップショットを保持するかどうかを示すフラグ。 |
{- "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
- "error": 400,
- "errorCode": "VALIDATION_ERROR",
- "reason": "Bad Request"
}
指定されたプロジェクト内の 1 つのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。レスポンスには、非対称サイズのシャードがあるクラスターが含まれます。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。この機能はサーバーレス クラスターでは利用できません。
このエンドポイントは、createCluster エンドポイントを使用して作成された Flex クラスターや、2026 年 1 月までに Flex クラスターに移行された旧 M2/M5 クラスターでも使用できます。Flex クラスターには、代わりに getFlexCluster エンドポイントをご利用ください。非推奨バージョン: v2-{2023-02-01}、v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ このクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}
指定されたプロジェクト内の 1 つのクラスターの詳細を更新します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このリソースは、非対称サイズのシャードを持つクラスターを更新できます。クラスターの終了保護を更新するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。他のすべての更新については、リクエスト元の API キーにプロジェクト クラスター マネージャーのロールが必要です。一時停止中のクラスター(paused : true
)を変更することはできません。 paused : false
を設定するには、このエンドポイントを呼び出す必要があります。このエンドポイントが paused : false
で応答したら、クラスターに変更を加えて再度呼び出せます。この機能はサーバーレス クラスターでは利用できません。非推奨バージョン: v2-{2024-08-05}、v2-{2023-02-01}、v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクト内の更新するクラスター。
acceptDataRisksAndForceReplicaSetReconfig | string <date-time> リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み(過半数がコミットされた書込みであっても)が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 |
オブジェクト (ApiAtlasClusterAdvancedConfigurationView) 詳細構成の詳細のサブセットを構成する設定のグループ。 | |
backupEnabled | ブール値 デフォルト: false クラスターがバックアップを実行できるかどうかを示すフラグ。 |
オブジェクト (MongoDB Connector for Business Intelligence の設定) このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。 | |
clusterType | string 列挙: "REPLICASET" "SHARDED" "GEOSHARDED" クラスターを構成するノードの構成。 |
configServerManagementMode | string デフォルト: "ATLAS_MANAGED" 列挙: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。 ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。 FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。 |
diskWarmingMode | string デフォルト: "FULLY_WARMED" 列挙: "FULLY_WARMED" "VISIBLE_EARLIER" ディスク ウォーミング モードの選択。 |
encryptionAtRestProvider | string 列挙: "NONE" "AWS" "AZURE" "GCP" カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、 |
globalClusterSelfManagedSharding | ブール値 新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。 false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。 true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。 この設定は、クラスターが配置されると変更できません。 |
の配列 オブジェクト (コンポーネント ラベル) 非推奨 クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。 クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めています。 | |
オブジェクト (EmployeeAccessGrantView) MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。 | |
mongoDBMajorVersion | string クラスターのMongoDBメジャー バージョン。 バイナリ メジャー バージョンに設定します。 作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。 更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。 |
name | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
paused | ブール値 クラスターが一時停止しているかどうかを示すフラグ。 |
pitEnabled | |
redactClientLogData | ブール値 ログリダクションを有効または無効にします。 この設定では、ロギング前に特定のログ イベントに付随するメッセージからドキュメント フィールドの内容をすべて編集するように 規制要件へのコンプライアンスを支援するため、 注: クラスターでこの設定を変更すると、クラスターの更新後すぐにローリング再起動がトリガーされます。 |
replicaSetScalingStratey | string デフォルト: "WORKLOAD_Type" 列挙: "SEQENTIAL" "WORKLOAD_Type" "NOde_type" クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。 デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。 SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。 Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。 |
の配列 オブジェクト (レプリケーションの仕様) クラスター リージョンを構成する設定のリスト。 この配列には、各シャードのノード構成を表すシャードごとに 1 つのオブジェクトが含まれます。 レプリカセットの場合、ノード構成を表すオブジェクトは 1 つだけです。 | |
rootCertType | string デフォルト: "ISRGROOTX1" 値: "ISRGROOTX1" MongoDB Cloud クラスターが使用するルート認証局。MongoDB Cloud は Internet Security Research Group をサポートしています。 |
terminationProtectionEnabled | ブール値 デフォルト: false クラスターで終了保護が有効になっているかどうかを示すフラグ。 |
versionReleaseSystem | string デフォルト: "LTS" 列挙: "LTS" "CONTINUOUS" クラスターが MongoDB のバージョンを管理する方法。値が |
{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "globalClusterSelfManagedSharding": true,
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS"
}, - "mongoDBMajorVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}
{- "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
- "advancedConfiguration": {
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "minimumEnabledTlsProtocol": "TLS1_0",
- "tlsCipherConfigMode": "CUSTOM"
}, - "backupEnabled": false,
- "biConnector": {
- "enabled": true,
- "readPreference": "PRIMARY"
}, - "clusterType": "REPLICASET",
- "configServerManagementMode": "ATLAS_MANAGED",
- "configServerType": "DEDICATED",
- "connectionStrings": {
- "awsPrivateLink": {
- "property1": "string",
- "property2": "string"
}, - "awsPrivateLinkSrv": {
- "property1": "string",
- "property2": "string"
}, - "private": "string",
- "privateEndpoint": [
- {
- "connectionString": "string",
- "endpoints": [
- {
- "endpointId": "string",
- "providerName": "AWS",
- "region": "string"
}
], - "srvConnectionString": "string",
- "srvShardOptimizedConnectionString": "string",
- "type": "MONGOD"
}
], - "privateSrv": "string",
- "standard": "string",
- "standardSrv": "string"
}, - "createDate": "2019-08-24T14:15:22Z",
- "diskWarmingMode": "FULLY_WARMED",
- "encryptionAtRestProvider": "NONE",
- "featureCompatibilityVersion": "string",
- "featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
- "globalClusterSelfManagedSharding": true,
- "groupId": "32b6e34b3d91647abb20e7b8",
- "id": "32b6e34b3d91647abb20e7b8",
- "labels": [
- {
- "key": "string",
- "value": "string"
}
], - "mongoDBEmployeeAccessGrant": {
- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS",
}, - "mongoDBMajorVersion": "string",
- "mongoDBVersion": "string",
- "name": "string",
- "paused": true,
- "pitEnabled": true,
- "redactClientLogData": true,
- "replicaSetScalingStrategy": "SEQUENTIAL",
- "replicationSpecs": [
- {
- "id": "32b6e34b3d91647abb20e7b8",
- "regionConfigs": [
- {
- "electableSpecs": {
- "diskSizeGB": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10",
- "nodeCount": 0
}, - "priority": 7,
- "providerName": "AWS",
- "regionName": "US_GOV_WEST_1",
- "analyticsAutoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "analyticsSpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}, - "autoScaling": {
- "compute": {
- "enabled": true,
- "maxInstanceSize": "M10",
- "minInstanceSize": "M10",
- "predictiveEnabled": true,
- "scaleDownEnabled": true
}, - "diskGB": {
- "enabled": true
}
}, - "readOnlySpecs": {
- "diskSizeGB": 0,
- "nodeCount": 0,
- "diskIOPS": 0,
- "ebsVolumeType": "STANDARD",
- "instanceSize": "M10"
}
}
], - "zoneId": "32b6e34b3d91647abb20e7b8",
- "zoneName": "string"
}
], - "rootCertType": "ISRGROOTX1",
- "stateName": "IDLE",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "terminationProtectionEnabled": false,
- "versionReleaseSystem": "LTS"
}
シャーディングされたクラスターのオートスケーリングの内部構成を返します。このエンドポイントは、古い API からアップデートされたシャーディングされたクラスターが、各シャードを個別にオートスケーリングのサポートを確保していることを確認する診断目的で使用できます。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ このクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "autoScalingMode": "INDEPENDENT_SHARD_SCALING"
}
指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り保証/書込み保証、インデックス制限および oplog 制限、およびその他のデータベース設定が含まれます。この機能は、M0
無料クラスター、M2
および M5
の共有階層クラスター、 Flex クラスター、またはサーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
- "chunkMigrationConcurrency": 0,
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "defaultMaxTimeMS": 0,
- "defaultWriteConcern": "string",
- "javascriptEnabled": true,
- "minimumEnabledTlsProtocol": "TLS1_0",
- "noTableScan": true,
- "oplogMinRetentionHours": 0,
- "oplogSizeMB": 0,
- "queryStatsLogVerbosity": 0,
- "sampleRefreshIntervalBIConnector": 0,
- "sampleSizeBIConnector": 0,
- "tlsCipherConfigMode": "CUSTOM",
- "transactionLifetimeLimitSeconds": 1
}
指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を更新します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り保証/書込み保証、インデックス制限および oplog 制限、およびその他のデータベース設定が含まれます。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。この機能は、M0
無料クラスター、M2
および M5
の共有階層クラスター、 Flex クラスター、またはサーバーレス クラスターでは使用できません。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクト内の 1 つのクラスターに追加する高度な構成の詳細。
changeStreamOptionsPreAndPostImagesExpirationAfterSeconds | integer <int32> デフォルト: -1 変更前と変更後のイメージの最小保持時間(秒単位)。 |
chunkMigrationConcurrency | integer <int32> チャンク移行のソース シャードおよび受信シャード上のスレッドの数。スレッドの数は、シャーディングされたクラスター内の CPU コアの合計数の半分を超えてはなりません。 |
customOpensslCisphereConfigTls12 | の配列 string アイテム列挙: "TLS_ECDHE_RSA_With_AES_256_GCM_SHA384" "TLS_ECDHE_RSA_With_AES_128_GCM_SHA256" TLS 1.2 のカスタム OpenSSL 暗号スイート リスト。 このフィールドは、 |
デフォルトMaxTimeMS | |
defaultWriteConcern | string ドライバーによって何も指定されていない場合に、書込み (write) 操作に対して MongoDB が要求する確認応答のデフォルト レベル。 |
javascriptEnabled | ブール値 クラスターが JavaScript のサーバー側実行を行う操作の許可の是非を示すフラグ。8.0+ を使用する場合、よりパフォーマンスの高い代替手段として、サーバーサイドの JavaScript を無効にし、集約パイプラインの演算子を使用することをお勧めします。 |
minimumEnabledTlsProtocol | string 列挙: "TLS1_0" "TLS1_1" "TLS1_2" クラスターが受信接続に受け入れる TLS(Transport Layer Security)の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。 |
noTableScan | ブール値 結果を返すためにコレクションスキャンが必要なクエリについて、クラスターで実行が無効化されているかどうかを示すフラグ。 |
oplogMinRetentionHours | 数値または null <double> クラスターの oplog の最小保持ウィンドウ(単位は時間)。null 値の場合、MongoDB Cloud が計算するデフォルトの最小 oplog window をクラスターが使用することを示します。 |
oplogSizeMB | 整数または null <int32> クラスターの oplog のストレージ制限(単位はメガバイト)。null 値の場合、MongoDB Cloud が計算するデフォルトの oplog サイズをクラスターが使用することを示します。 |
queryStatsLogVerbosity | integer <int32> 1(無効)または 3(有効)に設定できます。3 に設定されている場合、Atlas は編集され、匿名化された $queryStats 出力を MongoDB ログに含めます。$queryStats 出力にはリテラル値またはフィールド値は含まれません。この設定を有効にすると、クラスターのパフォーマンスに影響を与える可能性があります。 |
sampleRefreshIntervalBIConnector | integer <int32> >= 0 デフォルト: 0 mongosqld プロセスがデータを再サンプリングしてリレーショナル スキーマを作成する間隔(単位は秒)。 |
sampleSizeBIConnector | integer <int32> >= 0 スキーマ情報を収集するときにサンプリングするデータベースあたりのドキュメントの数。 |
tlsCisphereConfigMode | string 列挙: "CUSTOM" "DEFAULT" TLS 暗号スイートの 構成モード。 デフォルトモードでは、デフォルトの暗号スイートが使用されます。 カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。 |
transactionLifetimeLimitSeconds | integer <int64> >= 1 マルチドキュメントトランザクションの有効期間(単位は秒)。Atlas は、この制限を超えるトランザクションは期限切れと見なし、定期的なクリーンアップ プロセスによって中断します。 |
{- "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
- "chunkMigrationConcurrency": 0,
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "defaultMaxTimeMS": 0,
- "defaultWriteConcern": "string",
- "javascriptEnabled": true,
- "minimumEnabledTlsProtocol": "TLS1_0",
- "noTableScan": true,
- "oplogMinRetentionHours": 0,
- "oplogSizeMB": 0,
- "queryStatsLogVerbosity": 0,
- "sampleRefreshIntervalBIConnector": 0,
- "sampleSizeBIConnector": 0,
- "tlsCipherConfigMode": "CUSTOM",
- "transactionLifetimeLimitSeconds": 1
}
{- "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
- "chunkMigrationConcurrency": 0,
- "customOpensslCipherConfigTls12": [
- "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
], - "defaultMaxTimeMS": 0,
- "defaultWriteConcern": "string",
- "javascriptEnabled": true,
- "minimumEnabledTlsProtocol": "TLS1_0",
- "noTableScan": true,
- "oplogMinRetentionHours": 0,
- "oplogSizeMB": 0,
- "queryStatsLogVerbosity": 0,
- "sampleRefreshIntervalBIConnector": 0,
- "sampleSizeBIConnector": 0,
- "tlsCipherConfigMode": "CUSTOM",
- "transactionLifetimeLimitSeconds": 1
}
指定されたプロジェクト内の指定されたクラスターのフェイルオーバー テストを開始します。クラスターには、同じデータセットを維持するホストのグループが含まれます。フェイルオーバー テストは、MongoDB Cloud がクラスターのプライマリ ノードの障害をどのように取り扱うかを確認します。テスト中、MongoDB Cloud はプライマリ ノードをシャットダウンし、新しいプライマリを選択します。このリソースを使用するには、リクエスト元の API キーにプロジェクト クラスター マネージャー ロールが必要です。非推奨バージョン: v2-{2023-01-01}
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "detail": "(This is just an example, the exception may not be related to this endpoint)",
- "error": 401,
- "errorCode": "NOT_ORG_GROUP_CREATOR",
- "reason": "Unauthorized"
}
指定されたプロジェクト内の指定されたクラスターに対して行ったすべての変更のステータスを返します。このリソースを使用して、MongoDB Cloud による変更プロセスの進行状況を確認します。レスポンスには、新しい専有クラスターの配置は含まれません。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ クラスターを識別する人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "changeStatus": "PENDING",
}
MongoDB 従業員クラスター アクセスは、指定された期間と 1 つのクラスターに対して指定されたレベルで付与されます。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ このクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
アクセス レベルと有効期限を付与します。
expirationTime 必須 | string <date-time> 従業員アクセス許可の有効期限。 |
granType 必須 | string 列挙: "CLUSTER_DATABASE_LOGS" "CLUSTER_INFREE" "CLUSTER_INFREE_AND_AP_SERVICES_SYNC_DATA" MongoDB 従業員に付与するアクセス権のレベル。 |
{- "expirationTime": "2019-08-24T14:15:22Z",
- "grantType": "CLUSTER_DATABASE_LOGS"
}
{ }
機能の互換性バージョン(FCV)を現在のMongoDBバージョンに固定し、固定の有効期限を設定します。クラスターに FCV ピンがすでに存在する場合、このメソッドを呼び出すと既存のピンの有効期限のみが更新され、FCV は再固定されません。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ このクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
FCV 固定構成を調整するための任意のリクエスト パラメーター。
expirationDate | string <date-time> 固定 FCV の有効期限。指定しない場合、有効期限は、FCV が最初に固定された日からデフォルトで 4 週間になります。このフィールドは固定された日付から 4 週間を超えることはできないことに注意してください。 |
{- "expirationDate": "2019-08-24T14:15:22Z"
}
{ }
以前に付与された MongoDB 従業員クラスターへのアクセスを取り消します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ このクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
固定されている機能の互換性バージョン(FCV)の固定を解除します。この機能は、Rapid Release のクラスターでは使用できません。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ このクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
MongoDB サンプル データセットを指定したクラスターにロードすることを要求します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
name 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ サンプル データセットをロードするクラスターを識別する、人間が判読できるラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "completeDate": "2019-08-24T14:15:22Z",
- "createDate": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "state": "WORKING"
}
サンプル データセットを 1 つのクラスターにロードする進行状況を確認します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
sampleDatasetId 必須 | string^([a-f0-9]{24})$ ロードされたサンプル データセットを識別するユニークな 24 桁の 16 進数文字列。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "clusterName": "string",
- "completeDate": "2019-08-24T14:15:22Z",
- "createDate": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "state": "WORKING"
}
指定されたクラスターの固定された名前空間のリストを返します。これは、クエリ レイテンシ メトリクスを収集するためにユーザーが手動で選択した名前空間のセットです。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 固定された名前空間を取得するためのクラスターを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}
指定された名前空間のリストを既存の固定された名前空間リストに追加して、特定のグループとクラスターのコレクション レベルのレイテンシ メトリクスを収集します
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 名前空間を固定するクラスターを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
クエリ レイテンシ メトリクス コレクション用に固定する名前空間文字列(データベース名とコレクション名の組み合わせ)のリスト。
名前空間 | の配列 string unique 指定されたホストまたはクラスター上の名前空間文字列(データベースとコレクションの組み合わせ)のリスト。 |
{- "namespaces": [
- "string"
]
}
{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}
指定されたグループとクラスターのコレクションレベルのレイテンシ メトリクスを収集するために、指定された名前空間のリストを固定します。これにより、グループとクラスターに対して、固定された名前空間リストが初期化されるか、既存の固定された名前空間リストが置き換えられます。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 名前空間を固定するクラスターを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
クエリ レイテンシ メトリクス コレクション用に固定する名前空間文字列(データベース名とコレクション名の組み合わせ)のリスト。
名前空間 | の配列 string unique 指定されたホストまたはクラスター上の名前空間文字列(データベースとコレクションの組み合わせ)のリスト。 |
{- "namespaces": [
- "string"
]
}
{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}
指定されたグループとクラスターのコレクション レベルのレイテンシ メトリクス収集のために、指定された名前空間のリストの固定を解除します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 名前空間の固定を解除するクラスターを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
クエリ レイテンシ メトリクス コレクション用に固定する名前空間文字列(データベース名とコレクション名の組み合わせ)のリスト。
名前空間 | の配列 string unique 指定されたホストまたはクラスター上の名前空間文字列(データベースとコレクションの組み合わせ)のリスト。 |
{- "namespaces": [
- "string"
]
}
{- "clusterId": "32b6e34b3d91647abb20e7b8",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "pinnedNamespaces": [
- "string"
]
}
指定されたクラスターから名前空間のサブセットを、指定された時間枠内の合計実行時間の最も長い順(降順)でソートして返します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ 名前空間を固定するクラスターを識別する、人間が判読可能なラベル。 |
clusterView 必須 | string 列挙: 「プライマリ」 「セカンダリ」 "INDIVIDUAL_PROCESS" メトリクスを取得するクラスター トポロジーを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
始める | string <date-time> MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
end | string <date-time> MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
period | string 例: period=PT10H Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。 |
{- "groupId": "32b6e34b3d91647abb20e7b8",
- "identifierId": "string",
- "rankedNamespaces": [
- "string"
]
}
指定された名前空間に対するコレクション統計レイテンシのクラスター レベルの測定値一覧を取得します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
clusterName 必須 | string^[a-zA-Z0-9][a-zA-Z0-9-]*$ メトリクスを取得するクラスターを識別する、人間が判読可能なラベル。 |
clusterView 必須 | string 列挙: 「プライマリ」 「セカンダリ」 "INDIVIDUAL_PROCESS" メトリクスを取得するクラスター トポロジーを識別する、人間が判読可能なラベル。 |
databaseName 必須 | string 例: mydb データベースを識別する、人間が判読可能なラベル。 |
コレクション名 必須 | string 例: mycoll コレクションを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
メトリクス | の配列 string unique アイテム列挙: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE" 関連するデータ シリーズについて取得するメトリクスを含むリスト。このパラメーターを設定しない場合、このリソースはすべてのコレクション統計レイテンシのメトリクスに対するデータ シリーズを返します。 |
始める | string <date-time> MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
end | string <date-time> MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
period | string 例: period=PT10H Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。 |
{- "clusterId": "string",
- "clusterView": "string",
- "collectionName": "string",
- "databaseName": "string",
- "end": "2019-08-24T14:15:22Z",
- "granularity": "PT1M",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "measurements": [
- {
- "dataPoints": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
], - "name": "string",
- "units": "BYTES"
}
], - "processId": "mongodb.example.com:27017",
- "start": "2019-08-24T14:15:22Z"
}
リクエスト時に指定されたプロジェクトに対して、使用可能なすべてのコレクション統計レイテンシのメトリクス名とそれぞれのユニットを返します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{ }
指定されたプロセスから名前空間のサブセットを、指定された時間枠内の合計実行時間が最も長い順(降順)で順位付けして返します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
processId 必須 | string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:... 例: my.host.name.com:27017 MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス(mongod あるいは mongos)を実行するホストのホスト名、完全修飾ドメイン名(FQDN)、またはインターネット プロトコル アドレス(IPv4 あるいは IPv6)である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
始める | string <date-time> MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
end | string <date-time> MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
period | string 例: period=PT10H Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。 |
{- "groupId": "32b6e34b3d91647abb20e7b8",
- "identifierId": "string",
- "rankedNamespaces": [
- "string"
]
}
指定された名前空間に対するコレクション統計レイテンシのプロセス レベルの測定値一覧を取得します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
processId 必須 | string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:... 例: my.host.name.com:27017 MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは MongoDB プロセス(mongod あるいは mongos)を実行するホストのホスト名、完全修飾ドメイン名(FQDN)、またはインターネット プロトコル アドレス(IPv4 あるいは IPv6)である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。 |
databaseName 必須 | string 例: mydb データベースを識別する、人間が判読可能なラベル。 |
コレクション名 必須 | string 例: mycoll コレクションを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
メトリクス | の配列 string unique アイテム列挙: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_VALUE" "WRITES_P95_VALUE" "WRITES_P99_VALUE" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE" 関連するデータ シリーズについて取得するメトリクスを含むリスト。このパラメーターを設定しない場合、このリソースはすべてのコレクション統計レイテンシのメトリクスに対するデータ シリーズを返します。 |
始める | string <date-time> MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
end | string <date-time> MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
period | string 例: period=PT10H Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。 |
{- "collectionName": "string",
- "databaseName": "string",
- "end": "2019-08-24T14:15:22Z",
- "granularity": "PT1M",
- "groupId": "32b6e34b3d91647abb20e7b8",
- "measurements": [
- {
- "dataPoints": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "value": 0
}
], - "name": "string",
- "units": "BYTES"
}
], - "processId": "mongodb.example.com:27017",
- "start": "2019-08-24T14:15:22Z"
}
カスタム データベースユーザーの権限ロールの返却、追加、編集、削除を行います。カスタムロールを使用して、MongoDB Cloud の組み込みロールでは記述できないアクションのカスタムセットを指定できます。プロジェクトレベルで、プロジェクト内のすべてのクラスターに対してカスタムロールを定義します。このリソースは、MongoDB 権限アクションのサブセットをサポートします。カスタムロールのアクションのサブセットを作成できます。カスタムロールアクションの幅広いリストを作成するには、MongoDB クラウド ユーザー インターフェースを使用してください。カスタムロールには、すべてのプロジェクトのクラスターがサポートし、プロジェクトのクラスターが使用する各 MongoDB バージョンと互換性のあるアクションを含める必要があります。たとえば、プロジェクトに MongoDB 4.2 クラスターがある場合、MongoDB 4.4 で導入されたアクションを使用するカスタムロールを作成することはできません。
指定されたプロジェクトのカスタムロールをすべて返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- {
- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}
]
指定されたプロジェクトに 1 つのカスタムロールを作成します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナー ロール、プロジェクトストリーム処理オーナーロール、またはプロジェクトデータベースアクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクトに 1 つのカスタムロールを作成します。
の配列 オブジェクト (データベース権限アクション) ロールが付与する個々の権限アクションのリスト。 | |
の配列 オブジェクト (継承された役割) unique このカスタムロールが継承する組み込みロールのリスト。 | |
roleName 必須 | string リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。 |
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}
指定されたプロジェクトから 1 つのカスタムロールを削除します。 親ロールやアクションを持たない子ロールを 1 つ以上残すことになる場合、カスタムロールを削除することはできません。 また、ロールが割り当てられないデータベースユーザーを 1 人以上残すことになる場合も、カスタムロールを削除できません。 このリソースを使用するには、リクエストのAPIキーにプロジェクト オーナー ロール、プロジェクト Stream Processing オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
roleName 必須 | string リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
- "error": 400,
- "errorCode": "VALIDATION_ERROR",
- "reason": "Bad Request"
}
指定されたプロジェクトの 1 つのカスタムロールを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
roleName 必須 | string リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}
指定されたプロジェクト内の 1 つのカスタムロールを更新します。 このリソースを使用するには、リクエストのAPIキーにプロジェクト オーナー ロール、プロジェクト Stream Processing オーナー ロール、またはプロジェクト データベース アクセス管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
roleName 必須 | string リクエストのロールを識別する、人間が判読可能なラベル。この名前は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクト内の 1 つのカスタムロールを更新します。
の配列 オブジェクト (データベース権限アクション) ロールが付与する個々の権限アクションのリスト。 | |
の配列 オブジェクト (継承された役割) unique このカスタムロールが継承する組み込みロールのリスト。 |
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
]
}
{- "actions": [
- {
- "action": "FIND",
- "resources": [
- {
- "cluster": true,
- "collection": "string",
- "db": "string"
}
]
}
], - "inheritedRoles": [
- {
- "db": "string",
- "role": "string"
}
], - "roleName": "string"
}
フェデレーティッドデータベースインスタンスの返却、追加、編集、削除を行います。このリソースには、プロジェクトIDが必要です。フェデレーティッドデータベースインスタンスの構成変更はコストに影響する可能性があります。
指定されたプロジェクト内のすべてのフェデレーティッドデータベースインスタンスの詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用以上のロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
タイプ | string デフォルト: "USER" 列挙: "USER" "ONLINE_ARCHIVE" 返却対象のフェデレーティッドデータベースインスタンスのタイプ。 |
[- {
- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- null
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}
]
指定されたプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成します。このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
skipRoleValidation | ブール値 デフォルト: false このリクエストで、リクエスト元 IAM ロールの S3 バケット読み取り可否を確認するかどうかを示すフラグ。AWS は、バケットに書き込む前に、ロールがバケット内のオブジェクトを一覧できるかどうかを確認します。一部の IAM ロールには書き込み権限のみが必要です。このフラグを使用すると、そのチェックをスキップできます。 |
指定されたプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成するための詳細。
オブジェクト (データフェデレーション クラウドプロバイダー) このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダー。 | |
オブジェクト (DataLakeDataProcessRegion) フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。 | |
name | string フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 |
オブジェクト (DataLakeStorage) 各データ ストアの構成情報と MongoDB Cloud データベースへのマッピング。 |
{- "cloudProviderConfig": {
- "aws": {
- "roleId": "32b6e34b3d91647abb20e7b8",
- "testS3Bucket": "string"
}, - "azure": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "gcp": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "name": "string",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}
{- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}
指定されたプロジェクトから 1 つのフェデレーティッドデータベースインスタンスを削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
tenantName 必須 | string 削除対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクト内の 1 つのフェデレーティッドデータベースインスタンスの詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
tenantName 必須 | string 返却対象のフェデレーティッド データベースを特定する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}
指定されたプロジェクト内の 1 つのフェデレーティッドデータベースインスタンスの詳細を更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナー以上のロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
tenantName 必須 | string 更新対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty | |
skipRoleValidation 必須 | ブール値 このリクエストで、リクエスト元 IAM ロールの S3 バケット読み取り可否を確認するかどうかを示すフラグ。AWS は、バケットに書き込む前に、ロールがバケット内のオブジェクトを一覧できるかどうかを確認します。一部の IAM ロールには書き込み権限のみが必要です。このフラグを使用すると、そのチェックをスキップできます。 |
指定されたプロジェクト内の更新対象フェデレーティッド データベースの詳細。
オブジェクト (データフェデレーション クラウドプロバイダー) このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダー。 | |
オブジェクト (DataLakeDataProcessRegion) フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。 | |
name | string フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 |
オブジェクト (DataLakeStorage) 各データ ストアの構成情報と MongoDB Cloud データベースへのマッピング。 |
{- "cloudProviderConfig": {
- "aws": {
- "roleId": "32b6e34b3d91647abb20e7b8",
- "testS3Bucket": "string"
}, - "azure": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "gcp": {
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "name": "string",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}
{- "cloudProviderConfig": {
- "aws": {
- "externalId": "string",
- "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
- "iamUserARN": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}, - "azure": {
- "atlasAppId": "string",
- "roleId": "32b6e34b3d91647abb20e7b8",
- "servicePrincipalId": "string",
- "tenantId": "string"
}, - "gcp": {
- "gcpServiceAccount": "string",
- "roleId": "32b6e34b3d91647abb20e7b8"
}
}, - "dataProcessRegion": {
- "cloudProvider": "AWS",
- "region": "SYDNEY_AUS"
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "hostnames": [
- "string"
], - "name": "string",
- "privateEndpointHostnames": [
- {
- "hostname": "string",
- "privateEndpoint": "string"
}
], - "state": "UNVERIFIED",
- "storage": {
- "databases": [
- {
- "collections": [
- {
- "dataSources": [
- {
- "allowInsecure": false,
- "collection": "string",
- "collectionRegex": "string",
- "database": "string",
- "databaseRegex": "string",
- "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
- "datasetPrefix": "string",
- "defaultFormat": ".avro",
- "path": "string",
- "provenanceFieldName": "string",
- "storeName": "string",
- "trimLevel": 0,
- "urls": [
- "string"
]
}
], - "name": "string"
}
], - "maxWildcardCollections": 100,
- "name": "string",
- "views": [
- {
- "name": "string",
- "pipeline": "string",
- "source": "string"
}
]
}
], - "stores": [
- {
- "name": "string",
- "provider": "string",
- "additionalStorageClasses": [
- "STANDARD"
], - "bucket": "string",
- "delimiter": "string",
- "includeTags": false,
- "prefix": "string",
- "public": false,
- "region": "US_GOV_WEST_1"
}
]
}
}
指定されたプロジェクト内のフェデレーティッドデータベースインスタンスのクエリ制限を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
tenantName 必須 | string クエリ制限を取得する対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- {
- "currentUsage": 0,
- "defaultLimit": 0,
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "maximumLimit": 0,
- "name": "string",
- "overrunPolicy": "BLOCK",
- "tenantName": "string",
- "value": 0
}
]
1 つのフェデレーティッドデータベースインスタンスの 1 つのクエリ制限を削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 | |||||||||||||||
tenantName 必須 | string クエリ制限が適用されるフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 | |||||||||||||||
limitName 必須 | string 列挙: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly" このデータ フェデレーション インスタンスの制限を識別する、人間が判読可能なラベル。
|
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{ }
指定されたプロジェクト内の指定されたフェデレーティッドデータベースインスタンスの 1 つのクエリ制限の詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 | |||||||||||||||
tenantName 必須 | string クエリ制限が適用されるフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 | |||||||||||||||
limitName 必須 | string 列挙: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly" このデータ フェデレーション インスタンスの制限を識別する、人間が判読可能なラベル。
|
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "currentUsage": 0,
- "defaultLimit": 0,
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "maximumLimit": 0,
- "name": "string",
- "overrunPolicy": "BLOCK",
- "tenantName": "string",
- "value": 0
}
1 つのフェデレーティッドデータベースインスタンスに対して 1 つのクエリ制限を作成または更新します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 | |||||||||||||||
tenantName 必須 | string クエリ制限が適用されるフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 | |||||||||||||||
limitName 必須 | string 列挙: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly" このデータ フェデレーション インスタンスの制限を識別する、人間が判読可能なラベル。
|
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
1 つのフェデレーティッドデータベースインスタンスに対して 1 つのクエリ制限を作成または更新します。
overrunPolicy | string 列挙: "BLOCK" "BLOCK_AND_KILL" Data Federation の制限にのみ使用されます。使用量の制限を超えた場合に実行するアクション。制限範囲が QUERY に設定されている場合、MongoDB Cloud は使用制限を超えるとクエリを停止するため、これは無視されます。 |
価値 必須 | integer <int64> 制限を設定する量。 |
{- "overrunPolicy": "BLOCK",
- "value": 0
}
{- "currentUsage": 0,
- "defaultLimit": 0,
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "maximumLimit": 0,
- "name": "string",
- "overrunPolicy": "BLOCK",
- "tenantName": "string",
- "value": 0
}
指定されたフェデレーティッドデータベースインスタンスのクエリ ログをダウンロードします。このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクトデータアクセス読み取り/書き込みのロールが必要です。API は、JSON 応答スキーマを使用した直接呼び出しをサポートしていません。"Accept: application/vnd.atlas.YYYY-MM-DD+gzip" という形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエストする必要があります。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
tenantName 必須 | string クエリ ログをダウンロードする対象のフェデレーティッドデータベースインスタンスを識別する、人間が判読できるラベル。 |
endDate | integer <int64> 1199145600 例: endDate=1636481348 ダウンロードするログ メッセージの範囲の終了ポイントを指定するタイムスタンプ。MongoDB Cloud は、このタイムスタンプを UNIXエポックからの経過秒数で表現します。 |
startDate | integer <int64> 1199145600 例: startDate=1636466948 ダウンロードするログ メッセージの範囲の開始ポイントを指定するタイムスタンプ。MongoDB Cloud は、このタイムスタンプを UNIXエポックからの経過秒数で表現します。 |
{- "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
- "error": 400,
- "errorCode": "VALIDATION_ERROR",
- "reason": "Bad Request"
}
指定されたプロジェクト内のフェデレーティッドデータベースインスタンスとオンラインアーカイブのすべてのプライベートエンドポイントを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty |
{- "results": [
- {
- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}
], - "totalCount": 0
}
フェデレーティッドデータベースインスタンスとオンラインアーカイブ用のプライベートエンドポイントを 1 つ指定のプロジェクトに追加します。エンドポイント ID がすでに存在し、関連するコメントが変更されていない場合、Atlas Data Federation はエンドポイント ID リストに変更を加えません。エンドポイント ID がすでに存在し、関連するコメントが変更された場合、Atlas Data Federation はエンドポイント ID リスト内のコメントの値のみをアップデートします。エンドポイント ID が存在しない場合、Atlas Data Federation は新しいエンドポイントをエンドポイント ID リスト内のエンドポイントのリストに追加します。各リージョンには、各リージョンのさまざまなエンドポイントに対応するサービス名が関連付けられています。
us-east-1
は com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4
です。
us-west-1
は com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb
です。
eu-west-1
は com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e
です。
eu-west-2
は com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9
です。
eu-central-1
は com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d
です。
sa-east-1
は com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044
です。
ap-southeast-2
は com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e
です。
ap-south-1
は com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d
です。
このリソースを使用するには、リクエスト元の API キーにプロジェクトオーナーまたはプロジェクト Charts 管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
指定されたプロジェクトに追加するフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイント。
azureLinkId | string Azureプライベートエンドポイント接続を識別するリンクID 。 |
comment | string このプライベートエンドポイントに関連付ける、人間が判読可能な文字列。 |
customerEndpointDNSName | string 顧客の VPC エンドポイント DNS 名を識別するための人間が判読可能なラベル。定義されている場合は、リージョンの値も指定する必要があります。 |
customerEndpointIPAddress | string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))... Azureプライベートエンドポイントへの接続に使用されるIPアドレス。 |
endpointId 必須 | string^vpce-[0-9a-f]{17}$ プライベート エンドポイントを識別するユニークな 22 文字の英数字文字列。 |
errorsMessage | string プライベートエンドポイントリクエストの承認の失敗を説明するエラーメッセージ。 |
プロバイダー | string デフォルト: "AWS" 値: "AWS" クラウド サービス プロバイダーを識別する、人間が判読可能なラベル。Atlas Data Lake は Amazon Web Services のみをサポートしています。 |
リージョン | string 顧客の VPC エンドポイントのリージョンを識別するための、人間が判読可能なラベル。定義されている場合は、customerEndpointDNSName の値も指定する必要があります。 |
状態 | string 列挙: "PENDING" " OK" "FAILED" "DELEING" プライベートエンドポイント接続リクエストのステータス。 |
タイプ | string デフォルト: "DATA_LAKE" 値: "DATA_LAKE" このプライベートエンドポイントに関連付けられているリソースの種類を識別する、人間が判読可能なラベル。 |
{- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}
{- "results": [
- {
- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}
], - "totalCount": 0
}
指定されたプロジェクト内のフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイントを 1 つ削除します。このリソースを使用するには、リクエスト元の API キーにプロジェクト オーナーのロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
endpointId 必須 | string^vpce-[0-9a-f]{17}$ 削除対象のプライベートエンドポイントを識別する、ユニークな 22 文字の英数字文字列。Atlas Data Federation は、AWS PrivateLink 機能を使用して AWS プライベートエンドポイントをサポートします。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{ }
指定されたプロジェクト内のフェデレーティッドデータベースインスタンスまたはオンラインアーカイブの、指定されたプライベートエンドポイントを返します。このリソースを使用するには、リクエスト元の API キーにプロジェクト読み取り専用ロールまたはプロジェクト Charts 管理者ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
endpointId 必須 | string^vpce-[0-9a-f]{17}$ 返却されるプライベートエンドポイントを識別するユニークな 22 文字の英数字文字列。Atlas Data Federation は、AWS PrivateLink 機能を使用して AWS プライベートエンドポイントをサポートします。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "azureLinkId": "string",
- "comment": "string",
- "customerEndpointDNSName": "string",
- "customerEndpointIPAddress": "string",
- "endpointId": "vpce-3bf78b0ddee411ba1",
- "errorMessage": "string",
- "provider": "AWS",
- "region": "US_EAST_1",
- "status": "PENDING",
- "type": "DATA_LAKE"
}
Atlas Data Lake パイプラインおよび関連する実行を返却、編集、削除します。
Data Lake パイプラインの一覧を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
[- {
- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS",
- "clusterName": "string",
- "collectionName": "string",
- "databaseName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}
]
1 つの Data Lake パイプラインを作成します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
1 つの Data Lake パイプラインを作成します。
オブジェクト (データセット保持ポリシー) スケジュールされた Data Lake パイプラインのデータセット保持ポリシー。 | |
name | string この Data Lake パイプラインの名前。 |
オブジェクト (取り込み先) Data Lake パイプラインの取り込み先。 | |
オブジェクト (取り込み元) Data Lake パイプラインの取り込み元。 | |
の配列 オブジェクト (フィールド変換) この Data Lake パイプラインで除外するフィールド。 |
{- "datasetRetentionPolicy": {
- "units": "DAYS",
- "value": 1
}, - "name": "string",
- "sink": { },
- "source": {
- "type": "PERIODIC_CPS",
- "clusterName": "string",
- "collectionName": "string",
- "databaseName": "string"
}, - "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}
{- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS",
- "clusterName": "string",
- "collectionName": "string",
- "databaseName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}
1 つの Data Lake パイプラインを削除します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
pipelineName 必須 | string^[^/\\ "$]{1,64}$ Data Lake パイプラインを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
{ }
指定されたプロジェクト内の 1 つの Data Lake パイプラインの詳細を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
pipelineName 必須 | string^[^/\\ "$]{1,64}$ Data Lake パイプラインを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
{- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS",
- "clusterName": "string",
- "collectionName": "string",
- "databaseName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}
1 つの Data Lake パイプラインを更新します。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
pipelineName 必須 | string^[^/\\ "$]{1,64}$ Data Lake パイプラインを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
1 つの Data Lake パイプラインを更新します。
オブジェクト (データセット保持ポリシー) スケジュールされた Data Lake パイプラインのデータセット保持ポリシー。 | |
name | string この Data Lake パイプラインの名前。 |
オブジェクト (取り込み先) Data Lake パイプラインの取り込み先。 | |
オブジェクト (取り込み元) Data Lake パイプラインの取り込み元。 | |
の配列 オブジェクト (フィールド変換) この Data Lake パイプラインで除外するフィールド。 |
{- "datasetRetentionPolicy": {
- "units": "DAYS",
- "value": 1
}, - "name": "string",
- "sink": { },
- "source": {
- "type": "PERIODIC_CPS",
- "clusterName": "string",
- "collectionName": "string",
- "databaseName": "string"
}, - "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}
{- "_id": "32b6e34b3d91647abb20e7b8",
- "createdDate": "2019-08-24T14:15:22Z",
- "datasetRetentionPolicy": {
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "units": "DAYS",
- "value": 1
}, - "groupId": "32b6e34b3d91647abb20e7b8",
- "lastUpdatedDate": "2019-08-24T14:15:22Z",
- "name": "string",
- "sink": {
- "type": "DLS"
}, - "source": {
- "type": "PERIODIC_CPS",
- "clusterName": "string",
- "collectionName": "string",
- "databaseName": "string",
- "groupId": "32b6e34b3d91647abb20e7b8"
}, - "state": "ACTIVE",
- "transformations": [
- {
- "field": "string",
- "type": "EXCLUDE"
}
]
}
Data Lake パイプラインのソースとして使用できるバックアップ スケジュール ポリシーアイテムの一覧を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
pipelineName 必須 | string^[^/\\ "$]{1,64}$ Data Lake パイプラインを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
pretty |
[- {
- "frequencyInterval": 1,
- "frequencyType": "daily",
- "id": "32b6e34b3d91647abb20e7b8",
- "retentionUnit": "days",
- "retentionValue": 0
}
]
オンデマンドパイプラインの実行をトリガーするために使用できるバックアップ スナップショットの一覧を返します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
グループ ID 必須 | string^([a-f0-9]{24})$ 例: 32b6e34b3d91647abb20e7b8 プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、/groups エンドポイントを使用します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
pipelineName 必須 | string^[^/\\ "$]{1,64}$ Data Lake パイプラインを識別する、人間が判読可能なラベル。 |
envelope | ブール値 デフォルト: false 例: envelope=false アプリケーションがレスポンスを |
includeCount | ブール値 デフォルト: true 例: includeCount=true レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。 |
itemsPerPage | integer [ 1 .. 500 ] デフォルト: 100 例: itemsPerPage=100 レスポンスが返す 1 ページあたりのアイテムの数。 |
pageNum | integer >= 1 デフォルト: 1 例: pageNum=1 レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。 |
pretty | |
completedAfter | string <date-time> MongoDB Cloud がスナップショットを作成した日時。指定すると、MongoDB Cloud はこの日時以降に作成された利用可能なバックアップ スナップショットのみを返します。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。 |