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

項目一覧

Resource

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

目的の IP アドレスの一意な識別子を使用して、1 つのグローバルアクセスリストエントリの値を更新します。

特定のグローバルアクセスリストエントリを見つけるには、でグローバルアクセスリストエントリのリストを取得し、必要な {ACCESS-LIST-ID}を見つけます。

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

Resource

PATCH /admin/accessList/{ACCESS-LIST-ID}

必須のロール

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

Request Parameters

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

名前	タイプ	説明
`ACCESS-LIST-ID`	string	グローバルアクセスリストエントリの一意の識別子です。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

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

false

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

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

応答

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

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2   --header "Accept: application/json" \
3   --header "Content-Type: application/json" \
4   --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList/{ACCESS-LIST-ID}?pretty=true"

応答例

応答ヘッダー

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" : "{ACCESS-LIST-ID}",
7   "lastUsed" : null,
8   "type" : "GLOBAL_ROLE",
9   "updated" : "2019-09-04T17:45:33Z"
10 }

戻る

エントリの作成

エントリーの削除

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList/{ACCESS-LIST-ID}?pretty=true"

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