AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

1 つの組織 API キーのすべてのアクセス リスト エントリを取得

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

指定されたAPIキーのすべてのアクセス リスト エントリに関する情報を取得します。

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList

リクエスト パス パラメーター

名前
タイプ
説明

ORG-ID

string

ターゲット API キーが属する 組織 の一意の識別子。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgsエンドポイントをリクエストします。

API-KEY-ID

string

アクセス リスト エントリを検索したい APIキーの一意の識別子。認証済みユーザーがアクセスできる指定された組織のすべての API キーを検索するには、 /orgs/{ORG-ID}/apiKeys エンドポイントとなる接続されたデバイスをリクエストします。

リクエスト クエリ パラメータ

次のクエリ パラメータは 任意です。

名前
タイプ
説明
default

pageNum

integer

ページ番号（1 インデックス ベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

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

false

envelope

ブール値

応答をエンベロープでラップするかどうかを示します。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで "envelope" : true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

なし

リクエスト ボディ パラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。

名前
タイプ
説明

results

配列

配列には、results 埋め込みドキュメント セクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。

links

配列

配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。

totalCount

数値

結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

results embeddedDocument

各結果は 1 つのアクセス リスト エントリです。

名前
タイプ
説明

cidrBlock

string

アクセス リスト内の IP アドレスの CIDR 表記範囲。

count

数値

この IP アドレスから送信されたリクエストの合計数。

created

date

この IP アドレスがアクセス リストに追加された日付。

ipAddress

string

アクセス リスト内の IP アドレス。

lastUsed

date

この IP アドレスから送信された最新のリクエストの日付。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから送信された場合にのみ表示され、アクセス リストからリソースが検索されたときにのみ更新されます。

lastUsedAddress

string

API への最後の呼び出しが発行された IP アドレス。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから発生した場合にのみ表示されます。

links

配列

1 つ以上のサブリソースや関連リソース（ リストページ 分割 など）への リンク を表すドキュメントの配列。詳細については、「リンク」を参照してください。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \  --header "Accept: application/json" \  --header "Content-Type: application/json" \  --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true"

応答例

応答ヘッダー

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{  "links" : [ {  "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/599c510c80eef518f3b63fe1/apiKeys/5c49e72980eef544a218f8f8/accessList/?pretty=true&pageNum=1&itemsPerPage=100",  "rel" : "self"  } ],  "results" : [ {    "cidrBlock" : "147.58.184.16/32",    "count" : 0,    "created" : "2019-01-24T16:34:57Z",    "ipAddress" : "147.58.184.16",    "lastUsed" : "2019-01-24T20:18:25Z",    "lastUsedAddress": "147.58.184.16",    "links" : [ {      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/147.58.184.16",      "rel" : "self"    } ]  }, {    "cidrBlock" : "84.255.48.125/32",    "count" : 0,    "created" : "2019-01-24T16:26:37Z",    "ipAddress" : null,    "lastUsed" : "2019-01-24T20:18:25Z",    "lastUsedAddress": "84.255.48.125",    "links" : [ {      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126",      "rel" : "self"    } ]  } ],  "totalCount" : 2}
戻る
組織のアクセス リスト
次へ
1 つのエントリを取得
このページを評価

項目一覧