AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

1 つのクラスターを更新

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

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

注意

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

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

ベース URL: https://cloud.mongodb.com/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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

Body Parameter
タイプ
必要性
説明

clusterName

string

必須

クラスターに割り当てる名前。

名前
タイプ
説明

clusterName

string

クラスターの表示名。 mongod自体ではクラスターに名前を付けることはできないことに注意してください。 Cloud Manager はこの名前を提供し、更新することができます。 シャーディングされたクラスター内のレプリカセットの場合、クラスター名はその親クラスターの名前になります。

groupId

string

クラスターが属するプロジェクトの一意の識別子。

id

string

クラスターの一意の識別子です。

lastHeartbeat

date

Cloud Managerがこのクラスターからのpingを最後に処理したときの、ISO 8601形式の日付と時刻(UTC)。

replicaSetName

string

レプリカセット名。 Cloud Manager は、クラスターのtypeNameがREPLICA_SETまたはCONFIG_SERVER_REPLICA_SETの場合、この値を返します。

shardName

string

シャード名。 Cloud Manager は、クラスターにtypeName のSHARDED またはシャーディングされたクラスターの一部である がある場合、この値を返します。REPLICA_SET

typeName

string

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

  • 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://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?pretty=true" --data '{ "clusterName":"New Cluster Name" }'
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-alive
HTTP/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}
{ "clusterName": "New Cluster Name", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e8ba20e87d9396ca9b96bd0", "lastHeartbeat": "2020-06-10T14:51:28Z", "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", "rel": "self" } ], "replicaSetName": "myRS", "typeName": "REPLICA_SET"}