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

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

API キーの一意の識別子と任意の IP アドレスを使用して、単一の API キーアクセスリストエントリに関する情報を取得します。

Resource

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

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

名前	タイプ	説明
`ORG-ID`	string	ターゲット API キーが属する組織の一意の識別子。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgsエンドポイントをリクエストします。
`API-KEY-ID`	string	アクセスリストエントリを検索したい APIキーの一意の識別子。認証済みユーザーがアクセスできる指定された組織のすべての API キーを検索するには、 /orgs/{ORG-ID}/apiKeys エンドポイントとなる接続されたデバイスをリクエストします。
`ACCESS-LIST-ENTRY`	string	IP または CIDR アドレス。エントリにサブネットマスク（例：`192.0.2.0/24`）が含まれている場合、フォワードスラッシュ `/` には URL エンコード値 `%2F` を使用します。

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

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

名前	タイプ	説明	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`フィールドを追加します。	なし

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

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

応答

名前	タイプ	説明
`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 つ以上のサブリソースや関連リソース（リストページ分割など）へのリンクを表すドキュメントの配列。詳細については、「リンク」を参照してください。

リクエストの例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2     --header "Accept: application/json" \3     --header "Content-Type: application/json" \4     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24?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}

レスポンス本体

1{2  "cidrBlock": "192.0.2.0/24",3  "count": 0,4  "created": "2019-11-01T14:44:44Z",5  "links": [6    {7               "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24",8               "rel": "self"9           },10           {11               "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",12               "rel": "http://mms.mongodb.com/apiKeys"13           }14       ]15   }