ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
指定されたAPI キーに対して 1 つ以上の新しいアクセス リスト エントリを作成します。
Resource
POST /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessListリクエスト パス パラメーター
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
プロジェクトに追加する 1 つのアクセス リスト エントリを表すドキュメントの配列を指定します。 プロジェクトに 1 つのアクセス リスト エントリのみを関連付けるための配列を指定する必要があります。
アクセス リストにまだ存在しない ipAddress または cidrBlock 値を含む POST リクエストを送信すると、 MongoDB Ops Managerはそれらのエントリをアクセス リスト内の既存のエントリのリストに追加します。 MongoDB Ops Manager では、リクエストで指定されたエントリのみを含むようにアクセス リストを設定することはありません。
注意
MongoDB Ops Managerは、1 つの組織内で最大 500 APIキーをサポートします。
次の表では、 [i]は配列インデックスを表します。
名前 | タイプ | 説明 |
|---|---|---|
| string | API キーのアクセス リストに追加する IP アドレス。 このフィールドは、 |
| string | API キーに追加するCIDR表記のアクセス リスト エントリ。このフィールドは |
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
results配列内の各オブジェクトは、1 つのアクセス リスト エントリです。
名前 | タイプ | 説明 |
|---|---|---|
| string | アクセス リスト内の IP アドレスの CIDR 表記範囲。 |
| 数値 | この IP アドレスから送信されたリクエストの合計数。 |
| date | この IP アドレスがアクセス リストに追加された日付。 |
| string | アクセス リスト内の IP アドレス。 |
| date | この IP アドレスから送信された最新のリクエストの日付。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから送信された場合にのみ表示され、アクセス リストからリソースが検索されたときにのみ更新されます。 |
| string | API への最後の呼び出しが発行された IP アドレス。 このフィールドは、少なくとも 1 つのリクエストがこの IP アドレスから発生した場合にのみ表示されます。 |
| 配列 |
リクエストの例
curl --user '{USER-ID}:{API-KEY}' --digest \--header 'Accept: application/json' \--header 'Content-Type: application/json' \--include \--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \--data ' [{ "ipAddress" : "77.54.32.11" }]'応答例
応答ヘッダー
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-aliveHTTP/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}レスポンス本体
{ "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "cidrBlock" : "206.252.195.126/32", "count" : 47, "created" : "2019-01-24T16:26:37Z", "ipAddress" : "206.252.195.126", "lastUsed" : "2019-01-25T16:32:47Z", "lastUsedAddress" : "206.252.195.126", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126", "rel" : "self" } ] }, { "cidrBlock" : "76.54.32.11/32", "count" : 0, "created" : "2019-01-24T21:09:05Z", "ipAddress" : null, "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11", "rel" : "self" } ] } ], "totalCount" : 2}