9.2. API エンドポイント

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

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

9.2.1. /apis/coordination.k8s.io/v1/leases

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

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

9.2.2. /apis/coordination.k8s.io/v1/watch/leases

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

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

9.2.3. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

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

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

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

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

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

HTTP メソッド: POST
説明: リースを作成する

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

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

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

9.2.4. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases

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

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

9.2.5. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

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

HTTP メソッド: DELETE
説明: リースを削除する

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

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

HTTP メソッド: GET
説明: 指定されたリースを読む

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

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

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

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

HTTP メソッド: PUT
説明: 指定されたリースを交換してください

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

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

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

9.2.6. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}

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

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

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

9.2. API エンドポイント

9.2.1. /apis/coordination.k8s.io/v1/leases

9.2.2. /apis/coordination.k8s.io/v1/watch/leases

9.2.3. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

9.2.4. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases

9.2.5. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

9.2.6. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links