26.2. VolumeSnapshot [snapshot.storage.k8s.io/v1]


説明
VolumeSnapshot は、永続ボリュームのポイントインタイムスナップショットを作成するか、既存のスナップショットにバインドするためのユーザーの要求です。
タイプ
object
必須
  • spec

26.2.1. 仕様

プロパティー説明

apiVersion

string

APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。更新はできません。キャメルケースを使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

spec は、ユーザーが要求するスナップショットの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots 必須。

status

object

status は、スナップショットの現在の情報を表します。コンシューマーは、このオブジェクトを使用する前に、VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの間のバインドが成功したことを (VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの両方が相互にポイントしていることを検証して) 確認する必要があります。

26.2.1.1. .spec

説明
spec は、ユーザーが要求するスナップショットの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots 必須。
タイプ
object
必須
  • source
プロパティー説明

source

object

source は、スナップショットの作成元を指定します。このフィールドは、作成後は不変です。必須。

volumeSnapshotClassName

string

VolumeSnapshotClassName は、VolumeSnapshot によって要求された VolumeSnapshotClass の名前です。VolumeSnapshotClassName は、デフォルトの SnapshotClass を使用する必要があることを示すために nil のままにすることができます。特定のクラスターには、複数のデフォルトの Volume SnapshotClasses がある場合があります。CSI ドライバーごとに 1 つのデフォルトです。VolumeSnapshot が SnapshotClass を指定しない場合、VolumeSnapshotSource がチェックされ、関連付けられた CSI ドライバーが何であるかが把握され、その CSI ドライバーに関連付けられたデフォルトの VolumeSnapshotClass が使用されます。特定の CSI ドライバーに複数の VolumeSnapshotClass が存在し、複数がデフォルトとしてマークされている場合、CreateSnapshot は失敗し、イベントを生成します。このフィールドには空の文字列は使用できません。

26.2.1.2. .spec.source

説明
source は、スナップショットの作成元を指定します。このフィールドは、作成後は不変です。必須。
タイプ
object
プロパティー説明

persistentVolumeClaimName

string

persistVolumeClaimName は、スナップショットの作成元となるボリュームを表す PersistentVolumeClaim オブジェクトの名前を指定します。この PVC は、VolumeSnapshot オブジェクトと同じ名前空間にあると見なされます。スナップショットが存在せず、作成する必要がある場合は、このフィールドを設定する必要があります。このフィールドは不変です。

volumeSnapshotContentName

string

volumeSnapshotContentName は、既存のボリュームスナップショットを表す既存の VolumeSnapshotContent オブジェクトの名前を指定します。スナップショットがすでに存在し、Kubernetes での表現のみが必要な場合は、このフィールドを設定する必要があります。このフィールドは不変です。

26.2.1.3. .status

説明
status は、スナップショットの現在の情報を表します。コンシューマーは、このオブジェクトを使用する前に、VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの間のバインドが成功したことを (VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの両方が相互にポイントしていることを検証して) 確認する必要があります。
タイプ
object
プロパティー説明

boundVolumeSnapshotContentName

string

boundVolumeSnapshotContentName は、この VolumeSnapshot オブジェクトがバインドしようとしている VolumeSnapshotContent オブジェクトの名前です。指定しない場合は、VolumeSnapshot オブジェクトが VolumeSnapshotContent オブジェクトに正常にバインドされていないことを示します。注: セキュリティーの問題を回避するために、コンシューマーは、このオブジェクトを使用する前に、VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの間のバインドが成功したことを (VolumeSnapshot オブジェクトと VolumeSnapshotContent オブジェクトの両方が相互にポイントしていることを検証して) 確認する必要があります。

creationTime

string

creationTime は、基盤となるストレージシステムによってポイントインタイムスナップショットが取得されたときのタイムスタンプです。動的スナップショットを作成する場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "creation_time" 値がスナップショットコントローラーによって入力されます。既存のスナップショットで、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "creation_time" 値が入力されます。指定しない場合は、スナップショットの作成時刻が不明であることを示している可能性があります。

error

object

error は、スナップショットの作成中に最後に観察されたエラーです (存在する場合)。このフィールドは、報告されたエラーのタイプに基づいて、スナップショットが作成されるのを待機し続けるかどうかを決定するために、上位レベルのコントローラー (つまり、アプリケーションコントローラー) に役立つ場合があります。スナップショットの作成中にエラーが発生した場合、スナップショットコントローラーは再試行を続けます。成功すると、このエラーフィールドはクリアされます。

readyToUse

boolean

readyToUse は、スナップショットを使用してボリュームを復元する準備ができているかどうかを示します。動的スナップショット作成の場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "ready_to_use" 値がスナップショットコントローラーによって入力されます。既存のスナップショットの場合、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "ready_to_use" 値が入力されます。サポートされていない場合、このフィールドは True に設定されます。指定しない場合は、スナップショットの準備状態が不明であることを意味します。

restoreSize

integer-or-string

restoreSize は、このスナップショットからボリュームを作成するのに必要なボリュームの最小サイズを表します。動的スナップショット作成の場合、このフィールドには、CSI "CreateSnapshot" gRPC 呼び出しから返された "size_bytes" 値がスナップショットコントローラーによって入力されます。既存のスナップショットで、ドライバーがサポートしている場合、このフィールドには CSI "ListSnapshots" gRPC 呼び出しから返される "size_bytes" 値が入力されます。このスナップショットからボリュームを復元する場合、ボリュームのサイズは、指定されている場合は restoreSize より小さくしてはなりません。小さくしないと、復元が失敗します。指定しない場合は、サイズが不明であることを示します。

26.2.1.4. .status.error

説明
error は、スナップショットの作成中に最後に観察されたエラーです (存在する場合)。このフィールドは、報告されたエラーのタイプに基づいて、スナップショットが作成されるのを待機し続けるかどうかを決定するために、上位レベルのコントローラー (つまり、アプリケーションコントローラー) に役立つ場合があります。スナップショットの作成中にエラーが発生した場合、スナップショットコントローラーは再試行を続けます。成功すると、このエラーフィールドはクリアされます。
タイプ
object
プロパティー説明

message

string

message は、指定されている場合、スナップショットの作成中に発生したエラーの詳細を示す文字列です。注: メッセージはログに記録される可能性があり、機密情報を含めることはできません。

time

string

time は、エラーが発生したときのタイムスタンプです。

26.2.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/snapshot.storage.k8s.io/v1/volumesnapshots

    • GET: VolumeSnapshot 種類のオブジェクトをリスト表示する
  • /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots

    • DELETE: VolumeSnapshot のコレクションを削除する
    • GET: VolumeSnapshot 種類のオブジェクトをリスト表示する
    • POST:VolumeSnapshot を作成する
  • /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}

    • DELETE: VolumeSnapshot を削除する
    • GET: 指定された VolumeSnapshot を読み取ります。
    • PATCH: 指定された VolumeSnapshot を部分更新します。
    • PUT: 指定された VolumeSnapshot を置き換えます。
  • /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}/status

    • GET: 指定された VolumeSnapshot の状態を読み取ります。
    • PATCH: 指定された VolumeSnapshot の部分更新状況です。
    • PUT: 指定された VolumeSnapshot の状態の置き換えます。

26.2.2.1. /apis/snapshot.storage.k8s.io/v1/volumesnapshots

表26.1 グローバルクエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
説明
VolumeSnapshot 種類のオブジェクトをリスト表示する
表26.2 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshotList スキーマ

401 - Unauthorized

空白

26.2.2.2. /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots

表26.3 グローバルパスパラメーター
パラメーター説明

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

表26.4 グローバルクエリーパラメーター
パラメーター説明

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
VolumeSnapshot のコレクションを削除する
表26.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

表26.6 HTTP 応答
HTTP コード応答本文

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
VolumeSnapshot 種類のオブジェクトをリスト表示する
表26.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

表26.8 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshotList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
VolumeSnapshot の作成
表26.9 クエリーパラメーター
パラメーター説明

dryRun

string

これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表26.10 本文パラメーター
パラメーター説明

body

VolumeSnapshot スキーマ

 
表26.11 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshot スキーマ

201 - Created

VolumeSnapshot スキーマ

202 - Accepted

VolumeSnapshot スキーマ

401 - Unauthorized

空白

26.2.2.3. /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}

表26.12 グローバルパスパラメーター
パラメーター説明

name

string

VolumeSnapshot の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

表26.13 グローバルクエリーパラメーター
パラメーター説明

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
VolumeSnapshot の削除
表26.14 クエリーパラメーター
パラメーター説明

dryRun

string

これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合は、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定できません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

表26.15 本文パラメーター
パラメーター説明

body

DeleteOptions スキーマ

 
表26.16 HTTP 応答
HTTP コード応答本文

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された VolumeSnapshot の読み取り
表26.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

表26.18 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshot スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された VolumeSnapshot の部分更新
表26.19 クエリーパラメーター
パラメーター説明

dryRun

string

これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

force

boolean

Force は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。

表26.20 本文パラメーター
パラメーター説明

body

Patch スキーマ

 
表26.21 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshot スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された VolumeSnapshot を置き換えます。
表26.22 クエリーパラメーター
パラメーター説明

dryRun

string

これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表26.23 本文パラメーター
パラメーター説明

body

VolumeSnapshot スキーマ

 
表26.24 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshot スキーマ

201 - Created

VolumeSnapshot スキーマ

401 - Unauthorized

空白

26.2.2.4. /apis/snapshot.storage.k8s.io/v1/namespaces/{namespace}/volumesnapshots/{name}/status

表26.25 グローバルパスパラメーター
パラメーター説明

name

string

VolumeSnapshot の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

表26.26 グローバルクエリーパラメーター
パラメーター説明

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された VolumeSnapshot の状態を読み取る
表26.27 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

表26.28 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshot スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された VolumeSnapshot の部分更新状況
表26.29 クエリーパラメーター
パラメーター説明

dryRun

string

これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

force

boolean

Force は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。

表26.30 本文パラメーター
パラメーター説明

body

Patch スキーマ

 
表26.31 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshot スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された VolumeSnapshot の状態の置き換え
表26.32 クエリーパラメーター
パラメーター説明

dryRun

string

これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表26.33 本文パラメーター
パラメーター説明

body

VolumeSnapshot スキーマ

 
表26.34 HTTP 応答
HTTP コード応答本文

200 - OK

VolumeSnapshot スキーマ

201 - Created

VolumeSnapshot スキーマ

401 - Unauthorized

空白

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.