プロジェクトで Atlas クラスターを取得する

GET /api/v1/atlas/projects/{{project_id}/clusters/{{cluster_name}
Bearer 認証

人間の呼び出し元の ノードまたは ペアの エージェント エンジン サービス アカウントを使用して、最初に Atlas Flex クラスターを検索し、次に専有クラスター を検索します。詳細応答には、Atlas がアイドル状態の Flex クラスターのリスト応答から省略する接続文字列が含まれます。エージェント エンジンAPIキーは受け入れられません。無効な project_id または cluster_name は、Atlas を呼び出す前に拒否されます。

path パラメータ

  • project_id string 必須

    AtlasプロジェクトID

  • cluster_name string 必須

    Atlas クラスター名

応答

  • 406

    サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現（サポートされていないメディアタイプのパラメーター、または除外された SSE を含む）。既存の認証、認可、およびレート制限の失敗が優先されます。

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

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

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

        検証に失敗したフィールド。

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

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

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

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

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

        検証に失敗したフィールド。

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

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。
  • 200

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • connection_string_srv string
    • id string
    • is_Flex ブール値
    • name string
    • プロバイダー string
    • リージョン string
    • State_name string
    • tier string
    応答属性の非表示 応答属性の表示 オブジェクト
    • connection_string_srv string
    • id string
    • is_Flex ブール値
    • name string
    • プロバイダー string
    • リージョン string
    • State_name string
    • tier string
  • 400

    INVALID_ID または INVALID_REQUEST

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 401

    PLATFOR:

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 403

    Atlas_PERMISSION_REQUERED、Atlas_SERVICE_ACCOUNT_NOT_PAILED、または 禁止

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 404

    NULL_FOUND

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 500

    InterNAL_ERROR

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 502

    Atlas が到達不能、または OK 以外の応答

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 503

    PLATCOM:

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
GET /api/v1 /atlas/projects/{{project_id}/clusters/{{cluster_name} 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/atlas/projects/{project_id}/clusters/{cluster_name}' \
 --header "Authorization: $API_KEY"
応答の例（406） 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例（406） 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例（200） 
{
  "connection_string_srv": "string",
  "id": "string",
  "is_flex": true,
  "name": "string",
  "provider": "string",
  "region": "string",
  "state_name": "string",
  "tier": "string"
}
応答の例（200） 
{
  "connection_string_srv": "string",
  "id": "string",
  "is_flex": true,
  "name": "string",
  "provider": "string",
  "region": "string",
  "state_name": "string",
  "tier": "string"
}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（401） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（401） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（403） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（403） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（404） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（404） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（500） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（500） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（502） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（502） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（503） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（503） 
{
  "code": "string",
  "error": "string",
  "success": true
}