ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
必須のロール
このリソースには、認証されたユーザーまたは API キーが必要です。
Resource
GET /groups/availablePoliciesリクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 |
|
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | レスポンス本体を pretty-print 形式にするかどうかを示します。 |
|
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | このポリシーを設定するプロジェクトの一意の識別子。 |
| string | この機能制御ポリシーが作成されたときの ISO8601 の日付と時刻形式の UTC のタイムスタンプ。 |
| string | ISO8601 のタイムスタンプ この機能制御ポリシーが更新されたときの日付と時刻形式（ UTC）。 |
| オブジェクト | このMongoDB Ops Managerプロジェクトを管理する外部システムのパラメーターを識別します。 |
| string | このMongoDB Ops Managerプロジェクトを管理する外部システムの識別ラベル。 |
| string | この MongoDB Ops Manager プロジェクトを管理する外部システムの一意の識別子。 |
| string | このMongoDB Ops Managerプロジェクトを管理する外部システムのアクティブなリリース。 |
| 配列 | 外部システムがこのMongoDB Ops Managerプロジェクトに適用するポリシーのリスト。 |
| オブジェクト | このMongoDB Ops Managerプロジェクトの 1 つのポリシー セット。 このパラメータは、 可能な値は次のとおりです。
|
| 配列 |
|
リクエストの例
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 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}レスポンス本体
{ "_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"] } ]}