メトリクス名を返す

項目一覧

Resource

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

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

リクエスト時に指定されたプロジェクトに対して、使用可能なすべてのクエリレイテンシメトリクス名とそれぞれのユニットを返します。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/collStats/metrics

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

Parameter	タイプ	説明
プロジェクトID	string	（必須。）プロジェクトを識別する一意の 24 桁の 16 進数のstring 。

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

すべてのパラメーターは任意です。

名前	タイプ	説明	default
pretty	ブール値	レスポンス本体を pretty-print にするかどうかを示します形式。	`false`
envelope	ブール値	応答をエンベロープでラップするかどうかを示します。	`false`

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

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

応答

名前	タイプ	説明
グループ ID	string	プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
メトリクス	配列	リクエスト時に指定されたプロジェクトに対して、使用可能なすべてのクエリレイテンシメトリクス名とそれぞれのユニットが格納されたリスト。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{CLOUD-MANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/collStats/metrics?pretty=true'

応答例

応答ヘッダー

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}

レスポンス本体

{
  "groupId": "{PROJECT-ID}",
  "metrics": [
    {
      "metricName": "READS_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "READS_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_READS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "WRITES_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_WRITES_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "COMMANDS_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_COMMANDS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "TOTAL_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_TOTAL_OPS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P99_VALUE",
      "units": "MICROSECONDS"
    }
  ]
}

戻る

クエリのレイテンシ

名前空間を固定する