クラスター名を使用して、1 つのクラスターのデータベース アクセス履歴を返す
クラスター名で識別される 1 つのクラスターのアクセス ログを返します。アクセス ログには、クラスターに対して行われた認証リクエストの一覧が含まれます。この機能は、テナント階層クラスター（M0、M2、M5）では使用できません。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト モニタリング管理者" ロールまたは "プロジェクト データベース アクセス管理者" ロールが付与されている必要があります。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
クラスターを識別する人間が判読できるラベル。
形式は次のパターンと一致する必要があります:
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint -
レスポンスが成功した認証試行のみを返すかどうかを示すフラグ。
-
データベース履歴の取得を停止する日時。end を指定する場合は、start も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。
-
データベースへの認証を試みた 1 つのインターネット プロトコル アドレス。
形式は次のパターンと一致する必要があります:
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$。 -
ログから返される最大行数。
最小値は
0、最大値は20000です。デフォルト値は20000です。 -
MongoDB Cloud がデータベース履歴の取得を開始する日時。start を指定する場合は、end も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。
atlas api accessTracking getAccessHistoryCluster --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/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.GetGroupDbAccessHistoryClusterApiParams{}
sdkResp, httpResp, err := client.AccessTrackingApi.
GetGroupDbAccessHistoryClusterWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"{
"accessLogs": [
{
"authResult": true,
"authSource": "string",
"failureReason": "string",
"groupId": "string",
"hostname": "string",
"ipAddress": "string",
"logLine": "string",
"timestamp": "string",
"username": "string"
}
]
}{
"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": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}