1 つの組織 API キーのすべてのアクセス リスト エントリを取得
項目一覧
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
指定された API キーのすべてのアクセス リスト エントリに関する情報を取得します。
Resource
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
ORG-ID | string | |
API-KEY-ID | string | アクセス リスト エントリを取得するAPIキーの一意の識別子。 認証済みユーザーがアクセスできる指定された組織のすべての API キーを取得するには、 /orgs/{ORG-ID}/apiKeys エンドポイントをリクエストします。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 | 1 | ||||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||||
pretty | ブール値 | レスポンス本体を pretty-print に含めるかどうかを示します 形式。 | false | ||||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
results | 配列 | 配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのアクセス リスト エントリです。
名前 | タイプ | 説明 |
|---|---|---|
cidrBlock | string | アクセス リスト内の IP アドレスの CIDR 表記範囲。 |
count | 数値 | この IP アドレスから送信されたリクエストの合計数。 |
created | date | この IP アドレスがアクセス リストに追加された日付。 |
ipAddress | string | アクセス リスト内の IP アドレス。 |
lastUsed | date | この IP アドレスから送信された最新のリクエストの日付。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから送信された場合にのみ表示され、アクセス リストからリソースが検索されたときにのみ更新されます。 |
lastUsedAddress | string | API への最後の呼び出しが発行された IP アドレス。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから発生した場合にのみ表示されます。 |
links | 配列 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true"
応答例
応答ヘッダー
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}
レスポンス本体
1 { 2 "links" : [ { 3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/599c510c80eef518f3b63fe1/apiKeys/5c49e72980eef544a218f8f8/accessList/?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "cidrBlock" : "147.58.184.16/32", 8 "count" : 0, 9 "created" : "2019-01-24T16:34:57Z", 10 "ipAddress" : "147.58.184.16", 11 "lastUsed" : "2019-01-24T20:18:25Z", 12 "lastUsedAddress": "147.58.184.16", 13 "links" : [ { 14 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/147.58.184.16", 15 "rel" : "self" 16 } ] 17 }, { 18 "cidrBlock" : "84.255.48.125/32", 19 "count" : 0, 20 "created" : "2019-01-24T16:26:37Z", 21 "ipAddress" : null, 22 "lastUsed" : "2019-01-24T20:18:25Z", 23 "lastUsedAddress": "84.255.48.125", 24 "links" : [ { 25 "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126", 26 "rel" : "self" 27 } ] 28 } ], 29 "totalCount" : 2 30 }