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

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

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

このエンドポイントへのすべてのリクエストは、MongoDB Ops Manager ユーザーの API アクセスリストの IP アドレスから送信される必要があります。 API アクセスリストの構成に関する詳細なドキュメントについては、「組織に対して API アクセスリストが必要」を参照してください。

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

指定されたAPI キーに対して 1 つ以上の新しいアクセスリストエントリを作成します。

Resource

POST /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList

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

名前	タイプ	説明
`ORG-ID`	string	ターゲット API キーが属する組織の一意の識別子。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgsエンドポイントを使用します。
`API-KEY-ID`	string	新しいアクセスリストエントリを作成する組織APIキーの一意の識別子。

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

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

名前

タイプ

説明

default

pageNum

integer

ページ番号（1 インデックスベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

レスポンス本体を pretty-print に含めるかどうかを示します形式。

false

envelope

ブール値

応答をエンベロープでラップするかどうかを示します。

一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで"envelope" : trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

状態	HTTPレスポンスコード
envelope	期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

なし

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

プロジェクトに追加する 1 つのアクセスリストエントリを表すドキュメントの配列を指定します。プロジェクトに 1 つのアクセスリストエントリのみを関連付けるための配列を指定する必要があります。

アクセスリストにまだ存在しない ipAddress または cidrBlock 値を含む POST リクエストを送信すると、 MongoDB Ops Managerはそれらのエントリをアクセスリスト内の既存のエントリのリストに追加します。 MongoDB Ops Manager では、リクエストで指定されたエントリのみを含むようにアクセスリストを設定することはありません。

注意

MongoDB Ops Managerは、1 つの組織内で最大 500 のAPIキーをサポートします。

次の表では、 [i]は配列インデックスを表します。

名前	タイプ	説明
`[i].ipAddress`	string	API キーのアクセスリストに追加する IP アドレス。このフィールドは、 `cidrBlock`フィールドと相互に排他的です。
`[i].cidrBlock`	string	API キーに追加するCIDR表記のアクセスリストエントリ。このフィールドは`ipAddress`フィールドと相互に排他的です。

応答

応答ドキュメント

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

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

`results` embeddedDocument

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

リクエストの例

1 curl --user '{USER-ID}:{API-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \
6 --data '
7   [{
8     "ipAddress" : "77.54.32.11"
9   }]'

応答例

応答ヘッダー

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   "links" : [ {
3     "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "cidrBlock" : "206.252.195.126/32",
8     "count" : 47,
9     "created" : "2019-01-24T16:26:37Z",
10     "ipAddress" : "206.252.195.126",
11     "lastUsed" : "2019-01-25T16:32:47Z",
12     "lastUsedAddress" : "206.252.195.126",
13     "links" : [ {
14       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126",
15       "rel" : "self"
16     } ]
17   }, {
18     "cidrBlock" : "76.54.32.11/32",
19     "count" : 0,
20     "created" : "2019-01-24T21:09:05Z",
21     "ipAddress" : null,
22     "links" : [ {
23       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11",
24       "rel" : "self"
25     } ]
26   } ],
27   "totalCount" : 2
28 }

戻る

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

API キーの 1 つのアクセスリストエントリを削除

1	curl --user '{USER-ID}:{API-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \
6	--data '
7	[{
8	"ipAddress" : "77.54.32.11"
9	}]'

1	{
2	"links" : [ {
3	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"cidrBlock" : "206.252.195.126/32",
8	"count" : 47,
9	"created" : "2019-01-24T16:26:37Z",
10	"ipAddress" : "206.252.195.126",
11	"lastUsed" : "2019-01-25T16:32:47Z",
12	"lastUsedAddress" : "206.252.195.126",
13	"links" : [ {
14	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126",
15	"rel" : "self"
16	} ]
17	}, {
18	"cidrBlock" : "76.54.32.11/32",
19	"count" : 0,
20	"created" : "2019-01-24T21:09:05Z",
21	"ipAddress" : null,
22	"links" : [ {
23	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11",
24	"rel" : "self"
25	} ]
26	} ],
27	"totalCount" : 2
28	}

Resource

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

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

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

注意

応答