IP アドレスのアクセスリストを取得する

項目一覧

Resource

応答
リクエストの例
応答例

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

IP-ADDRESSの値がエンティティのipAddressフィールドの値と等しい場合にアクセスリストエンティティを取得します。これでは、 IP-ADDRESSの値がcidrBlockフィールドで許可された値内に含まれるオブジェクトは取得されません。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /users/{USER-ID}/accessList/{ACCESS-LIST-ENTRY}

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

Parameter	タイプ	説明
ユーザー ID	string	（必須。）現在のユーザーの一意の識別子。現在のユーザーの ID を取得するには、「 1 つのプロジェクトのすべてのユーザーを取得」を参照してください。
`ACCESS-LIST-ENTRY`	string	IP または CIDRアドレス。エントリに`192.0.2.0/24`などのサブネットマスクが含まれている場合は、スラッシュ`/`の代わりに URL エンコードされた値`%2F`を使用します。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

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

応答

名前	タイプ	説明
`cidrBlock`	string	CIDR 表記の IP アドレス範囲。
`created`	date	この IP アドレスがアクセスリストに追加された日付。
`ipAddress`	string	アクセスリスト内の IP アドレス。
`lastUsed`	date	この IP アドレスから送信された最新のリクエストの日付。このフィールドは、アクセスリストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。
`lastUsedAddress`	string	API への最後の呼び出しが発行されたアドレス。
`count`	数値	この IP アドレスから送信されたリクエストの合計数。このフィールドは、アクセスリストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。
`links`	配列	関連するサブリソースへのリンク。レスポンス内のすべてのリンク配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL 間の関係は、 Web リンク仕様で説明されています。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList/192.0.2.0%2F24"

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList/?pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "cidrBlock": "192.0.2.0/24",
      "count": 0,
      "created": "2019-11-01T15:18:12Z",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList/192.0.2.0%2F24",
          "rel": "self"
        }
      ]
    },
  ],
  "totalCount": 1
}

戻る

現在のユーザーのアクセスリストを取得

アクセスリストへのエントリの追加