アクセスリストへのエントリの追加

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

POST /users/{USER-ID}/accessList

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

Parameter	タイプ	説明
ユーザー ID	string	（必須。）現在のユーザーの一意の識別子。現在のユーザーの ID を取得するには、「 1 つのプロジェクトのすべてのユーザーを取得する」を参照してください。

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

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

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

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

リクエストボディは、アクセスリストエンティティが 1 つしかない場合でも、アクセスリストエンティティの配列である必要があります。各リクエストオブジェクトに指定する必要があるフィールドは、 IP-ADRESSのみです。

IP アドレスがすでにアクセスリストに含まれている場合は、無視されます。

/32サブネットマスクで単一の IP アドレスを指定すると、 /32はアドレスを変更しないため、MongoDB Ops Manager は/32を保存しません。

例

のアドレスは12.34.56.78 12.34.56.78/32と同じです。

Parameter	タイプ	説明
ipAddress	string	（必須。）指定されたユーザーのアクセスリストに追加する IP アドレスまたはCIDRブロック。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのアクセスリストです。

名前	タイプ	説明
`cidrBlock`	string	CIDR 表記の IP アドレス範囲。
`created`	date	この IP アドレスがアクセスリストに追加された日付。
`ipAddress`	string	アクセスリスト内の IP アドレス。
`lastUsed`	date	この IP アドレスから送信された最新のリクエストの日付。このフィールドは、アクセスリストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。
`lastUsedAddress`	string	API への最後の呼び出しが発行されたアドレス。
`count`	数値	この IP アドレスから送信されたリクエストの合計数。このフィールドは、アクセスリストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。
`links`	配列	関連するサブリソースへのリンク。レスポンス内のすべてのリンク配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL 間の関係は、 Web リンク仕様で説明されています。

リクエストの例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--include \
--request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}/accessList" --data '
    [
      {
        "ipAddress" : "192.0.1.15",
        "comment" : "IP address for Application Server A"
      },
      {
        "cidrBlock" : "192.0.2.0/24",
        "comment" : "CIDR block for Application Server B - D"
      }
    ]'

応答例

応答ヘッダー

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 201 Created
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}

レスポンス本体

{
  "totalCount" : 3,
  "results" : [ {
    "cidrBlock" : "12.34.56.78/32",
    "ipAddress" : "12.34.56.78",
    "created" : "2014-04-23T16:17:44Z",
    "lastUsed" : "2016-08-17T19:34:05Z",
    "lastUsedAddress" : "12.34.56.78",
    "count" : 0,
    "links" : []
  }, {
    "cidrBlock" : "76.54.32.10/32",
    "ipAddress" : "76.54.32.10",
    "created" : "2016-08-17T19:34:05Z",
    "count" : 0,
    "links" : []
  }, {
    "cidrBlock" : "2.3.4.5/32",
    "ipAddress" : "2.3.4.5",
    "created" : "2016-08-17T19:34:05Z",
    "count" : 0,
    "links" : []
  } ],
  "links" : []
}

戻る

IP アドレスのアクセスリストを取得する

1 つのアクセスリストから 1 つのエントリを削除

Resource

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

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

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

例

応答