1 つのグローバルアクセスリストエントリを作成

項目一覧

Resource

必須のロール
Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

MongoDB Ops Manager の 1 つのグローバルアクセスリストエントリを作成します。

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

Resource

POST /admin/accessList

必須のロール

このエンドポイントを呼び出す APIキーに Global Ownerロールが必要です。

Request Parameters

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

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

追加する 1 つのアクセスリストエントリを表すドキュメントを指定します。

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

名前	タイプ	必要性	説明
`description`	string	必須	グローバルアクセスリストエントリの説明。長さが 1 文字から 250 文字の間である必要があります。
`cidrBlock`	string	必須	追加するIPv4またはIPv6 CIDR表記のアクセスリストエントリ。

応答

名前	タイプ	説明
`cidrBlock`	string	IPv4またはIPv6 CIDR表記のアクセスリスト内の IP アドレスの範囲。
`created`	string	タイムスタンプ（ UNIXエポックからの経過秒数単位）この CIDR ブロックをグローバルアクセスリストに追加したとき
`description`	string	このグローバルアクセスリストエントリの目的の説明。
`id`	string	このグローバルアクセスリストエントリの一意の識別子。
`type`	string	グローバルアクセスリストエントリのスコープ。
`updated`	string	タイムスタンプ（ UNIXエポックからの経過秒数単位）このグローバルアクセスリストエントリの CIDR ブロックを最後に変更したとき

リクエストの例

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/admin/accessList?pretty=true" \
6 --data '
7   {
8     "cidrBlock"  : "127.0.0.1/32",
9     "description" : "Docs Example"
10   }'

応答例

応答ヘッダー

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" : "127.0.0.1/32",
3   "created" : "2019-09-04T17:45:33Z",
4   "description" : "Docs Example",
5   "expires" : null,
6   "id" : "5d6ff83dff4ab7133648b584",
7   "lastUsed" : null,
8   "type" : "GLOBAL_ROLE",
9   "updated" : "2019-09-04T17:45:33Z"
10 }

戻る

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/admin/accessList?pretty=true" \
6	--data '
7	{
8	"cidrBlock" : "127.0.0.1/32",
9	"description" : "Docs Example"
10	}'

1	{
2	"cidrBlock" : "127.0.0.1/32",
3	"created" : "2019-09-04T17:45:33Z",
4	"description" : "Docs Example",
5	"expires" : null,
6	"id" : "5d6ff83dff4ab7133648b584",
7	"lastUsed" : null,
8	"type" : "GLOBAL_ROLE",
9	"updated" : "2019-09-04T17:45:33Z"
10	}