名前	タイプ	説明	default
pageNum	integer	ページ番号（1 インデックスベース）。	`1`
itemsPerPage	integer	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	レスポンス本体を pretty-print 形式にするかどうかを示します。	`false`
envelope	ブール値	応答をエンベロープでラップするかどうかを示します。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`"envelope" : true` を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	なし

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

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

応答

名前	タイプ	説明
`_id`	string	このポリシーを設定するプロジェクトの一意の識別子。
`created`	string	この機能制御ポリシーが作成されたときの ISO8601 の日付と時刻形式の UTC のタイムスタンプ。
`updated`	string	この機能制御ポリシーが更新されたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601
`externalManagementSystem`	オブジェクト	このMongoDB Ops Managerプロジェクトを管理する外部システムのパラメーターを識別します。
`externalManagementSystem` `.name`	string	このMongoDB Ops Managerプロジェクトを管理する外部システムの識別ラベル。
`externalManagementSystem` `.systemId`	string	この MongoDB Ops Manager プロジェクトを管理する外部システムの一意の識別子。
`externalManagementSystem` `.version`	string	このMongoDB Ops Managerプロジェクトを管理する外部システムのアクティブなリリース。
`policies`	配列	外部システムがこのMongoDB Ops Managerプロジェクトに適用するポリシーのリスト。
`policies` `.policy[n]`	オブジェクト	このMongoDB Ops Managerプロジェクトの 1 つのポリシーセット。このパラメータは、 `policies`配列で 1 回以上設定できます。可能な値は次のとおりです。 `EXTERNALLY_MANAGED_LOCK`: ユーザーは Ops Manager を使用して、`policies.policy[n]` 配列に指定される他の設定を管理することはできません。これらの同じユーザーは、これらの設定を管理するためにKubernetes Operator などの構成済みの外部システムを使用する場合があります。 `DISABLE_USER_MANAGEMENT`: ユーザーはユーザーまたはロールを管理できません。 `DISABLE_AUTHENTICATION_MECHANISMS`: ユーザーは認証設定を変更できません。 `DISABLE_SET_MONGOD_CONFIG`: ユーザーは`mongod` 配列にリストされている`policies[n].disabledParams` 設定を変更できません。 `DISABLE_SET_MONGOD_VERSION`: ユーザーは`mongod` または`mongos` のバージョンを変更できません。 `DISABLE_BACKUP_AGENT`: ユーザーはバックアップエージェントを有効または無効にすることはできません。 `DISABLE_MONGOD_LOG_MANAGEMENT`: ユーザーはログ管理設定を変更できません。 `DISABLE_IMPORT_TO_AUTOMATION`: ユーザーは、オートメーションを使用して配置を管理できません。 `DISABLE_AGENT_API_KEY_MANAGEMENT`: ユーザーはエージェントAPIキーを作成または更新できません。 `DISABLE_MONGOD_HOST_MANAGEMENT`: ユーザーはホストのサーバータイプを変更できません。
`policies[n]` `.disabledParams`	配列	`DISABLE_SET_MONGOD_CONFIG`ポリシーを適用する場合に無効にする`mongod`設定のリスト。オートメーションはすべての MongoDB オプションをサポートしていないため、インポートが失敗する可能性があります。詳しくは、「 MongoDB 設定とオートメーションサポート」を参照してください。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/availablePolicies?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   "_id": "{PROJECT-ID}",
3   "created": "2019-08-29T15:03:24Z",
4   "updated": "2019-08-29T15:03:24Z",
5   "externalManagementSystem":
6   {
7     "name": "Operator",
8     "systemId": "6d6c139ae5528707b6e8e3b2",
9     "version": "0.2.1"
10   },
11   "policies": [
12     {"policy": "ExternallyManagedLock"},
13     {"policy": "DisableUserManagement"},
14     {"policy": "DisableAuthenticationMechanisms"},
15     {"policy": "DisableSetMongodVersion"},
16     {
17       "policy": "DisableSetMongodConfig",
18       "disabledParams": ["net.tls.CAFile"]
19     }
20   ]
21 }

戻る

Update

グローバルアプリ設定

1	{
2	"_id": "{PROJECT-ID}",
3	"created": "2019-08-29T15:03:24Z",
4	"updated": "2019-08-29T15:03:24Z",
5	"externalManagementSystem":
6	{
7	"name": "Operator",
8	"systemId": "6d6c139ae5528707b6e8e3b2",
9	"version": "0.2.1"
10	},
11	"policies": [
12	{"policy": "ExternallyManagedLock"},
13	{"policy": "DisableUserManagement"},
14	{"policy": "DisableAuthenticationMechanisms"},
15	{"policy": "DisableSetMongodVersion"},
16	{
17	"policy": "DisableSetMongodConfig",
18	"disabledParams": ["net.tls.CAFile"]
19	}
20	]
21	}

すべての機能ポリシーを取得

必須のロール

Resource

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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