1 つのプロジェクトの機能ポリシーを取得
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
必須のロール
このリソースには Project Ownerが必要です。
Resource
GET /groups/{PROJECT-ID}/controlledFeature
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
PROJECT-ID | string | 必須 | 制御された機能を持つプロジェクトの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 | 1 | ||||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||||
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 | false | ||||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
_id | string | このポリシーを設定するプロジェクトの一意の識別子。 | ||||||||||||||||||||||
created | string | ISO8601 のタイムスタンプ この機能制御ポリシーが作成されたときの UTC 形式の日付と時刻形式。 | ||||||||||||||||||||||
updated | string | ISO8601 のタイムスタンプ この機能制御ポリシーが更新されたとき、 UTC で表された日付と時刻形式。 | ||||||||||||||||||||||
externalManagementSystem | オブジェクト | この Cloud Manager プロジェクトを管理する外部システムのパラメーターを特定します。 | ||||||||||||||||||||||
externalManagementSystem.name | string | この Cloud Manager プロジェクトを管理する外部システムの識別ラベル。 | ||||||||||||||||||||||
externalManagementSystem.systemId | string | この Cloud Manager プロジェクトを管理する外部システムの一意の識別子。 | ||||||||||||||||||||||
externalManagementSystem.version | string | この Cloud Manager プロジェクトを管理する外部システムのアクティブなリリース。 | ||||||||||||||||||||||
policies | 配列 | 外部システムがこの Cloud Manager プロジェクトに適用するポリシーのリスト。 | ||||||||||||||||||||||
policies.policy[n] | オブジェクト | この Cloud Manager プロジェクトに設定された単一のポリシー。 このパラメータは、 可能な値は次のとおりです。
| ||||||||||||||||||||||
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/{PROJECT-ID}/controlledFeature?pretty=true"
応答例
応答ヘッダー
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
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}
レスポンス本体
{ "_id": "{PROJECT-ID}", "created": "2019-08-29T15:03:24Z", "updated": "2019-08-29T15:03:24Z", "externalManagementSystem": { "name": "Operator", "systemId": "6d6c139ae5528707b6e8e3b2", "version": "0.2.1" }, "policies": [ {"policy": "ExternallyManagedLock"}, {"policy": "DisableUserManagement"}, {"policy": "DisableAuthenticationMechanisms"}, {"policy": "DisableSetMongodVersion"}, { "policy": "DisableSetMongodConfig", "disabledParams": ["net.tls.CAFile"] } ] }