1 つのクラスターの高度な構成オプションを返す 非推奨

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs

指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り書込み保証 (write concern)、インデックスおよびoplog制限、およびその他のデータベース設定が含まれます。この機能は、M0 の無料クラスター、M2M5 の共有階層クラスター、フレキシブルなクラスター、サーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトの読み取り専用ロールが必要です。

グローバルクラスター

path パラメータ

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

    : グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

  • clusterName string 必須

    クラスターを識別する人間が判読できるラベル。

    形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$

クエリ パラメータ

  • envelope ブール値

    アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

    デフォルト値はfalseです。

  • pretty ブール値

    レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

    デフォルト値はfalseです。

    Prettyprint

応答

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • changeStreamOptionsPreAndPostImagesExpirationAfterSeconds integer(int32)

      変更前と変更後のイメージの最小保持時間(秒単位)。

      デフォルト値は-1です。

      このオプションは、... に対応します。
    • chunkMigrationConcurrency integer(int32)

      チャンク移行のソース シャードおよび受信シャード上のスレッドの数。スレッドの数は、シャーディングされたクラスター内の CPU コアの合計数の半分を超えてはなりません。

      このオプションは、... に対応します。
    • customOpensslCisphereConfigTls12 array[string]

      TLS 1.2 のカスタム OpenSSL 暗号スイート リスト。 このフィールドは、tlsCipherConfigModeCUSTOM に設定されている場合にのみ有効です。

      値は TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 または TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 です。

    • デフォルトMaxTimeMS integer(int32)

      個々の読み取り操作完了のためのデフォルトの時間制限(ミリ秒単位)。

      このオプションは、... に対応します。
    • defaultReadConcern string

      このクラスターに設定された読み取り操作に対して、MongoDB から要求される確認応答のデフォルト レベル。

      MongoDB 4.4 クラスターのデフォルトは available です。MongoDB 5.0 以降のクラスターのデフォルトは local です。

      値は local または available です。デフォルト値は available です。

      このオプションは、... に対応します。
    • defaultWriteConcern string

      ドライバーによって何も指定されていない場合に、書込み (write) 操作に対して MongoDB が要求する確認応答のデフォルト レベル。

      このオプションは、... に対応します。
    • failIndexKeyTooLong ブール値 非推奨

      すべてのインデックスエントリが 1024 バイトを超えないドキュメントを挿入または更新できるかどうかを示すフラグ。これが false に設定されている場合、mongod はこの制限を超えるドキュメントを書込みますが、インデックスしません。MongoDB 4.4 以降、このパラメータは削除されました。

      デフォルト値はtrueです。

      このオプションは、... に対応します。
    • javascriptEnabled ブール値

      クラスターが JavaScript のサーバー側実行を行う操作の許可の是非を示すフラグ。8.0+ を使用する場合、よりパフォーマンスの高い代替手段として、サーバーサイドの JavaScript を無効にし、集約パイプラインの演算子を使用することをお勧めします。

      このオプションは、モード .. に対応します。
    • minimumEnabledTlsProtocol string

      クラスターが受信接続に受け入れる TLS(Transport Layer Security)の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。

      値は TLS1_0TLS1_1、または TLS1_2 です。

      このオプションは、... に対応します。
    • noTableScan ブール値

      結果を返すためにコレクションスキャンが必要なクエリについて、クラスターで実行が無効化されているかどうかを示すフラグ。

      このオプションは、... に対応します。
    • oplogMinRetentionHours number(double) | null

      クラスターの oplog の最小保持ウィンドウ(単位は時間)。null 値の場合、MongoDB Cloud が計算するデフォルトの最小 oplog window をクラスターが使用することを示します。

      このオプションは、... に対応します。
    • oplogSizeMB 整数(int32) | null

      クラスターの oplog のストレージ制限(単位はメガバイト)。null 値の場合、MongoDB Cloud が計算するデフォルトの oplog サイズをクラスターが使用することを示します。

      このオプションは、... に対応します。
    • queryStatsLogVerbosity integer(int32)

      1(無効)または 3(有効)に設定できます。3 に設定されている場合、Atlas は編集され、匿名化された $queryStats 出力を MongoDB ログに含めます。$queryStats 出力にはリテラル値またはフィールド値は含まれません。この設定を有効にすると、クラスターのパフォーマンスに影響を与える可能性があります。

      このオプションは、... に対応します。
    • sampleRefreshIntervalBIConnector integer(int32)

      mongosqld プロセスがデータを再サンプリングしてリレーショナル スキーマを作成する間隔(単位は秒)。

      の最小値は 0 です。デフォルト値は 0 です。

      このオプションは、... に対応します。
    • sampleSizeBIConnector integer(int32)

      スキーマ情報を収集するときにサンプリングするデータベースあたりのドキュメントの数。

      の最小値は 0 です。

      このオプションは、... に対応します。
    • tlsCisphereConfigMode string

      TLS 暗号スイートの 構成モード。 デフォルトモードでは、デフォルトの暗号スイートが使用されます。 カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。

      値は CUSTOM または DEFAULT です。

    • transactionLifetimeLimitSeconds integer(int64)

      マルチドキュメントトランザクションの有効期間(単位は秒)。Atlas は、この制限を超えるトランザクションは期限切れと見なし、定期的なクリーンアップ プロセスによって中断します。

      の最小値は 1 です。

      このオプションは、... に対応します。
  • 400 application/ JSON

    無効なリクエストです。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 404 application/ JSON

    見つかりません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

GET /API/Atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs
atlas api clusters getGroupClusterProcessArgs --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20240530001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetGroupClusterProcessArgsApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		GetGroupClusterProcessArgsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-05-30+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-05-30+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true"
応答の例(200)
{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultReadConcern": "available",
  "defaultWriteConcern": "string",
  "failIndexKeyTooLong": true,
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}
応答の例(400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
応答の例(401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
応答の例(403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
応答の例(404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
応答の例(500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}