プロジェクトの IP アクセス リストへのエントリを追加
指定されたプロジェクトに 1 つ以上のアクセス リスト エントリを追加します。MongoDB Cloud は、プロジェクトの IP アクセス リストのエントリからのみクラスタへのクライアント接続を許可します。各エントリは 1 つの IP アドレス、または CIDR で記述された IP アドレスの 1 件のブロックとして書き込みます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナーまたはプロジェクト チャート管理者ロールが必要です。このリソースはホワイトリスト リソースを置き換えます。MongoDB クラウドは 2021 年 7 月にホワイトリストを削除しました。この新しいリソースを使用するには、アプリケーションを更新してください。/groups/{GROUP-ID}/accessList エンドポイントはデータベース IP アクセス リストを管理します。このエンドポイントは、MongoDB Cloud 組織のアクセス リストを管理する orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist エンドポイントとは異なります。このエンドポイントは同時 POST リクエストをサポートしていません。複数の POST リクエストを同期させて送信する必要があります。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。
デフォルト値は
trueです。 -
レスポンスが返す 1 ページあたりのアイテムの数。
最小値は
1、最大値は500です。デフォルト値は100です。 -
レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。
の最小値は
1です。デフォルト値は1です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
指定されたプロジェクトに追加する 1 つ以上のアクセス リスト エントリ。
-
プロジェクトの IP アクセス リストに追加する Amazon Web Services (AWS) セキュリティグループのユニークな文字列。IP アクセス リスト エントリは、1 つの awsSecurityGroup、1 つの cidrBlock、または 1 つの ipAddress のいずれかになります。AWS セキュリティグループを IP アクセスリストに追加する前に、プロジェクトの仮想プライベート接続 (VPC) ピアリングを設定する必要があります。AWS セキュリティグループを一時的なアクセスリスト エントリとして設定することはできません。cidrBlock または ipAddress を設定する場合は、このパラメータを設定しないでください。
形式は次のパターンと一致する必要があります:
^([0-9]*/)?sg-([0-9]*)。 -
プロジェクトの IP アクセス リストに追加する、クラスレス ドメイン間ルーティング (CIDR) 表記の IP アドレスの範囲。IP アクセス リスト エントリは、1 つの awsSecurityGroup、1 つの cidrBlock、または 1 つの ipAddress のいずれかになります。awsSecurityGroup または ipAddress を設定する場合は、このパラメータを設定しないでください。
形式は次のパターンと一致する必要があります:
^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\:){1,6}\:(%2[fF][0-9]{1,3})?$。 -
この IP アクセス リスト エントリの目的または範囲を説明するコメント。
最大長は
80です。 -
MongoDB Cloud が一時アクセスリスト エントリを削除する日時。このパラメーターは、その値を ISO 8601 タイムスタンプ形式で UTC で表し、タイム ゾーンの指定を含めることができます。日付は現在の日付より後で、このリクエストの送信から 1 週間以内である必要があります。この IP アクセス リスト エントリの作成時に有効期限を指定した場合、リソースはこのパラメータを返します。
-
プロジェクトの IP アクセス リストに追加する IP アドレス。IP アクセス リスト エントリは、1 つの awsSecurityGroup、1 つの cidrBlock、または 1 つの ipAddress のいずれかになります。awsSecurityGroup または cidrBlock を設定する場合は、このパラメータを設定しないでください。
形式は次のパターンと一致する必要があります:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$。
atlas api projectIpAccessList createGroupAccessListEntry --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/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.CreateGroupAccessListEntryApiParams{}
sdkResp, httpResp, err := client.ProjectIPAccessListApi.
CreateGroupAccessListEntryWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \
-d '{ <Payload> }'[
{
"awsSecurityGroup": "string",
"cidrBlock": "string",
"comment": "string",
"deleteAfterDate": "2025-05-04T09:42:00Z",
"ipAddress": "string"
}
]{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"awsSecurityGroup": "string",
"cidrBlock": "string",
"comment": "string",
"deleteAfterDate": "2025-05-04T09:42:00Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"ipAddress": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 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": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}