ID を使用して 1 つの MongoDB プロセスを返す

GET /api/atlas/v2/groups/{groupId}/processes/{processId}

指定されたプロジェクトの指定されたホストのプロセスを返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

path パラメータ

  • グループ ID string 必須

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

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

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

  • processId string 必須

    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})$

クエリ パラメータ

  • envelope ブール値

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

    デフォルト値はfalseです。

  • pretty ブール値

    レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

    デフォルト値はfalseです。

    Prettyprint

応答

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • 作成済み string(date-time)

      MongoDB Cloud がこのMongoDBプロセスを作成した日時。 このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

    • グループ ID string

      プロジェクトを識別する一意の 24桁の 16 進数文字列。stringプロジェクトには、返却対象のMongoDBプロセスが含まれています。 MongoDBプロセスは mongod または mongos のいずれかになります。

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

    • Hostname string

      MongoDBプロセス(mongod または mongos )を実行するホストのホスト名、完全修飾ドメイン名(FQDN)、またはインターネット プロトコル アドレス(IPv 4 または IPv 6 )。

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

    • id string

      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})$

    • lastPing string(date-time)

      MongoDB Cloud がこのMongoDBプロセスに対する最後のpingを受信した日時。 このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

    • ポート integer(int32)

      MongoDBプロセスがリクエストをリッスンする IANA(Internet Assigned Numbers Authority、インターネット番号割当機関)ポート。

    • ReplicaSetName string

      このプロセスを含むレプリカセットを識別する、人間が判読できるラベル。 このプロセスがレプリカセットに属している場合、このリソースはこのパラメータを返します。

    • shardName string

      このプロセスを含むシャードを識別する、人間が判読できるラベル。 このリソースは、このプロセスが シャーディングされたシャーディングされたクラスターに属している場合にのみこの値を返します。

    • typeName string

      MongoDB Cloud が追跡するMongoDBプロセスのタイプ。 MongoDB Cloud は、プロセスの配置を完了MongoDBまで、新しいプロセスを no_DATA として返します。

      値は、REPLICA_PRIMARYREPLICA_SECONDARYRECOVERINGSHARD_MONGOSSHARD_CONFIGSHARD_STANDALONESHARD_PRIMARYSHARD_SECONDARY、または NO_DATA です。

    • userAgent string

      クラスターノードを識別する、人間が判読できるラベル。 MongoDB Cloud は、通常、このホスト名を クラスターノードの標準ホスト名に設定します。 stringホスト名 パラメーターの値の代わりに、クラスターの接続文字列に表示されます。

    • バージョン string

      このプロセスが実行するMongoDBのバージョン。

      形式は次のパターンと一致する必要があります: ([\d]+\.[\d]+\.[\d]+)

  • 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

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

  • 500 application/ JSON

    内部サーバーエラー。

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

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

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

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

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

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

        • フィールド string 必須

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

    • 詳細 string

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

    • エラー integer(int32) 必須

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

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

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

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

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

    • 理由 string

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

GET /API/Atlas/v2/groups/{groupId}/processes/{processId}
atlas api monitoringAndLogs getGroupProcess --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.GetGroupProcessApiParams{}
	sdkResp, httpResp, err := client.MonitoringandLogsApi.
		GetGroupProcessWithParams(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}?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}?pretty=true"
応答の例(200)
{
  "created": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostname": "string",
  "id": "string",
  "lastPing": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "port": 42,
  "replicaSetName": "string",
  "shardName": "string",
  "typeName": "REPLICA_PRIMARY",
  "userAlias": "string",
  "version": "string"
}
応答の例(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"
}
応答の例(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"
}