1 つの MongoDB プロセスの 1 つのディスクに関する測定値を返す
指定されたプロジェクトの指定されたホストの、1 つのディスクまたはパーティションの測定値を返します。戻り値は、次のいずれかになります。
- MongoDB プロセスに使用されるディスク パーティションの I/O 操作のスループット
- パーティションがリクエストを発行して処理した時間の割合
- MongoDB プロセスに使用されるディスク パーティションの操作タイプごとのレイテンシ
- MongoDBプロセスに使用されたディスク パーティション上の空きディスク領域と使用済みディスク領域の量
このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトの読み取り専用ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
測定が適用されるディスクまたはパーティションの、人間が判読可能なラベル。
-
MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（
mongodまたはmongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。形式は次のパターンと一致する必要があります:
^([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})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint -
この MongoDB プロセスに要求する 1 つ以上の測定タイプ。省略すると、リソースはすべての測定値を返します。
mに複数の値を指定するには、値ごとにmパラメーターを繰り返します。指定されたホストに適用する測定値を指定します。無効な測定値を指定した場合、MongoDB Cloud はエラーを返します。少なくとも
1を、10以下の要素を含めます。値はDISK_PARTITION_IOPS_READ、MAX_DISK_PARTITION_IOPS_READ、DISK_PARTITION_IOPS_WRITE、MAX_DISK_PARTITION_IOPS_WRITE、DISK_PARTITION_IOPS_TOTAL、MAX_DISK_PARTITION_IOPS_TOTAL、DISK_PARTITION_LATENCY_READ、MAX_DISK_PARTITION_LATENCY_READ、DISK_PARTITION_LATENCY_WRITE、MAX_DISK_PARTITION_LATENCY_WRITE、DISK_PARTITION_SPACE_FREE、MAX_DISK_PARTITION_SPACE_FREE、DISK_PARTITION_SPACE_USED、MAX_DISK_PARTITION_SPACE_USED、DISK_PARTITION_SPACE_PERCENT_FREE、MAX_DISK_PARTITION_SPACE_PERCENT_FREE、DISK_PARTITION_SPACE_PERCENT_USED、MAX_DISK_PARTITION_SPACE_PERCENT_USED、DISK_PARTITION_THROUGHPUT_READ、DISK_PARTITION_THROUGHPUT_WRITE、またはDISK_QUEUE_DEPTH。 -
Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。
-
Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。
-
MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。
-
MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。
atlas api monitoringAndLogs getGroupProcessDiskMeasurements --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.GetGroupProcessDiskMeasurementsApiParams{}
sdkResp, httpResp, err := client.MonitoringandLogsApi.
GetGroupProcessDiskMeasurementsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true"{
"databaseName": "string",
"end": "2025-05-04T09:42:00Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostId": "mongodb.example.com:27017",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [
{
"dataPoints": [
{
"timestamp": "2025-05-04T09:42:00Z",
"value": 42.0
}
],
"name": "string",
"units": "BYTES"
}
],
"partitionName": "string",
"processId": "mongodb.example.com:27017",
"start": "2025-05-04T09:42:00Z"
}{
"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"
}