atlas api rateLimiting getRateLimit

string

true

レート制限エンドポイントセットのID 。

envelope

false

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

string

false

レート制限をリクエストする Atlas プロジェクトを識別する一意の 24 桁の 16 進数文字列。このパラメーターが指定されている場合、返された制限は指定されたプロジェクトに適用されます。リクエスト元のユーザーには、指定されたプロジェクトのプロジェクト読み取り専用ロールが必要です。

false

getRateLimit のヘルプ

string

false

レート制限をリクエストIPアドレス。このパラメーターが指定された場合、返される制限は指定されたIPアドレスに適用されます。リクエスト元のユーザーは、リクエストで提供された IP アドレスと同じIPアドレスを持っている必要があります。

string

false

レート制限をリクエストする Atlas 組織を識別する一意の 24 桁の 16 進数文字列。このパラメーターが指定されている場合、返される制限は指定された組織に適用されます。リクエスト元のユーザーには、指定された組織の組織読み取り専用ロールが必要です。

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。

false

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

string

false

レート制限をリクエストする Atlas ユーザーを識別する string。 ID は、例、サービス アカウント クライアントID 、 API公開キーなどです。このパラメーターが指定されている場合、返される制限は指定されたユーザーに適用されます。リクエスト元のユーザーは、指定されたユーザーと同じである必要があります。

string

false

API 呼び出しで使用する最新の API バージョン [options: "2025-03-12", "プレビュー"] は、デフォルトでバージョン または プロファイルの api_version 構成値（設定されている場合）にデフォルト設定されます。この値はデフォルトで "プレビュー" になります".