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形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
追加する 1 つのアクセス リスト エントリを表すドキュメントを指定します。
アクセス リストにまだ存在しない cidrBlock 値を含む POST リクエストを送信すると、 MongoDB Ops Managerはそれらのエントリをアクセス リスト内の既存のエントリのリストに追加します。 MongoDB Ops Manager では、リクエストで指定されたエントリのみを含むようにアクセス リストを設定することはありません。
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | グローバル アクセス リスト エントリの説明。 長さが 1 文字から 250 文字の間である必要があります。 |
| string | 必須 | 追加するIPv4またはIPv6 CIDR表記のアクセスリストエントリ |
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | アクセス リスト内の IP アドレスの範囲（IPv4 または IPv6 CIDR 表記） |
| string | タイムスタンプ（ UNIXエポック からの経過秒数単位） この CIDR ブロックを グローバル アクセス リスト に追加したとき |
| string | このグローバル アクセス リスト エントリの目的の説明。 |
| string | このグローバル アクセス リスト エントリの一意の識別子。 |
| string | グローバル アクセス リスト エントリのスコープ。 |
| string | タイムスタンプ（ UNIXエポック からの経過秒数単位） このグローバル アクセス リスト エントリの CIDR ブロックを最後に変更したとき |
リクエストの例
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/admin/accessList?pretty=true" \--data ' { "cidrBlock" : "127.0.0.1/32", "description" : "Docs Example" }'応答例
応答ヘッダー
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}レスポンス本体
{ "cidrBlock" : "127.0.0.1/32", "created" : "2019-09-04T17:45:33Z", "description" : "Docs Example", "expires" : null, "id" : "5d6ff83dff4ab7133648b584", "lastUsed" : null, "type" : "GLOBAL_ROLE", "updated" : "2019-09-04T17:45:33Z"}