atlas api rateLimiting listRateLimits

--endpointPath

/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters+endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F

false

返されたエンドポイントとなる接続されたデバイスセットを、指定されたエンドポイント パスでフィルタリングします。複数のパスが指定できます。例、 /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters+endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F/、{、} をURLエンコードされた値（それぞれ %2F、%7B、%7D）に置き換えます。

-- envelope

envelope

false

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

--groupId

string

false

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

-h, --help

false

listRateLimits のヘルプ

--ipAddress

string

false

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

--itemsPerPage

整数

false

レスポンスが返す 1 ページあたりのアイテムの数。

--name

/rateLimits?name=Name1 &name=Name2

false

返されたエンドポイントとなる接続されたデバイスセットを、指定されたセット名でフィルターします。複数の名前を指定できます。例、 /rateLimits?name=Name1 &name=Name2 などです。名前にスペースを使用する場合は、スペースをURLエンコードされた値（%20）に置き換えます。

--orgId

string

false

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

-o, --output

string

false

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

-- outputFile

string

false

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

--pageNum

整数

false

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

--pretty

false

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

--userId

string

false

レート制限をリクエストする Atlas user を識別する文字列。ID は、例、サービス アカウント クライアントID 、 API公開キーなどです。このパラメーターが指定されている場合、ユーザーのスコープ付きエンドポイントとなる接続されたデバイスセットのみが返され、返された制限は指定されたユーザーに適用されます。リクエスト元のユーザーは、指定されたユーザーと同じである必要があります。

--version

string

false

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