指定したプロジェクトに対して指定した制限を返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Read Only ロールが必要です。
このプロジェクトの制限を識別する、人間に判読可能なラベル。
| 制限名 | 説明 | default | 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 | 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 | 該当なし | 該当なし |
| dataFederation.bytesProcessed.daily | 現在日にすべての Data Federation テナントで処理されるバイト数の制限 | 該当なし | 該当なし |
| dataFederation.bytesProcessed.weekly | 現在週にすべての Data Federation テナントで処理されるバイト数の制限 | 該当なし | 該当なし |
| dataFederation.bytesProcessed.monthly | 当月のすべての 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
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。
デフォルト値はfalseです。
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値はfalseです。
OK
無効なリクエストです。
許可されていません。
Forbidden.
見つかりません。
競合。
内部サーバーエラー。
atlas api projects getGroupLimit --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/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.GetGroupLimitApiParams{}
sdkResp, httpResp, err := client.ProjectsApi.
GetGroupLimitWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true"
{
"currentUsage": 42,
"defaultLimit": 42,
"maximumLimit": 42,
"name": "atlas.project.deployment.clusters",
"value": 42
}
{
"currentUsage": 42,
"defaultLimit": 42,
"maximumLimit": 42,
"name": "atlas.project.deployment.nodesPerPrivateLinkRegion",
"value": 42
}
{
"currentUsage": 42,
"defaultLimit": 42,
"maximumLimit": 42,
"name": "atlas.project.deployment.serverlessMTMs",
"value": 42
}
{
"currentUsage": 42,
"defaultLimit": 42,
"maximumLimit": 42,
"name": "atlas.project.security.databaseAccess.customRoles",
"value": 42
}
{
"currentUsage": 42,
"defaultLimit": 42,
"maximumLimit": 42,
"name": "atlas.project.security.databaseAccess.users",
"value": 42
}
{
"currentUsage": 42,
"defaultLimit": 42,
"maximumLimit": 42,
"name": "atlas.project.security.networkAccess.crossRegionEntries",
"value": 42
}
{
"currentUsage": 42,
"defaultLimit": 42,
"maximumLimit": 42,
"name": "atlas.project.security.networkAccess.entries",
"value": 42
}
{
"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"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"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"
}
{
"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"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}