26.8. シークレット [v1]


Description
Secret は特定のタイプのシークレットデータを保持します。Data フィールドの値の合計バイト数は MaxSecretSize バイト未満である必要があります。
タイプ
object

26.8.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

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

data

object (string)

data にはシークレットデータが含まれます。各キーは英数字、'-'、'_'、または '.' で設定される必要があります。シークレットデータのシリアライズ形式は base64 でエンコードされた文字列で、ここでは任意 (文字列以外の場合あり) のデータ値を表します。詳細は https://tools.ietf.org/html/rfc4648#section-4 を参照してください。

immutable

boolean

true に設定されていない場合、シークレットに保存されているデータを更新できなくなります (オブジェクトメタデータのみを変更できます)。true に設定されていない場合、いつでもフィールドを変更できます。デフォルトは nil です。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase詳細については、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 を参照してください。

stringData

object (string)

stringData では、バイナリー以外のシークレットデータを文字列形式で指定できます。便宜上、書き込み専用の入力フィールドとして提供されています。すべてのキーと値は書き込み時にデータフィールドにマージされ、既存の値を上書きします。API から読み取るときに、stringData フィールドが出力されることはありません。

type

string

シークレットデータのプログラムによる処理を容易にするために使用されます。

26.8.2. API エンドポイント

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

  • /api/v1/secrets

    • GET: Secret の種類のオブジェクトをリストまたは監視する。
  • /api/v1/watch/secrets

    • GET: Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
  • /api/v1/namespaces/{namespace}/secrets

    • DELETE: Secret のコレクションを削除する
    • GET: Secret の種類のオブジェクトをリストまたは監視する。
    • POST: シークレットを作成する
  • /api/v1/watch/namespaces/{namespace}/secrets

    • GET: Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
  • /api/v1/namespaces/{namespace}/secrets/{name}

    • DELETE: Secret を削除する
    • GET: 指定された Secret を読み込みます。
    • PATCH: 指定された Secret を部分的に更新します。
    • PUT: 指定された Secret を置き換えます。
  • /api/v1/watch/namespaces/{namespace}/secrets/{name}

    • GET: Secret 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。

26.8.2.1. /api/v1/secrets

Expand
表26.117 グローバルクエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

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

HTTP メソッド
GET
Description
Secret の種類のオブジェクトをリストまたは監視する
Expand
表26.118 HTTP 応答
HTTP コードレスポンス本文

200 - OK

SecretList スキーマ

401 - Unauthorized

空白

26.8.2.2. /api/v1/watch/secrets

Expand
表26.119 グローバルクエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

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

HTTP メソッド
GET
Description
Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
Expand
表26.120 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

26.8.2.3. /api/v1/namespaces/{namespace}/secrets

Expand
表26.121 グローバルパスパラメーター
パラメータータイプ説明

namespace

string

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

Expand
表26.122 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
Secret のコレクションを削除します
Expand
表26.123 クエリーパラメーター
パラメータータイプ説明

continue

string

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

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

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldSelector

string

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

gracePeriodSeconds

integer

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

labelSelector

string

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

limit

integer

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

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

orphanDependents

boolean

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

propagationPolicy

string

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

Expand
表26.124 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions スキーマ

 
Expand
表26.125 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
Secret の種類のオブジェクトをリストまたは監視する
Expand
表26.126 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

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

Expand
表26.127 HTTP 応答
HTTP コードレスポンス本文

200 - OK

SecretList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
シークレットの作成
Expand
表26.128 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

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

Expand
表26.129 ボディパラメーター
パラメータータイプ説明

body

Secret スキーマ

 
Expand
表26.130 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Secret スキーマ

201 - Created

Secret スキーマ

202 - Accepted

Secret スキーマ

401 - Unauthorized

空白

26.8.2.4. /api/v1/watch/namespaces/{namespace}/secrets

Expand
表26.131 グローバルパスパラメーター
パラメータータイプ説明

namespace

string

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

Expand
表26.132 グローバルクエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

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

HTTP メソッド
GET
Description
Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
Expand
表26.133 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

26.8.2.5. /api/v1/namespaces/{namespace}/secrets/{name}

Expand
表26.134 グローバルパスパラメーター
パラメータータイプ説明

name

string

シークレットの名前

namespace

string

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

Expand
表26.135 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
シークレットの削除
Expand
表26.136 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

Expand
表26.137 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions スキーマ

 
Expand
表26.138 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された Secret を読み込む
Expand
表26.139 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Secret スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された Secret を部分的に更新する
Expand
表26.140 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

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

force

boolean

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

Expand
表26.141 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表26.142 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Secret スキーマ

201 - Created

Secret スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された Secret を置き換える
Expand
表26.143 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

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

Expand
表26.144 ボディパラメーター
パラメータータイプ説明

body

Secret スキーマ

 
Expand
表26.145 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Secret スキーマ

201 - Created

Secret スキーマ

401 - Unauthorized

空白

26.8.2.6. /api/v1/watch/namespaces/{namespace}/secrets/{name}

Expand
表26.146 グローバルパスパラメーター
パラメータータイプ説明

name

string

シークレットの名前

namespace

string

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

Expand
表26.147 グローバルクエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

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

HTTP メソッド
GET
Description
Secret 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
Expand
表26.148 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat