设置一个项目限制

修补 /api/atlas/v2/groups/{groupId}/limits/{limitName}

服务账户 DigestAuth

设置指定项目限制。要使用此资源，请求的服务账户或 API 密钥必须具有“项目所有者”角色。

注意：增加以下配置限制可能会导致 MongoDB Cloud UI 的响应时间变慢，或者增加用户管理开销，从而导致重建身份验证或授权架构。如果可能，我们建议您创建更多项目来获取更多此类资源，从而实现更加可持续的增长模式。

路径参数

limitName

字符串必需

人类可读标签，用于标识此项目限制。

限制名称	说明	默认	API 覆盖限制
atlas.project.deployment.clusters	此项目中的集群数量限制	25	100
atlas.project.deployment.nodesPerPrivateLinkRegion	此项目中每个专用链接地区的节点数限制	50	90
atlas.project.security.databaseAccess.customRoles	此项目中自定义角色的数量限制	100	1400
atlas.project.security.databaseAccess.users	此项目中的数据库用户数量限制	100	100
atlas.project.security.networkAccess.crossRegionEntries	此项目跨区域网络访问入口数量限制	40	220
atlas.project.security.networkAccess.entries	此项目中网络访问入口的数量限制	200	20
dataFederation.bytesProcessed.query	单个 Data Federation 查询期间处理的字节数限制	不适用	不适用
dataFederation.bytesProcessed.daily	当日所有 Atlas Data Federation 租户中处理的字节数限制	不适用	不适用
dataFederation.bytesProcessed.weekly	当前一周所有 Atlas Data Federation 租户中处理的字节数限制	不适用	不适用
dataFederation.bytesProcessed.monthly	当月所有 Atlas Data Federation 租户中处理的字节数限制	不适用	不适用
atlas.project.deployment.privateServiceConnectionsPerRegionGroup	每个区域群组的私有服务连接数	50	100
atlas.project.deployment.privateServiceConnectionsSubnetMask	GCP PSC 网络的子网掩码。下限为 20。	27	27

值为 atlas.project.security.databaseAccess.users、atlas.project.deployment.clusters、atlas.project.deployment.serverlessMTMs、atlas.project.security.databaseAccess.customRoles、atlas.project.security.networkAccess.entries、atlas.project.security.networkAccess.crossRegionEntries、atlas.project.deployment.nodesPerPrivateLinkRegion、dataFederation.bytesProcessed.query、dataFederation.bytesProcessed.daily、dataFederation.bytesProcessed.weekly、dataFederation.bytesProcessed.monthly、atlas.project.deployment.privateServiceConnectionsPerRegionGroup、或 atlas.project.deployment.privateServiceConnectionsSubnetMask。

groupId 字符串必需

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

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

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

查询参数

envelope 布尔

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

默认值为false 。
pretty 布尔

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

默认值为false 。

Prettyprint

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

body 对象必需

限制更新。

响应

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

正常
以下之一：
atlas。项目.security.networkAccess.entries 对象 atlas。项目.security.networkAccess.entries 对象 atlas。项目.security.networkAccess.entries 对象 atlas。项目.security.networkAccess.entries 对象 atlas。项目.security.networkAccess.entries 对象 atlas。项目.security.networkAccess.entries 对象 atlas。项目.security.networkAccess.entries 对象
用户托管的限制的详细信息。

隐藏属性显示属性

currentUsage integer(int64)

指示当前限制使用情况的金额。

defaultLimit integer(int64)

限制的默认值。

maximumLimit integer(int64)

限制的最大值。

名称字符串必需鉴别器

人类可读标签，用于标识要修改的用户管理限制。

值为 atlas.project.security.networkAccess.entries。

值 integer(int64) 必需

要设置限制的金额。
用户托管的限制的详细信息。

隐藏属性显示属性

currentUsage integer(int64)

指示当前限制使用情况的金额。

defaultLimit integer(int64)

限制的默认值。

maximumLimit integer(int64)

限制的最大值。

名称字符串必需鉴别器

人类可读标签，用于标识要修改的用户管理限制。

值为 atlas.project.security.networkAccess.entries。

值 integer(int64) 必需

要设置限制的金额。
用户托管的限制的详细信息。

隐藏属性显示属性

currentUsage integer(int64)

指示当前限制使用情况的金额。

defaultLimit integer(int64)

限制的默认值。

maximumLimit integer(int64)

限制的最大值。

名称字符串必需鉴别器

人类可读标签，用于标识要修改的用户管理限制。

值为 atlas.project.security.networkAccess.entries。

值 integer(int64) 必需

要设置限制的金额。
用户托管的限制的详细信息。

隐藏属性显示属性

currentUsage integer(int64)

指示当前限制使用情况的金额。

defaultLimit integer(int64)

限制的默认值。

maximumLimit integer(int64)

限制的最大值。

名称字符串必需鉴别器

人类可读标签，用于标识要修改的用户管理限制。

值为 atlas.project.security.networkAccess.entries。

值 integer(int64) 必需

要设置限制的金额。
用户托管的限制的详细信息。

隐藏属性显示属性

currentUsage integer(int64)

指示当前限制使用情况的金额。

defaultLimit integer(int64)

限制的默认值。

maximumLimit integer(int64)

限制的最大值。

名称字符串必需鉴别器

人类可读标签，用于标识要修改的用户管理限制。

值为 atlas.project.security.networkAccess.entries。

值 integer(int64) 必需

要设置限制的金额。
用户托管的限制的详细信息。

隐藏属性显示属性

currentUsage integer(int64)

指示当前限制使用情况的金额。

defaultLimit integer(int64)

限制的默认值。

maximumLimit integer(int64)

限制的最大值。

名称字符串必需鉴别器

人类可读标签，用于标识要修改的用户管理限制。

值为 atlas.project.security.networkAccess.entries。

值 integer(int64) 必需

要设置限制的金额。
用户托管的限制的详细信息。

隐藏属性显示属性

currentUsage integer(int64)

指示当前限制使用情况的金额。

defaultLimit integer(int64)

限制的默认值。

maximumLimit integer(int64)

限制的最大值。

名称字符串必需鉴别器

人类可读标签，用于标识要修改的用户管理限制。

值为 atlas.project.security.networkAccess.entries。

值 integer(int64) 必需

要设置限制的金额。
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 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
409 application/json

冲突。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
500 application/json

内部服务器错误。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

PATCH /api/atlas/v2 /groups/{groupId}/limits/{limitName}

atlas api projects setGroupLimit --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.SetGroupLimitApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		SetGroupLimitWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \
  -d '{ <Payload> }'

请求示例

{
  "value": 42,
  "name": "atlas.project.security.networkAccess.entries"
}

{
  "value": 42,
  "name": "atlas.project.security.networkAccess.entries"
}

{
  "value": 42,
  "name": "atlas.project.security.networkAccess.entries"
}

{
  "value": 42,
  "name": "atlas.project.security.networkAccess.entries"
}

{
  "value": 42,
  "name": "atlas.project.security.networkAccess.entries"
}

{
  "value": 42,
  "name": "atlas.project.security.networkAccess.entries"
}

{
  "value": 42,
  "name": "atlas.project.security.networkAccess.entries"
}

响应示例 (200)

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}

{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 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"
}

响应示例 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

响应示例 (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"
}