IP アドレスのアクセス リストを取得する
- 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 つのプロジェクトのすべてのユーザーを取得 」を参照してください。 |
| string | IP または CIDRアドレス。 エントリに |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
---|---|---|
| string | CIDR 表記の IP アドレス範囲。 |
| date | この IP アドレスがアクセス リストに追加された日付。 |
| string | アクセス リスト内の IP アドレス。 |
| date | この IP アドレスから送信された最新のリクエストの日付。 このフィールドは、アクセス リストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。 |
| string | API への最後の呼び出しが発行されたアドレス。 |
| 数値 | この IP アドレスから送信されたリクエストの合計数。 このフィールドは、アクセス リストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。 |
| 配列 | 関連するサブリソース へのリンク。 レスポンス内のすべてのリンク配列には、 |
リクエストの例
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"
応答例
応答ヘッダー
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
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 }