1 つのプロセスのすべての Atlas Search メトリクス タイプを返す

GET /api/atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics

指定されたプロジェクト内の 1 つのプロセスで使用可能なすべての Atlas Search メトリクス タイプを返します。Atlas Search メトリクス タイプを参照するには、プロジェクト読み取り専用以上のロールが必要です。

ロールの要件
  • プロジェクト読み取り専用

path パラメータ

  • processId string 必須

    MongoDB プロセスを提供するホスト名と IANA ポートの組み合わせ。ホストは 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})$。

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

    注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリ パラメータ

  • envelope ブール値

    アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

    デフォルト値はfalseです。

応答

  • 200 application/ JSON

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • グループ ID string 必須

      プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

      形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

    • ハードウェアメトリクス array[オブジェクト] 必須

      MongoDB Atlas がこのリクエストを受信したときに Atlas Search 専用のすべてのホスト コンピューティング、メモリ、ストレージ使用率を含むリスト。

      hardsMetrics 属性を非表示 hardsMetrics 属性の表示 オブジェクト

      MongoDB Atlas がこのリクエストを受信したときの 1 つの Atlas Search ステータスの測定値。

      • metricName string | null 必須

        この Atlas Searchハードウェア、ステータス、またはインデックス測定値を識別する、人間が判読可能なラベル。

        値は INDEX_SIZE_ON_DISK、NUMBER_OF_DELETES、NUMBER_OF_ERROR_QUERIES、NUMBER_OF_GETMORE_COMMANDS、NUMBER_OF_INDEX_FIELDS、NUMBER_OF_INSERTS、NUMBER_OF_SUCCESS_QUERIES、NUMBER_OF_UPDATES、REPLICATION_LAG、TOTAL_NUMBER_OF_QUERIES、FTS_DISK_USAGE、FTS_PROCESS_CPU_KERNEL、 FTS_PROCESS_CPU_USER、FTS_PROCESS_NORMALIZED_CPU_KERNEL、FTS_PROCESS_NORMALIZED_CPU_USER、FTS_PROCESS_RESIDENT_MEMORY、FTS_PROCESS_SHARED_MEMORY、FTS_PROCESS_VIRTUAL_MEMORY、JVM_CURRENT_MEMORY、JVM_MAX_MEMORY、または PAGE_FAULTS 。

      • 単位 string | null 必須

        この Atlas Search メトリクスに適用される測定単位。

        値は BYTES、BYTES_PER_SECOND、GIGABYTES、GIGABYTES_PER_HOUR、KILOBYTES、MEGABYTES、MEGABYTES_PER_SECOND、MILLISECONDS、MILLISECONDS_LOGSCALE、PERCENT、SCALAR、SCALAR_PER_SECOND、または SECONDS

    • indexMetrics array[オブジェクト] 必須

      MongoDB Atlas がこのリクエストを受信した時点までに Atlas Searchインデックスが実行したすべてのパフォーマンスおよび使用率の測定値を含むリスト。

      indexMetrics 属性を非表示 indexMetrics 属性の表示 オブジェクト

      MongoDB Atlas がこのリクエストを受信したときの 1 つの Atlas Search ステータスの測定値。

      • metricName string | null 必須

        この Atlas Searchハードウェア、ステータス、またはインデックス測定値を識別する、人間が判読可能なラベル。

        値は INDEX_SIZE_ON_DISK、NUMBER_OF_DELETES、NUMBER_OF_ERROR_QUERIES、NUMBER_OF_GETMORE_COMMANDS、NUMBER_OF_INDEX_FIELDS、NUMBER_OF_INSERTS、NUMBER_OF_SUCCESS_QUERIES、NUMBER_OF_UPDATES、REPLICATION_LAG、TOTAL_NUMBER_OF_QUERIES、FTS_DISK_USAGE、FTS_PROCESS_CPU_KERNEL、 FTS_PROCESS_CPU_USER、FTS_PROCESS_NORMALIZED_CPU_KERNEL、FTS_PROCESS_NORMALIZED_CPU_USER、FTS_PROCESS_RESIDENT_MEMORY、FTS_PROCESS_SHARED_MEMORY、FTS_PROCESS_VIRTUAL_MEMORY、JVM_CURRENT_MEMORY、JVM_MAX_MEMORY、または PAGE_FAULTS 。

      • 単位 string | null 必須

        この Atlas Search メトリクスに適用される測定単位。

        値は BYTES、BYTES_PER_SECOND、GIGABYTES、GIGABYTES_PER_HOUR、KILOBYTES、MEGABYTES、MEGABYTES_PER_SECOND、MILLISECONDS、MILLISECONDS_LOGSCALE、PERCENT、SCALAR、SCALAR_PER_SECOND、または SECONDS

    • processId string 必須

      プロセスを識別するホスト名とポート。

      形式は次のパターンと一致する必要があります: ^([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})$。

    • statusMetrics array[オブジェクト] 必須

      MongoDB Atlas がこのリクエストを受信したときに、利用可能なすべての Atlas Search ステータス メトリクスを含むリスト。

      statusMetrics 属性を非表示にする statusMetrics 属性の表示 オブジェクト

      MongoDB Atlas がこのリクエストを受信したときの 1 つの Atlas Search ステータスの測定値。

      • metricName string | null 必須

        この Atlas Searchハードウェア、ステータス、またはインデックス測定値を識別する、人間が判読可能なラベル。

        値は INDEX_SIZE_ON_DISK、NUMBER_OF_DELETES、NUMBER_OF_ERROR_QUERIES、NUMBER_OF_GETMORE_COMMANDS、NUMBER_OF_INDEX_FIELDS、NUMBER_OF_INSERTS、NUMBER_OF_SUCCESS_QUERIES、NUMBER_OF_UPDATES、REPLICATION_LAG、TOTAL_NUMBER_OF_QUERIES、FTS_DISK_USAGE、FTS_PROCESS_CPU_KERNEL、 FTS_PROCESS_CPU_USER、FTS_PROCESS_NORMALIZED_CPU_KERNEL、FTS_PROCESS_NORMALIZED_CPU_USER、FTS_PROCESS_RESIDENT_MEMORY、FTS_PROCESS_SHARED_MEMORY、FTS_PROCESS_VIRTUAL_MEMORY、JVM_CURRENT_MEMORY、JVM_MAX_MEMORY、または PAGE_FAULTS 。

      • 単位 string | null 必須

        この Atlas Search メトリクスに適用される測定単位。

        値は BYTES、BYTES_PER_SECOND、GIGABYTES、GIGABYTES_PER_HOUR、KILOBYTES、MEGABYTES、MEGABYTES_PER_SECOND、MILLISECONDS、MILLISECONDS_LOGSCALE、PERCENT、SCALAR、SCALAR_PER_SECOND、または SECONDS

  • 400 application/ JSON

    無効なリクエストです。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。

  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。

  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。

  • 404 application/ JSON

    見つかりません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。

  • 429 application/ JSON

    リクエストが多すぎます。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。

  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string | null

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string | null

      このエラーで返されたアプリケーション エラー メッセージ。

GET /API/Atlas/v1.0/groups/{groupId}/hosts/{processId}/fts/metrics
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/hosts/my.host.name.com:27017/fts/metrics' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
応答の例(200)
{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hardwareMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ],
  "indexMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "processId": "mongodb.example.com:27017",
  "statusMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ]
}
応答の例(400)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}
応答の例(401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
応答の例(403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
応答の例(404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
応答の例(429)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 429,
  "errorCode": "RATE_LIMITED",
  "reason": "Too Many Requests"
}
応答の例(500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}