返回一个集群的高级配置选项
返回指定项目中一个集群的高级配置详细信息。集群包含一组维护相同数据集的主机。高级配置详细信息包括读/写关注、索引和 oplog 限制，以及其他数据库设置。此功能不适用于 M0 免费集群、M2 和 M5 共享层级集群、Flex 集群或无服务器集群。要使用此资源，请求的服务帐户或 API 密钥必须具有“项目只读”角色。已弃用的版本：v2-{2023-01-01}
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
用于标识集群的人类可读标签。
格式应符合以下模式：
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false。Prettyprint
GET /API/Atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs
Atlas CLI
atlas api clusters getGroupClusterProcessArgs --helpimport (
"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"
}