Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

1 つのクラスターを更新

項目一覧

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

1 つのプロジェクト内の 1 つのクラスターを更新します。

更新できるのは clusterNameフィールドのみです。 MongoDB Ops Managerは、検出したクラスター プロパティに基づいて、他のすべてのクラスター フィールドにデータを入力します。

注意

この操作は、 typeNameSHARDEDまたはSHARDED_REPLICA_SETであるクラスターでのみ使用できます。

割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。

  • Project Monitoring Admin.

  • Project Owner.

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

PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}
名前
タイプ
説明
PROJECT-ID
string
プロジェクトの一意の識別子です。
CLUSTER-ID
string
検索対象のクラスターの一意な識別子です。

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

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

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

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

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

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false
Body Parameter
タイプ
必要性
説明
clusterName
string
必須
クラスターに割り当てる名前。
名前
タイプ
説明
clusterName
string
クラスターの表示名。 mongod自体ではクラスターに名前を付けることはできないことに注意してください。 MongoDB Ops Manager はこの名前を提供し、更新することができます。 シャーディングされたクラスター内のレプリカセットの場合、クラスター名はその親クラスターの名前になります。
groupId
string
クラスターが属するプロジェクトの一意の識別子。
id
string
クラスターの一意の識別子です。
lastHeartbeat
date
ISO8601 のタイムスタンプMongoDB Ops Manager がこのクラスターからの ping を最後に処理した UTC 形式の日付と時刻。
replicaSetName
string
レプリカセット名。 MongoDB Ops Manager は、クラスターにtypeNameREPLICA_SETまたはCONFIG_SERVER_REPLICA_SETがある場合、この値を返します。
shardName
string
シャード名。 MongoDB Ops Manager は、クラスターにtypeName SHARDEDREPLICA_SET またはシャーディングされたクラスターの一部である がある場合、この値を返します。
typeName
string

クラスターの種類。 MongoDB Ops Manager は次を返す場合があります。

typeName
説明
REPLICA_SET
SHARDED
各シャードがスタンドアロンインスタンスであるシャーディングされたクラスター。 レプリカセットではないシャードはありません。
SHARDED_REPLICA_SET
レプリカセットであるシャードを少なくとも 1 つ含むシャーディングされたクラスター。
CONFIG_SERVER_REPLICA_SET
レプリカセットとして配置されたコンフィギュレーションサーバー。
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}/clusters/{CLUSTER-ID}?pretty=true"
--data '{
"clusterName":"New Cluster Name"
}'
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 "clusterName": "New Cluster Name",
3 "groupId": "5e84b94c003f2d6370004f4e",
4 "id": "5e8ba20e87d9396ca9b96bd0",
5 "lastHeartbeat": "2020-06-10T14:51:28Z",
6 "links": [
7 {
8 "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
9 "rel": "self"
10 }
11 ],
12 "replicaSetName": "myRS",
13 "typeName": "REPLICA_SET"
14}

戻る

1 つのプロジェクトの 1 つのクラスターを取得