このMongoDBアプリケーションのステータスを返す

GET /api/atlas/v2

サービスアカウント DigestAuth

このリソースは、MongoDB アプリケーションに関する情報と API キーのメタデータを返します。

クエリパラメータ

envelope ブール値

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

デフォルト値はfalseです。
pretty ブール値

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

デフォルト値はfalseです。

Prettyprint

応答

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

OK
応答属性の非表示応答属性の表示オブジェクト
- apiKey オブジェクト| null 必須
  
  1 つのAPIキーに含まれる詳細。
  
  apiKey 属性を非表示にする apiKey 属性の表示オブジェクト| null
  
  accessList array[オブジェクト]
  
  このAPIキーを使用してこのAPIへのアクセスが許可されたネットワークアドレスのリスト。
  
  accessList 属性を非表示にする accessList 属性の表示オブジェクト
  
  cidrBlock string
  
  このプロジェクトのアクセスリストにある CIDR（Classless Inter-Domain Routing）表記のIPアドレスの範囲。
  
  形式は次のパターンと一致する必要があります: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$。
  
  ipAddress string 必須
  
  APIアクセスリストに含まれるIPアドレス。
  
  形式は次のパターンと一致する必要があります: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$。
  
  id string 必須
  
  この組織の API キーを識別する、ユニークな 24 桁の 16 進数の文字列。
  
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
  
  publicKey string 必須
  
  指定された組織APIキーの公開APIキー値セット。
  
  最小長は 8、最大長は 8 です。
  
  役割 array[オブジェクト]
  
  APIキーが持つ必要があるロールを格納したリスト。提供するすべてのロールは、指定されたプロジェクトまたは組織に対して有効である必要があります。各リクエストには、少なくとも 1 つの有効なロールを含める必要があります。リソースは、Cloud ユーザーに割り当てられたすべてのプロジェクトと組織ロールを返します。
  
  MongoDB Cloud ユーザーのロールと、そのロールが適用される対応する組織またはプロジェクト。各ロールは 1 つの組織または 1 つのプロジェクトに適用できますが、両方に適用することはできません。
  
  ロール属性を非表示にするロール属性の表示オブジェクト
  
  グループ ID string
  
  24このロールが属するプロジェクトを識別する一意の桁の 16 進数文字列。このパラメータに値を設定することも、 orgId に値を設定することもできますが、同じリクエストで両方を設定することはできません。
  
  最小長は 24、最大長は 24 です。形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
  
  orgId string
  
  24このロールが属する組織を識別する一意の桁の 16 進数文字列。このパラメータに値を設定することも、 groupId に値を設定することもできますが、同じリクエストで両方を設定することはできません。
  
  最小長は 24、最大長は 24 です。形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
  
  roleName string
  
  MongoDB Cloud が特定のAPIキー、 MongoDB Cloud ユーザー、またはMongoDB Cloudチームに付与する権限のコレクションを識別する、人間に判読可能なラベル。これらのロールには、組織レベルとプロジェクトレベルのロールが含まれます。
  
  値は ORG_MEMBER、ORG_READ_ONLY、ORG_STREAM_PROCESSING_ADMIN、ORG_BILLING_ADMIN、ORG_BILLING_READ_ONLY、ORG_GROUP_CREATOR、ORG_OWNER、GROUP_OWNER、GROUP_READ_ONLY、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、 GROUP_CLUSTER_MANAGER、GROUP_SEARCH_INDEX_EDITOR、GROUP_STREAM_PROCESSING_OWNER、GROUP_BACKUP_MANAGER、GROUP_OBSERVABILITY_VIEWER、または GROUP_DATABASE_ACCESS_ADMIN 。
- appName string 必須
  
  この応答をリクエストしたサービスを識別する、人間が判読可能なラベル。
  
  値は MongoDB Atlas です。
- 構築 string 必須
  
  このアプリケーションに対してマージされた最新の Git コミットを識別する一意の 40 桁の 16 進数ハッシュ。
- Links array[オブジェクト]
  
  APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
  
  Web リンク仕様（RFC 5988）
  
  リンク属性を非表示にするリンク属性を表示するオブジェクト
  
  href string
  
  この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
  
  リリース string
  
  このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
- スロットリングブール値必須
  
  このサービスでスロットリングが有効になっているかどうかを示すフラグ。
401

許可されていません。
403 application/ JSON

Forbidden.
応答属性の非表示応答属性の表示オブジェクト
- 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

atlas api root getSystemStatus --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/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.GetSystemStatusApiParams{}
	sdkResp, httpResp, err := client.RootApi.
		GetSystemStatusWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

応答の例（200）

{
  "apiKey": {
    "accessList": [
      {
        "cidrBlock": "string",
        "ipAddress": "string"
      }
    ],
    "id": "32b6e34b3d91647abb20e7b8",
    "publicKey": "string",
    "roles": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "orgId": "32b6e34b3d91647abb20e7b8",
        "roleName": "ORG_MEMBER"
      }
    ]
  },
  "appName": "MongoDB Atlas",
  "build": "83be55e140f493c88e7f578aae96548dd881587b",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "throttling": true
}

応答の例（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"
}

応答の例（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"
}

このMongoDBアプリケーションのステータスを返す

クエリ パラメータ

応答

クエリパラメータ