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

1 つのプロジェクト サービス アカウントのアクセス リスト エントリを作成

ベース URL: https://cloud.mongodb.com/api/public/v1.0

指定されたサービス アカウントに対して 1 つ以上の新しいアクセス リスト エントリを作成します。

Resource

POST /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/accessList

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

名前
タイプ
説明

PROJECT-ID

string

ターゲット サービス アカウントが属するプロジェクトの一意の識別子です。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

CLIENT-ID

string

シークレットを作成するサービス アカウントの一意な識別子です。 /groups/{PROJECT- ID}/serviceAccounts エンドポイントを使用して、指定されたプロジェクトに対して認証済みユーザーがアクセスできるすべてのサービス アカウントを取得します。

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

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

名前
タイプ
説明
default

pageNum

integer

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

1

itemsPerPage

integer

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

100

pretty

ブール値

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

false

envelope

ブール値

レスポンスをエンベロープにラップするかどうかを示します。

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

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

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

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

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

なし

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

プロジェクトに追加する 1 つのアクセス リスト エントリを表すドキュメントの配列を指定します。 プロジェクトに 1 つのアクセス リスト エントリのみを関連付けるための配列を指定する必要があります。

アクセス リストにまだ存在しないipAddressまたはcidrBlock値を含むPOSTリクエストを送信すると、Cloud Manager はそれらのエントリをアクセス リスト内の既存のエントリのリストに追加します。 Cloud Manager では、リクエストで指定されたエントリのみを含むアクセス リストは設定しません。

次の表では、 [i]は配列インデックスを表します。

名前
タイプ
説明

[i].ipAddress

string

サービス アカウントのアクセス リストに追加するIPアドレス。 このフィールドは、cidrBlockフィールドと相互に排他的です。

[i].cidrBlock

string

サービス アカウント用に追加する CIDR 表記のアクセス リスト エントリー。このフィールドは ipAddress フィールドと相互に排他的です。

応答

応答ドキュメント

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

名前
タイプ
説明

results

配列

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

links

配列

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

totalCount

数値

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

results embeddedDocument

results配列内の各オブジェクトは、1 つのアクセス リスト エントリです。

名前
タイプ
説明

cidrBlock

string

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

requestCount

数値

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

createdAt

date

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

ipAddress

string

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

lastUsedAt

date

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

lastUsedAddress

string

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

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \     --header 'Accept: application/json' \     --header 'Content-Type: application/json' \     --include \     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/accessList?pretty=true" \     --data '       [{         "ipAddress" : "77.54.32.11"       }]'

応答例

応答ヘッダー

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://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100",    "rel" : "self"  } ],  "results" : [ {    "cidrBlock" : "206.252.195.126/32",    "requestCount" : 47,    "createdAt" : "2019-01-24T16:26:37Z",    "ipAddress" : "206.252.195.126",    "lastUsed" : "2019-01-25T16:32:47Z",    "lastUsedAddress" : "206.252.195.126"
  } ],  "totalCount" : 1}
このページを評価

項目一覧