Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
プロジェクトとユーザー
/
プロジェクト

1 つのプロジェクトを更新

項目一覧

  • Resource
  • Request Parameters
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例

注意

グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。

このエンドポイントを使用して、1 件のプロジェクトに次のいずれかの変更を加えます。

  • 1 件のプロジェクトの名前を変更します。

  • 1 つのプロジェクトからタグを追加および削除します。

  • 1 つのプロジェクトの MongoDB Ops Manager ロールに LDAPグループをマッピングします。

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

Resource

PATCH /groups/{PROJECT-ID}

Request Parameters

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

名前
タイプ
説明
プロジェクトID
string
（必須。） プロジェクトの一意の識別子。

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

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false

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

リクエスト本文には、次のフィールドの少なくとも 1 つを含める必要があります。

名前
タイプ
必要性
説明
name
string
任意
プロジェクトの新しい名前。
tags
string 配列
任意

プロジェクトをプログラム的に識別するために使用するプロジェクトに割り当てられたタグ。

  • タグを表示するには、 グローバル読み取り専用またはグローバルオーナーロールのいずれかが必要です。

  • タグを作成または編集するには、グローバル所有者である必要があります。

プロジェクトには最大 10 個のタグを含めることができます。 タグは次のルールに従います。

  • 大文字と小文字を区別する

  • 次の文字を含めることができます。

    • A による Z

    • 0 による 9

    • . （期間）

    • _ （アンダースコア）

    • - (dash)

  • 32 文字に制限されています

ldapGroupMappings
オブジェクト配列
任意
LDAPベースのMongoDB Ops Managerの場合、 LDAPグループのMongoDB Ops Managerプロジェクト ロールへのマッピング。 LDAP ベースのMongoDB Ops Managerでのみ受け入れられます。

応答

名前
タイプ
説明
ActiveAgentCount
integer

MongoDB Ops Manager に定期的に ping を送信するアクティブなエージェントの数。

値は約24時間ごとに更新され、キャッシュされます。 新しいエージェントを開始するか、既存のエージェントを停止した場合、変更がactiveAgentCountフィールドに表示されるまでに最大30分かかることがあります。

hostCounts
オブジェクト
タイプ別のホストの合計数。 埋め込みフィールドは自己説明型である必要があります。
id
string
プロジェクトの一意の識別子です。
lastActiveAgent
string
MongoDB Ops Managerがプロジェクトの activeAgentCount の合計を最後に更新した時間。 MongoDB Ops Manager は 24 時間ごとにこの値を更新し、アクティブな MongoDB エージェントの数を記録するためにキャッシュします。
ldapGroupMappings
オブジェクト配列
LDAPベースのMongoDB Ops Managerの場合、 LDAPグループのMongoDB Ops Managerプロジェクト ロールへのマッピング。 LDAP ベースのMongoDB Ops Managerにのみ存在します。
ldapGroupMappings
.roleName
string

MongoDB Ops Manager ユーザー ロール。 プロジェクト ロールのroleNameへのマッピングは次のとおりです。

ユーザー ロール
roleName 値
Project Owner （必須）
GROUP_OWNER
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_WRITE
GROUP_DATA_ACCESS_READ_ONLY
GROUP_READ_ONLY
ldapGroupMappings
.ldapGroups
string 配列
MongoDB Ops Manager ロールにマッピングする LDAP プロジェクト。
Links
オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

name
string
プロジェクトの表示名。
orgId
string
プロジェクトが属する組織のユニーク識別子。
publicApiEnabled
ブール値
このプロジェクトでAPIが有効になっていることを示すフラグ。 これは常にtrueである読み取り専用フィールドです。
replicaSetCount
integer
このプロジェクトのレプリカセットの合計数。
shardCount
integer
このプロジェクトのシャードの合計数。
tags
string 配列

プロジェクトをプログラム的に識別するために使用されるプロジェクトに割り当てられたタグ。

プロジェクトには最大 10 個のタグを含めることができます。 タグは次のルールに従います。

  • 大文字と小文字を区別する

  • 次の文字を含めることができます。

    • A による Z

    • 0 による 9

    • . （期間）

    • _ （アンダースコア）

    • - (dash)

  • 32 文字に制限されています

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}?pretty=true" \
 --data '
 {
            "ldapGroupMappings": [{
                    "roleName": "GROUP_OWNER",
                    "ldapGroups": [
                            "project-owner"
                    ]
            }],
            "name": "Project Name 1",
   "tags": [ "DEV", "PRODUCT" ]
 }'

応答例

応答ヘッダー

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  "name": Project Name 1",
4  "orgId" : "{ORG-ID}",
5  "hostCounts": {
6    "arbiter": 2,
7    "config": 1,
8    "primary": 4,
9    "secondary": 8,
10    "mongos": 2
11  },
12  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
13  "activeAgentCount": 1,
14  "replicaSetCount": 3,
15  "shardCount": 2,
16  "publicApiEnabled": true,
17  "agentApiKey": "{API-KEY}",
18  "tags": [ "DEV", "PRODUCT" ],
19  "ldapGroupMappings" : [ {
20    "roleName": "GROUP_OWNER",
21    "ldapGroups": [  "project-owner" ]
22  }, ... ],
23  "links" : []
24}

戻る

プロジェクトを 1 つ作成