ディスクパーティションの測定値を取得する

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

ディスク測定は、オートメーションが収集する MongoDB を実行しているホストのディスクパーティション上の IOPS、ディスク使用量、およびディスクレイテンシに関するデータを提供します。ディスク測定値を取得するには、 MongoDB Ops Manager Automation を実行する必要があります。

注意

何らかのメトリック系列を計算するために、 MongoDB Ops Managerは連続する 2 つのポイントごとのレートを取得します。これらのメトリック系列では、 MongoDB Ops Managerはクエリの時間範囲を指定して最初のデータ点のレートを計算できないため、最初のデータ点は NULL 値になります。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/disks/{PARTITION-NAME}/measurements

リクエストパスパラメーター

名前	タイプ	説明
プロジェクトID	string	ホストを所有するプロジェクトの一意の識別子。
ホスト ID	string	MongoDB プロセスを提供するホストの一意の識別子です。
パーティション名	string	MongoDB プロセスが保存されているディスクパーティションの名前。

リクエストクエリパラメータ

一意のクエリパラメーター

このエンドポイントは、返された測定値をフィルタリングするために次のクエリパラメーターを受け入れます。

名前

タイプ

説明

granularity

Required

string

ISO8601 での期間測定データポイント間の間隔を指定する表記。

測定の粒度は、次の表記を使用して、日数、時間、分、秒、ミリ秒として表できます。

P （期間）、その後は次の結果が続きます。

D 日間（必要な場合）
T 期間（日後）
H 時間時間
M のために
S 秒

以下に例を挙げます。

表記	duration
`PT30S`	30 秒
`P1T12H`	1日、12時間
`PT0.5S`	500 ミリ秒

period

string

ISO8601 の期間過去の測定値を検索する方法を指定する表記。

たとえば、過去の36時間をリクエストするには、次のクエリパラメータを含めます: period=P1DT12H 。

始める

string

ISO8601 のタイムスタンプ測定値を取得する期間の開始の日付と時刻形式（ UTC）。startを指定する場合は、 endも指定する必要があります。

end

string

ISO8601 のタイムスタンプ測定値を取得する期間の終了の日付と時刻（ UTC）形式。endを指定する場合は、 startも指定する必要があります。

string

返す測定値。 mが指定されていない場合は、すべての測定値が返されます。

mに複数の値を指定するには、 mパラメータを繰り返す必要があります。

以下に例を挙げます。

../measurements?m=CONNECTIONS&m=OPCOUNTER_CMD&m=OPCOUNTER_QUERY

ホストに対して有効な測定値を指定する必要があります。 MongoDB Ops Manager は、指定された測定値が無効な場合、エラーを返します。利用可能な測定値については、「測定タイプ」を参照してください。

注意

各測定リクエストには、 periodクエリパラメータまたはstartクエリパラメータとendクエリパラメータの両方を含める必要があります。

一般的なクエリパラメーター

このエンドポイントは、単一の応答を返すすべてのエンドポイントに共通のクエリパラメーターも受け入れます。

名前

タイプ

説明

default

pageNum

integer

ページ番号（1 インデックスベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

レスポンス本体が pretty-print 内であるかどうかを示します形式。

false

envelope

ブール値

応答をエンベロープでラップするかどうかを示します。

一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで"envelope" : trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

状態	HTTPレスポンスコード
envelope	期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

なし

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

名前	タイプ	説明
databaseName	string	測定が適用されるデータベース。データベース測定を取得するためにのみ入力されます。
end	string	ISO8601 のタイムスタンプ返された測定値がカバーする期間の終了の日付と時刻（ UTC）形式。
粒度	string	ISO8601 の期間各データポイントがカバーする間隔のサイズを指定する表記。たとえば、 `PT5M`は5分の粒度を指定します。
グループ ID	string	ホストを所有するプロジェクトの一意の識別子。
hostId	string	測定値が含まれるホストの一意の識別子。
測定値	オブジェクト配列	この配列内の各オブジェクトは、測定値とその測定値のデータポイントを表します。
operations.dataPoints	オブジェクト配列	各オブジェクトは 1 つのデータポイントを表します。特定の時点で利用可能なデータポイントがない場合、この`value`は`null`に設定されます。
operations.dataPoints.timestamp	string	ISO8601 のタイムスタンプこのデータポイントが表す時間間隔の開始の UTC 形式の日付と時刻形式。
operations.dataPoints.value	float	このデータポイントの値。
operations.name	string	測定値の名前。許容値は [測定タイプ]ページに記載されています。
operations.units	string	この測定値がどのように定量化されるか。指定できる単位は以下のとおりです。 `PERCENT` `MILLISECONDS` `BYTES` `GIGABYTES` `BYTES_PER_SECOND` `MEGABYTES_PER_SECOND` `GIGABYTES_PER_HOUR` `SCALAR_PER_SECOND` `SCALAR`
partitionName	string	MongoDB プロセスデータベースを保存するディスクパーティションの名前。ディスクパーティション測定の取得にのみ入力されます。
processId	string	MongoDB プロセスのFQDNとポート。
始める	string	ISO8601 のタイムスタンプ返された測定値がカバーする期間の開始の日付と時刻（ UTC）形式。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/disks/{PARTITION-NAME}/measurements?granularity={TIME-INCREMENT}&period={PERIOD}"

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
  "granularity": "{TIME-INCREMENT}",
  "groupId": "{PROJECT-ID}",
  "hostId": "{HOST-ID}",
  "links": [
  ],
  "measurements": [
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_IOPS_READ",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_IOPS_WRITE",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_IOPS_TOTAL",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_LATENCY_READ",
      "units": "MILLISECONDS"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_LATENCY_WRITE",
      "units": "MILLISECONDS"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_SPACE_FREE",
      "units": "BYTES"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_SPACE_USED",
      "units": "BYTES"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_SPACE_PERCENT_FREE",
      "units": "PERCENT"
    },
    {
      "dataPoints": [],
      "name": "DISK_PARTITION_SPACE_PERCENT_USED",
      "units": "PERCENT"
    }
  ],
  "partitionName": "{PARTITION-NAME}",
  "processId": "{MONGODB-PROCESS-FQDN}:{PORT}"
}

戻る

ホスト、プロセス、システムの測定値を取得する

データベース測定値の取得

注意

Resource

リクエスト パス パラメーター

リクエスト クエリ パラメータ

一意のクエリ パラメーター

注意

一般的なクエリ パラメーター

リクエスト ボディ パラメータ

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

リクエストパスパラメーター

リクエストクエリパラメータ

一意のクエリパラメーター

一般的なクエリパラメーター

リクエストボディパラメータ