13.2. API エンドポイント

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

/apis/batch/v1/jobs
- GET: Job 種類のオブジェクトをリスト表示または監視するロール
/apis/batch/v1/watch/jobs
- GET: Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/batch/v1/namespaces/{namespace}/jobs
- DELETE: Job のコレクションを削除します。
- GET: Job 種類のオブジェクトをリスト表示または監視するロール
- POST: ジョブを作成する
/apis/batch/v1/watch/namespaces/{namespace}/jobs
- GET: Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/batch/v1/namespaces/{namespace}/jobs/{name}
- DELETE: Job を削除する
- GET: 指定された Job を読み取ります。
- PATCH: 指定された Job を部分的に更新します。
- PUT: 指定された Job を置き換えます。
/apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
- GET: Job 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
- GET: 指定された Job のステータスを読み取ります。
- PATCH: 指定された Job のステータスを部分的に更新します。
- PUT: 指定された Job のステータスを置き換えます。

13.2.1. /apis/batch/v1/jobs

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

表13.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`JobList` スキーマ
401 - Unauthorized	空白

13.2.2. /apis/batch/v1/watch/jobs

HTTP メソッド: GET
説明: Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表13.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

13.2.3. /apis/batch/v1/namespaces/{namespace}/jobs

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

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

表13.4 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

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

表13.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`JobList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: Job を作成する

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

表13.7 ボディのパラメーター
パラメーター	型	説明
`body`	`Job` スキーマ

表13.8 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Job` スキーマ
201 - Created	`Job` スキーマ
202 - Accepted	`Job` スキーマ
401 - Unauthorized	空白

13.2.4. /apis/batch/v1/watch/namespaces/{namespace}/jobs

HTTP メソッド: GET
説明: Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表13.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

13.2.5. /apis/batch/v1/namespaces/{namespace}/jobs/{name}

表13.10 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	Job の名前

HTTP メソッド: DELETE
説明: Job を削除する

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

表13.12 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された Job を読み取る

表13.13 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Job` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された Job を部分的に更新します。

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

表13.15 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Job` スキーマ
201 - Created	`Job` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された Job を置き換えます。

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

表13.17 ボディのパラメーター
パラメーター	型	説明
`body`	`Job` スキーマ

表13.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Job` スキーマ
201 - Created	`Job` スキーマ
401 - Unauthorized	空白

13.2.6. /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}

表13.19 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	Job の名前

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

表13.20 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

13.2.7. /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

表13.21 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	Job の名前

HTTP メソッド: GET
説明: 指定された Job のステータスを読み取る

表13.22 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Job` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された Job のステータスを部分的に更新する

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

表13.24 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Job` スキーマ
201 - Created	`Job` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された Job のステータスを置き換える

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

表13.26 ボディのパラメーター
パラメーター	型	説明
`body`	`Job` スキーマ

表13.27 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Job` スキーマ
201 - Created	`Job` スキーマ
401 - Unauthorized	空白

13.2. API エンドポイント

13.2.1. /apis/batch/v1/jobs

13.2.2. /apis/batch/v1/watch/jobs

13.2.3. /apis/batch/v1/namespaces/{namespace}/jobs

13.2.4. /apis/batch/v1/watch/namespaces/{namespace}/jobs

13.2.5. /apis/batch/v1/namespaces/{namespace}/jobs/{name}

13.2.6. /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}

13.2.7. /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links