4.2. API エンドポイント

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

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

4.2.1. /apis/template.openshift.io/v1/templates

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

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

4.2.2. /apis/template.openshift.io/v1/watch/templates

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

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

4.2.3. /apis/template.openshift.io/v1/namespaces/{namespace}/templates

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

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

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

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

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

HTTP メソッド: POST
説明: テンプレートを作成します。

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

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

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

4.2.4. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates

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

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

4.2.5. /apis/template.openshift.io/v1/namespaces/{namespace}/templates/{name}

表4.10 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	Template の名前

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

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

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

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

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

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

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

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

HTTP メソッド: PUT
説明: 指定されたテンプレートを置き換える

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

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

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

4.2.6. /apis/template.openshift.io/v1/namespaces/{namespace}/processedtemplates

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

HTTP メソッド: POST
説明: テンプレートを作成します。

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

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

4.2.7. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates/{name}

表4.22 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	Template の名前

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

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

4.2. API エンドポイント

4.2.1. /apis/template.openshift.io/v1/templates

4.2.2. /apis/template.openshift.io/v1/watch/templates

4.2.3. /apis/template.openshift.io/v1/namespaces/{namespace}/templates

4.2.4. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates

4.2.5. /apis/template.openshift.io/v1/namespaces/{namespace}/templates/{name}

4.2.6. /apis/template.openshift.io/v1/namespaces/{namespace}/processedtemplates

4.2.7. /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates/{name}

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links