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

GET /api/atlas/v2/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/vnd.atlas.2023-01-01+json

    OK

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

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

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

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

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

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

      hardsMetrics 属性を非表示 hardsMetrics 属性の表示 オブジェクト
      • metricName string 必須

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

        値は INDEX_SIZE_ON_DISKNUMBER_OF_DELETESNUMBER_OF_ERROR_QUERIESNUMBER_OF_GETMORE_COMMANDSNUMBER_OF_INDEX_FIELDSNUMBER_OF_INSERTSNUMBER_OF_SUCCESS_QUERIESNUMBER_OF_UPDATESREPLICATION_LAGTOTAL_NUMBER_OF_QUERIESFTS_DISK_USAGEFTS_PROCESS_CPU_KERNELFTS_PROCESS_CPU_USERFTS_PROCESS_NORMALIZED_CPU_KERNELFTS_PROCESS_NORMALIZED_CPU_USERFTS_PROCESS_RESIDENT_MEMORYFTS_PROCESS_SHARED_MEMORYFTS_PROCESS_VIRTUAL_MEMORYJVM_CURRENT_MEMORYJVM_MAX_MEMORY、または PAGE_FAULTS

      • 単位 string 必須

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

        値は BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURKILOBYTESMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSMILLISECONDS_LOGSCALEPERCENTSCALARSCALAR_PER_SECOND、または SECONDS

    • indexMetrics array[オブジェクト]

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

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

      indexMetrics 属性を非表示 indexMetrics 属性の表示 オブジェクト
      • metricName string 必須

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

        値は INDEX_SIZE_ON_DISKNUMBER_OF_DELETESNUMBER_OF_ERROR_QUERIESNUMBER_OF_GETMORE_COMMANDSNUMBER_OF_INDEX_FIELDSNUMBER_OF_INSERTSNUMBER_OF_SUCCESS_QUERIESNUMBER_OF_UPDATESREPLICATION_LAGTOTAL_NUMBER_OF_QUERIESFTS_DISK_USAGEFTS_PROCESS_CPU_KERNELFTS_PROCESS_CPU_USERFTS_PROCESS_NORMALIZED_CPU_KERNELFTS_PROCESS_NORMALIZED_CPU_USERFTS_PROCESS_RESIDENT_MEMORYFTS_PROCESS_SHARED_MEMORYFTS_PROCESS_VIRTUAL_MEMORYJVM_CURRENT_MEMORYJVM_MAX_MEMORY、または PAGE_FAULTS

      • 単位 string 必須

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

        値は BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURKILOBYTESMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSMILLISECONDS_LOGSCALEPERCENTSCALARSCALAR_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 ステータス メトリクスを含むリスト。

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

      statusMetrics 属性を非表示にする statusMetrics 属性の表示 オブジェクト
      • metricName string 必須

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

        値は INDEX_SIZE_ON_DISKNUMBER_OF_DELETESNUMBER_OF_ERROR_QUERIESNUMBER_OF_GETMORE_COMMANDSNUMBER_OF_INDEX_FIELDSNUMBER_OF_INSERTSNUMBER_OF_SUCCESS_QUERIESNUMBER_OF_UPDATESREPLICATION_LAGTOTAL_NUMBER_OF_QUERIESFTS_DISK_USAGEFTS_PROCESS_CPU_KERNELFTS_PROCESS_CPU_USERFTS_PROCESS_NORMALIZED_CPU_KERNELFTS_PROCESS_NORMALIZED_CPU_USERFTS_PROCESS_RESIDENT_MEMORYFTS_PROCESS_SHARED_MEMORYFTS_PROCESS_VIRTUAL_MEMORYJVM_CURRENT_MEMORYJVM_MAX_MEMORY、または PAGE_FAULTS

      • 単位 string 必須

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

        値は BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURKILOBYTESMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSMILLISECONDS_LOGSCALEPERCENTSCALARSCALAR_PER_SECOND、または SECONDS

  • 400 application/ JSON

    無効なリクエストです。

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

  • 401 application/ JSON

    許可されていません。

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

  • 403 application/ JSON

    Forbidden.

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

  • 404 application/ JSON

    見つかりません。

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

  • 429 application/ JSON

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

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

  • 500 application/ JSON

    内部サーバーエラー。

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

GET /API/Atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics
atlas api monitoringAndLogs listGroupHostFtsMetrics --help
import (
	"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.ListGroupHostFtsMetricsApiParams{}
	sdkResp, httpResp, err := client.MonitoringandLogsApi.
		ListGroupHostFtsMetricsWithParams(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}/hosts/{processId}/fts/metrics?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}/hosts/{processId}/fts/metrics?pretty=true"
応答の例(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)
{
  "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"
}
応答の例(401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
応答の例(403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
応答の例(404)
{
  "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"
}
応答の例(429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
応答の例(500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}