返回一个集群的高级配置选项

获取 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs

返回指定项目中一个集群的高级配置详细信息。集群包含一组维护相同数据集的主机。高级配置详细信息包括读/写关注、索引和 oplog 限制,以及其他数据库设置。此功能不适用于 M0 免费集群、M2M5 共享层级集群、Flex 集群或无服务器集群。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目只读”角色。已弃用的版本:v2-{2023-01-01}

Atlas 全球集群

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

    格式应符合以下模式:^([a-f0-9]{24})$

  • 集群名称 字符串 必需

    用于标识集群的人类可读标签。

    格式应符合以下模式:^[a-zA-Z0-9][a-zA-Z0-9-]*$

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false

    Prettyprint

响应

  • 200 application/vnd.atlas.2024-08-05+json

    正常

    隐藏响应属性 显示响应属性 对象
    • changeStreamOptionsPreAndPostImagesExpireAfterSeconds integer(int32)

      图像前和图像后的最小保留时间(以秒为单位)。

      默认值为-1

      该选项对应于...
    • chunkMigrationConcurrency integer(int32)

      源分片和接收分片上用于数据段迁移的线程数。线程数不应超过分片集群中 CPU 内核总数的一半。

      该选项对应于...
    • customOpensslCipherConfigTls12 array[string]

      TLS 1.2 的自定义 OpenSSL 密码套件列表。 此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

      值为 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

    • defaultMaxTimeMS integer(int32)

      单个读取操作必须在默认时间限制内完成(以毫秒为单位)。

      该选项对应于...
    • 默认写关注 字符串

      当没有写入操作被驱动程序指定时,请求 MongoDB 确认的默认级别。

      该选项对应于...
    • Javascript 启用 布尔

      指示集群是否允许执行服务器端执行 JavaScript 的操作的标志。 使用 8.0 + 时,我们建议禁用服务器端 JavaScript 并使用聚合管道的操作符作为性能更高的替代方案。

      此选项对应于 mod...
    • minimumEnabledTlsProtocol 字符串

      集群接受的用于传入连接的最低传输层安全性 (TLS) 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS 协议版本。

      值为 TLS1_0TLS1_1TLS1_2

      该选项对应于...
    • noTableScan 布尔

      该标志指示集群是否禁用执行需要集合扫描才能返回结果的查询。

      该选项对应于...
    • oplogMinRetentionHours number(double) | null

      集群 oplog 的最小保留窗口以小时为单位。null 值表示集群使用 MongoDB Cloud 计算的默认最小 oplog 窗口。

      该选项对应于...
    • oplogSizeMB 整数 (int32) | null

      集群 oplog 的存储限制(以兆字节为单位)。null 值表示集群使用 MongoDB Cloud 计算的默认 oplog 大小。

      该选项对应于...
    • queryStatsLogVerbosity integer(int32)

      可设置为 1(禁用)或 3(启用)。当设置为 3 时,Atlas 将在 MongoDB 日志中包含经过编辑和匿名的 $queryStats 输出。$queryStats 输出不包含文字或字段值。启用此设置可能会影响集群的性能。

      该选项对应于...
    • sampleRefreshIntervalBIConnector integer(int32)

      mongsqld 进程重新进行数据采样以创建其关系模式的时间间隔(以秒为单位)。

      最小值为 0。默认值为 0

      该选项对应于...
    • sampleSizeBIConnector integer(int32)

      收集架构信息时要采样的每个数据库的文档数。

      最小值为 0

      该选项对应于...
    • tlsCipherConfigMode 字符串

      TLS 密码套件配置模式。 默认模式使用默认密码套件。 自定义模式允许您为 TLS 1.2 和 TLS 1.3 指定自定义密码套件。

      值为 CUSTOMDEFAULT

    • transactionLifetimeLimitSeconds integer(int64)

      多文档事务的生命周期(以秒为单位)。Atlas 认为超过此限制的事务已过期,因此会通过定期清理过程予以中止。

      最小值为 1

      该选项对应于...
  • 400 application/json

    错误请求。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

GET /API/Atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs
atlas api clusters getProcessArgs --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241113001/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-11-13+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-11-13+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,
  "defaultWriteConcern": "string",
  "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"
}