쿼리 통계 요약 반환
지정된 클러스터 에 대한 쿼리 형태 통계 요약 목록을 반환합니다. 쿼리 형태 통계는 MongoDB 쿼리에 대한 성능 인사이트를 제공하여 사용자가 문제가 있는 쿼리 패턴과 잠재적 최적화를 식별하는 데 도움이 됩니다.
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
형식은
^[a-zA-Z0-9][a-zA-Z0-9-]*$패턴 과 일치해야 합니다.
쿼리 매개변수
-
쿼리 형태 통계를 조회 할 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(밀리초)으로 값을 표현합니다.
- until 매개변수를 지정하지 않으면 엔드포인트는 since 값과 현재 시간을 포함하는 데이터를 반환합니다.
- since 또는 until 매개 변수를 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.
최소값은
1199145600000입니다. -
쿼리 형태 통계를 조회할 수 있는 마지막 날짜와 시간입니다. 이 매개 변수는 해당 값을 유닉스 시간 이후 경과된 밀리초 단위로 표현합니다.
- until 매개변수를 지정하는 경우 since 매개변수를 지정해야 합니다.
- since 또는 until 매개 변수를 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.
최소값은
1199145600000입니다. -
쿼리 형태 통계를 조회 할 ProcessIds입니다. processId는 MongoDB 프로세스 제공하는 호스팅하다 와 포트의 조합입니다. 호스팅하다 MongoDB 프로세스 (
mongod또는mongos)를 실행하는 호스팅하다 의 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소 여야 합니다. 포트는 MongoDB 프로세스 요청을 수신하는 IANA 포트여야 합니다. 여러 processId를 포함하려면 각 processId 사이에 앰퍼샌드(&)로 구분하여 매개변수를 여러 번 전달합니다.요소가
10개 이하입니다. 각 형식은 다음 패턴 과 일치해야 합니다:^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$. -
쿼리 형태 통계를 조회 할 네임스페이스입니다. 네임스페이스 데이터베이스 한 개와
.:<database>.<collection>(으)로 작성된 컬렉션 리소스 한 개로 구성됩니다. 여러 네임스페이스를 포함하려면 각 네임스페이스 사이에 앰퍼샌드(&)로 구분하여 매개변수를 여러 번 전달합니다. 모든 네임스페이스에 대한 결과를 반환하려면 이 매개변수를 생략합니다.요소가
10개 이하입니다. -
지정된 MongoDB 명령과 일치하는 쿼리 형태 통계를 조회합니다. 여러 명령을 포함하려면 각 명령 사이에 앰퍼샌드(
&)로 구분하여 매개변수를 여러 번 전달합니다. 현재 지원되는 매개변수는 찾기, 고유, 애그리게이션입니다. 지원되는 모든 명령에 대한 결과를 반환하려면 이 매개변수를 생략합니다.요소가
3개 이하입니다. 값은find,distinct또는aggregate입니다. -
반환할 쿼리 통계 요약의 최대 개수입니다.
최소값은
1, 최대값은100입니다. 기본값은100입니다. -
조회 형태 통계 데이터 시리즈를 쿼리합니다. 시리즈는 쿼리 실행에 대한 특정 지표를 나타냅니다. 여러 시리즈를 포함하려면 각 시리즈 사이에 앰퍼샌드(
&)로 구분하여 매개변수를 여러 번 전달합니다. 사용 가능한 모든 시리즈에 대한 결과를 반환하려면 이 매개변수를 생략합니다.요소가
14개 이하입니다. 값은TOTAL_EXECUTION_TIME,AVG_EXECUTION_TIME,EXECUTION_COUNT,KEYS_EXAMINED,DOCS_EXAMINED,DOCS_RETURNED,TOTAL_TIME_TO_RESPONSE,BYTES_READ,KEYS_EXAMINED_RETURNED,DOCS_EXAMINED_RETURNED,LAST_EXECUTION_TIME,P50_EXECUTION_TIME,P90_EXECUTION_TIME또는P99_EXECUTION_TIME. -
원하는 쿼리 형태의 SHA256 해시 목록, $queryStats 및 $explain 또는 느린 쿼리 로그와 같은 MongoDB 명령의 출력입니다. 여러 시리즈를 포함하려면 각 시리즈 사이에 앰퍼샌드(
&)로 구분하여 매개변수를 여러 번 전달합니다. 사용 가능한 모든 시리즈에 대한 결과를 반환하려면 이 매개변수를 생략합니다.요소가
10개 이하입니다. 각 형식은 다음 패턴 과 일치해야 합니다:^([a-fA-F0-9]{64})$. -
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint
atlas api queryShapeInsights listGroupClusterQueryShapeInsightSummaries --helpimport (
"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.ListGroupClusterQueryShapeInsightSummariesApiParams{}
sdkResp, httpResp, err := client.QueryShapeInsightsApi.
ListGroupClusterQueryShapeInsightSummariesWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries?pretty=true"{
"summaries": [
{
"avgWorkingMillis": 42.0,
"bytesRead": 42.0,
"command": "find",
"docsExamined": 42.0,
"docsExaminedRatio": 42.0,
"docsReturned": 42.0,
"execCount": 42.0,
"keysExamined": 42.0,
"keysExaminedRatio": 42.0,
"lastExecMicros": 42.0,
"namespace": "string",
"p50ExecMicros": 42.0,
"p90ExecMicros": 42.0,
"p99ExecMicros": 42.0,
"queryShape": "string",
"queryShapeHash": "string",
"totalTimeToResponseMicros": 42.0,
"totalWorkingMillis": 42.0
}
]
}{
"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"
}