Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
機能制御ポリシー

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

項目一覧

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

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

必須のロール

このリソースには、認証されたユーザーまたは API キーが必要です。

Resource

GET /groups/availablePolicies

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

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

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

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

名前
タイプ
説明
default

pageNum

integer

ページ番号（1 インデックス ベース）。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

レスポンス本体を pretty-print にするかどうかを示します 形式。

false

envelope

ブール値

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

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

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

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

なし

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

このエンドポイントは、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配列で 1 回以上設定できます。

可能な値は次のとおりです。

値
目的

EXTERNALLY_MANAGED_LOCK

Cloud Manager を使用して、 policies.policy[n]配列に指定される他の設定を管理することはできません。 これらの同じユーザーは、これらの設定を管理するために Kubernetes Operator などの構成済みの外部システムを使用する場合があります。

DISABLE_USER_MANAGEMENT

ユーザーはユーザーまたはロールを管理できません。

DISABLE_AUTHENTICATION_
MECHANISMS

ユーザーは認証設定を変更できません。

DISABLE_SET_MONGOD_
CONFIG

ユーザーはpolicies[n].disabledParams配列にリストされているmongod設定を変更できません。

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}

戻る

Retrieve

次へ

Update