Docs Home

/ /

クラスター

Docs Home

/ /

1 つのクラスターを更新

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

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

注意

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

必須のロール

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

リクエスト

ベース 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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体	`false`

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

Body Parameter	タイプ	必要性	説明
`clusterName`	string	必須	クラスターに割り当てる名前。

応答

応答パラメータ

名前	タイプ	説明
`clusterName`	string	Display name of the cluster. Note that `mongod` itself doesn't allow you to name a cluster; Ops Manager supplies this name and you can update it. For a replica set within a sharded cluster, the cluster name is the name of its parent cluster.
`groupId`	string	クラスターが属するプロジェクトの一意の識別子。
`id`	string	クラスターの一意の識別子です。
`lastHeartbeat`	date	Ops Manager がこのクラスターからのping を最後に処理したときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601
`replicaSetName`	string	レプリカセット名。 MongoDB Ops Manager は、クラスターに`typeName`の`REPLICA_SET`または`CONFIG_SERVER_REPLICA_SET`がある場合、この値を返します。
`shardName`	string	シャード名。 MongoDB Ops Manager は、クラスターに`typeName` `SHARDED`の`REPLICA_SET` またはシャーディングされたクラスターの一部であるがある場合、この値を返します。
`typeName`	string	クラスターの種類。 MongoDB Ops Manager は次を返す場合があります。 `REPLICA_SET`: A replica set. `SHARDED`: A sharded cluster where each shard is a standalone instance. No shards are replica sets. `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	{
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 つのクラスターを更新

必須のロール

リクエスト

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

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

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

応答

応答パラメータ

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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