/ /

/ /

1 つのスナップショットの有効期限を変更

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}

Request Parameters

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

名前	タイプ	説明
プロジェクトID	string	Unique identifier of the project that owns the snapshot.
CLUSTER-ID	string	スナップショットが表すクラスターの一意の識別子。
Snapshot-ID	string	スナップショットの一意の識別子。

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print にするかどうかを示すフラグ形式。

false

envelope

ブール値

任意

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

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

名前	タイプ	説明
doNotDelete	ブール値	スナップショットが削除できないことを示します。重要:同じリクエストで、 `doNotDelete`を`true`に設定し、 `expires`のタイムスタンプを設定することはできません。そうすると、 Cloud Managerは次のエラーを返します。 `Cannot modify snapshot because of invalid fields.`
expires	タイムスタンプ	The date in ISO 8601 date and time format at UTC after which this snapshot can be deleted. `doNotDelete`が`true`に設定されている場合、 `expires`内の既存の値はすべて削除されます。 `expires`が現在の日時より前のタイムスタンプに設定されている場合、Cloud Manager は次の機会にスナップショットを削除します。スナップショットがすぐに削除される保証はありません。現在の`expires`タイムスタンプがすでに経過している場合は編集できません。

応答

`Name`	タイプ	説明
`clusterId`	string	スナップショットが表すクラスターの一意の識別子。
`complete`	ブール値	スナップショットが作成されたことを示すフラグ。スナップショット作成ジョブがまだ進行中の場合、これは`false`です。
`created`	ドキュメント	Components of a timestamp.
`created` `.date`	タイムスタンプ	スナップショットが作成されたときの iso 8601 -time。
`created` `.increment`	integer	このスナップショットが正確な時点で実行された操作順序。 MongoDB でタイムスタンプの仕組みについては、「タイムスタンプ」を参照してください。
`doNotDelete`	ブール値	スナップショットが削除できないことを示すフラグ。
`expires`	タイムスタンプ	Timestamp in ISO 8601 date and time format in UTC at UTC after which this snapshot can be deleted. `doNotDelete`が`true`に設定されている場合、 `expires`のすべての値が削除されます。 `expires`値が現在の日時より前の場合、編集することはできません。
`groupId`	string	Unique identifier of the project that owns the snapshot.
`id`	string	スナップショットの一意の識別子。
`isPossibly` `Inconsistent`	ブール値	このスナップショットの整合性を示すフラグ。 `isPossiblyInconsistent`はシャーディングされたクラスターのスナップショットにのみ表示されます。 To take a snapshot of a sharded cluster in a consistent state, the Backup temporarily turns off the balancer before creating the snapshot. In some cases, it cannot turn off the balancer in a timely manner. The snapshot is then created with the balancer still running. こうした場合、スナップショットは一貫性のない状態になる可能性があります（たとえば、チャンクの移行が進行中である場合など）。
`lastOplog` `AppliedTimestamp`	ドキュメント	最後の oplog エントリのタイムスタンプのコンポーネントが適用されました。
`lastOplog` `AppliedTimestamp` `.date`	タイムスタンプ	最後のoplogが適用されたときの ISO 8601の日付と時刻形式（UTC）のタイムスタンプ（UTC）。
`lastOplog` `AppliedTimestamp` `.increment`	integer	Operation order in which last oplog was applied at this exact point in time. MongoDB でタイムスタンプの仕組みについては、「タイムスタンプ」を参照してください。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての `links` 配列には、`self` と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。
`namespaceFilterList`	オブジェクト	このスナップショットに含まれる名前空間または除外される名前空間。
`namespaceFilterList` `.filterList`	string 配列	スナップショットに排他的に含まれる、またはスナップショットから明示的に除外されるデータベースまたは名前空間の任意の組み合わせのコンマ区切りリスト。デフォルト値は空の配列（ `[]` ）です。
`namespaceFilterList` `.filterType`	string	このスナップショットで名前空間をフィルタリングする方法を決定するラベル。この値が`denyList`に設定されている場合、 `namespaceFilterList.filterList`の名前空間はスナップショットから除外されます。この値が`accessList`に設定されている場合、 `namespaceFilterList.filterList`の名前空間のみがスナップショットに含まれます。デフォルト値は `denyList` です。
`missingShards`	オブジェクトの配列	スナップショットが欠落しているシャードのリスト。 `missingShards`はシャーディングされたクラスターのスナップショットにのみ表示されます。 In steady state, this array is empty. If the Backup cannot connect to a shard when a snapshot is created, the shard is omitted from the snapshot. Each document in the array is a cluster document containing a `self` link.
`missingShards` `.id`	string	欠落しているシャードの一意の識別子。
`missingShards` `.groupId`	string	欠落しているシャードを所有するプロジェクトの一意の識別子。
`missingShards` `.typeName`	string	欠落しているシャードが表すサーバーのタイプは次のとおりです。 `CONFIG_SERVER_REPLICA_SET` `REPLICA_SET` `CONFIG_SHARD_REPLICA_SET`
`missingShards` `.clusterName`	string	欠落しているシャードのクラスターの名前。
`missingShards` `.shardName`	string	欠落しているシャードの名前。
`missingShards` `.replicaSetName`	string	欠落しているシャード内のレプリカセットの名前。
`missingShards` `.lastHeartbeat`	タイムスタンプ	欠落しているシャードから最後のハートビートが受信されたときの ISO 8601の日付と時刻形式（UTC）のタイムスタンプ（UTC）。
`parts`	オブジェクトの配列	完全なスナップショットを構成する個々の部分。レプリカセットの場合、この配列には 1 つのドキュメントが含まれます。シャーディングされたクラスターの場合、この配列にはシャードごとに 1 つのドキュメントとコンフィギュレーションサーバー用の 1 つのドキュメントが含まれます。
`parts` `.clusterId`	string	Unique identifier of the replica set.
`parts` `.compressionSetting`	string	スナップショットの圧縮方法。
`parts` `.dataSizeBytes`	数値	スナップショット内のデータの合計サイズ（バイト単位）。
`parts` `.encryptionEnabled`	ブール値	スナップショットデータの暗号化状態を示すインジケーター。
`parts` `.fileSizeBytes`	数値	データファイルの合計サイズ（バイト単位）。
`parts` `.masterKeyUUID`	string	KMIP master key ID used to encrypt the snapshot data. `parts.masterKeyUUID` appears only if this snapshot has `parts.encryptionEnabled : true`.
`parts` `.mongodVersion`	string	Version of `mongod` that the replica set primary was running when the snapshot was created.
`parts` `.replicaSetName`	string	Name of the replica set.
`parts` `.storageSizeBytes`	数値	ドキュメントストレージに割り当てられた領域の合計サイズ。
`parts` `.typeName`	string	部分が表すサーバーのタイプ。 `REPLICA_SET` `CONFIG_SERVER_REPLICA_SET` `CONFIG_SHARD_REPLICA_SET`

`links` 配列

links配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれています。 URL の関係は、 Web リンク仕様で説明されています

関係	説明
自己	このリソースの URL エンドポイント。

リクエストの例

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}/snapshots/{SNAPSHOT-ID}?pretty=true" \
     --data '
     {
       "doNotDelete": true
     }'

応答例

応答ヘッダー

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}

レスポンス本体

{
  "id" : "{SNAPSHOT-ID}",
  "CLUSTER-ID" : "{CLUSTER-ID}",
  "complete" : true,
  "created" : {
    "date" : "2014-07-09T15:24:37Z",
    "increment" : 1
  },
  "doNotDelete" : true,
  "GROUP-ID" : "{PROJECT-ID}",
  "lastOplogAppliedTimestamp" : {
    "date" : "2017-08-21T09:14:51Z",
    "increment" : 1
  },
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}",
   "rel" : "self"
  } ],
  "namespaceFilterList" : {
    "filterList" : [ ],
    "filterType" : "denyList"
  },
  "parts" : [ {
    "CLUSTER-ID" : "{CLUSTER-ID}",
    "dataSizeBytes" : 17344,
    "fileSizeBytes" : 67108864,
    "mongodVersion" : "2.6.3",
    "replicaSetName" : "rs0",
    "storageSizeBytes" : 10502144,
    "typeName" : "REPLICA_SET"
  } ],
}