Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API リソース
/
プログラム API キー
/
組織のプログラマティック API キー アクセス リスト

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

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

ベース URL: https://cloud.mongodb.com/api/public/v 1.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
ブール値
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 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}

レスポンス本体

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   }

戻る

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