ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot必要な権限
オンデマンドスナップショットを取得するには、Global Backup Admin が必要です。
Request Parameters
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
グループ ID | string | プロジェクト設定からのプロジェクトの一意の識別子。 |
CLUSTER-ID | string | スナップショットが表すクラスターの一意の識別子。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | 例 |
|---|---|---|---|---|
retentionDays | 数値 | 必須 | オンデマンド スナップショットが保持される日数を示す数値。0 より大きくする必要があります。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot?retentionDays=15"応答例
応答ヘッダー
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-aliveHTTP/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": "myCluster", "description": "On demand snapshot request complete .", "timestamp": { "increment": 1, "time": 1719518976, "date": "2024-06-27T20:09:36Z" }}