PUT /api/atlas/v2/groups/{groupId}/logIntegrations/{id}

更新由其唯一ID标识的一个日志集成的配置。要使用此资源,请求的服务帐户或API密钥必须具有“组织所有者”或“项目所有者”角色。目前正处于预览阶段。请联系您的客户成功经理(CSM) 以访问权限。

路径参数

  • groupId 字符串 必需

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

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

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

  • id 字符串 必需

    日志集成配置的唯一标识符。

查询参数

  • envelope 布尔

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

    默认值为false

  • pretty 布尔

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

    默认值为false

    Prettyprint
application/vnd.atlas.2025-03-12+json

body 必需

更新了日志集成配置。

  • 类型 字符串 必需 鉴别器

    人类可读标签,用于标识要与MongoDB Cloud 集成的服务。该值必须与日志集成类型匹配。

    值为 S3_LOG_EXPORT

  • bucketName 字符串 必需

    人类可读标签,用于标识用于存储日志文件的 S3 存储桶名称。

  • iamRoleId 字符串 必需

    唯一的 24-十六进制数字字符串,用于标识MongoDB Cloud 用于访问权限S3 存储桶的 AWS IAM角色。

  • kmsKey 字符串 | null

    用于服务器端加密的AWS KMS密钥ID或 ARN(可选)。如果未提供,则使用存储桶默认加密设置。

  • logTypes array[string] 必需

    要导出到 S3 的日志类型数组。有效值:MONGOD、MNGOS、MONGOD_AUDIT、MNGOS_AUDIT。

    至少 1 个但不超过 4 个元素。值为 MONGODMONGOSMONGOD_AUDITMONGOS_AUDIT

  • prefixPath 字符串 必需

    S3 将存储日志文件的目录路径前缀。 MongoDB Cloud 将根据日志类型添加更多子目录。

响应

  • 200 application/vnd.atlas.2025-03-12+json

    正常

    隐藏响应属性 显示响应属性 对象
    • id 字符串 必需

      唯一的 24 个字符的十六进制数字字符串,用于标识日志集成配置。

    • 类型 字符串 必需 鉴别器

      人类可读标签,用于标识要与MongoDB Cloud 集成的服务。该值必须与日志集成类型匹配。

      值为 S3_LOG_EXPORT

    • bucketName 字符串 必需

      人类可读标签,用于标识用于存储日志文件的 S3 存储桶名称。

    • iamRoleId 字符串 必需

      唯一的 24-十六进制数字字符串,用于标识MongoDB Cloud 用于访问权限S3 存储桶的 AWS IAM角色。

    • kmsKey 字符串 | null

      用于服务器端加密的AWS KMS密钥ID或 ARN(可选)。如果未提供,则使用存储桶默认加密设置。

    • logTypes array[string]

      要导出到 S3 的日志类型数组。有效值:MONGOD、MNGOS、MONGOD_AUDIT、MNGOS_AUDIT。

      不超过 4 个元素。值为 MONGODMONGOSMONGOD_AUDITMONGOS_AUDIT

    • prefixPath 字符串 必需

      S3 将存储日志文件的目录路径前缀。 MongoDB Cloud 将根据日志类型添加更多子目录。

  • 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 状态代码。

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

PUT /api/atlas/v2 /groups/{groupId}/logIntegrations/{id}
atlas api pushBasedLogExport updateGroupLogIntegration --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.UpdateGroupLogIntegrationApiParams{}
	sdkResp, httpResp, err := client.Push - BasedLogExportApi.
		UpdateGroupLogIntegrationWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations/{id}" \
  -d '{ <Payload> }'
请求示例
{
  "type": "S3_LOG_EXPORT",
  "bucketName": "my-log-bucket",
  "iamRoleId": "507f1f77bcf86cd799439011",
  "kmsKey": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
  "logTypes": [
    "MONGOD",
    "MONGOS",
    "MONGOD_AUDIT",
    "MONGOS_AUDIT"
  ],
  "prefixPath": "mongo-logs/"
}
响应示例 (200)
{
  "id": "507f1f77bcf86cd799439011",
  "type": "S3_LOG_EXPORT",
  "bucketName": "my-log-bucket",
  "iamRoleId": "507f1f77bcf86cd799439011",
  "kmsKey": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
  "logTypes": [
    "MONGOD",
    "MONGOS",
    "MONGOD_AUDIT",
    "MONGOS_AUDIT"
  ],
  "prefixPath": "mongo-logs/"
}
响应示例 (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"
}