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' パラメーターで単一の項目にフィルター処理します。

8.2.1. /api/v1/secrets

HTTP メソッド: GET
説明: Secret の種類のオブジェクトをリストまたは監視する

表8.1 HTTP 応答
HTTP コード	応答本文
200 - OK	`SecretList` スキーマ
401 - Unauthorized	空白

8.2.2. /api/v1/watch/secrets

HTTP メソッド: GET
説明: Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。

表8.2 HTTP 応答
HTTP コード	応答本文
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

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

HTTP メソッド: DELETE
説明: Secret のコレクションを削除します

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

表8.4 HTTP 応答
HTTP コード	応答本文
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: Secret の種類のオブジェクトをリストまたは監視する

表8.5 HTTP 応答
HTTP コード	応答本文
200 - OK	`SecretList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: シークレットの作成

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

表8.7 本文パラメーター
パラメーター	タイプ	説明
`body`	`Secret` スキーマ

表8.8 HTTP 応答
HTTP コード	応答本文
200 - OK	`Secret` スキーマ
201 - Created	`Secret` スキーマ
202 - Accepted	`Secret` スキーマ
401 - Unauthorized	空白

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

HTTP メソッド: GET
説明: Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。

表8.9 HTTP 応答
HTTP コード	応答本文
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

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

表8.10 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	シークレットの名前

HTTP メソッド: DELETE
説明: シークレットの削除

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

表8.12 HTTP 応答
HTTP コード	応答本文
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された Secret を読み込む

表8.13 HTTP 応答
HTTP コード	応答本文
200 - OK	`Secret` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された Secret を部分的に更新する

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

表8.15 HTTP 応答
HTTP コード	応答本文
200 - OK	`Secret` スキーマ
201 - Created	`Secret` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された Secret を置き換える

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

表8.17 本文パラメーター
パラメーター	タイプ	説明
`body`	`Secret` スキーマ

表8.18 HTTP 応答
HTTP コード	応答本文
200 - OK	`Secret` スキーマ
201 - Created	`Secret` スキーマ
401 - Unauthorized	空白

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

表8.19 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	シークレットの名前

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

表8.20 HTTP 応答
HTTP コード	応答本文
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

8.2. API エンドポイント

8.2.1. /api/v1/secrets

8.2.2. /api/v1/watch/secrets

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

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

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

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

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links