Red Hat Summitプロジェクト API
プロジェクト API のリファレンスガイド
概要
第1章 プロジェクト API
1.1. Project [project.openshift.io/v1]
- 説明
プロジェクトは、OpenShift の分離とコラボレーションの単位です。プロジェクトには、1 つ以上のメンバー、プロジェクトが消費する可能性のあるリソースの割り当て、およびプロジェクト内のリソースのセキュリティー制御があります。プロジェクト内では、メンバーはさまざまなロールを持つ場合があります。プロジェクト管理者はメンバーシップを設定でき、編集者はリソースを作成および管理でき、閲覧者は実行中のコンテナーを表示できますがアクセスできません。通常のクラスタープロジェクトでは、管理者はクォータを変更できません。これはクラスター管理者に制限されています。
プロジェクトをリスト表示または監視すると、ユーザーがリーダーのロールを果たしているプロジェクトのみが返されます。
OpenShift プロジェクトは、Kubernetes namespace の代替表現です。プロジェクトはエンドユーザーに編集可能として公開されますが、namespace は公開されません。プロジェクトの直接作成は通常、管理者に制限されていますが、エンドユーザーは requestproject リソースを使用する必要があります。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.2. ProjectRequest [project.openshift.io/v1]
- 説明
ProjectRequest は、プロジェクトリクエストを完全に認定するために必要なオプションのセットです。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
第2章 Project [project.openshift.io/v1]
- 説明
プロジェクトは、OpenShift の分離とコラボレーションの単位です。プロジェクトには、1 つ以上のメンバー、プロジェクトが消費する可能性のあるリソースの割り当て、およびプロジェクト内のリソースのセキュリティー制御があります。プロジェクト内では、メンバーはさまざまなロールを持つ場合があります。プロジェクト管理者はメンバーシップを設定でき、編集者はリソースを作成および管理でき、閲覧者は実行中のコンテナーを表示できますがアクセスできません。通常のクラスタープロジェクトでは、管理者はクォータを変更できません。これはクラスター管理者に制限されています。
プロジェクトをリスト表示または監視すると、ユーザーがリーダーのロールを果たしているプロジェクトのみが返されます。
OpenShift プロジェクトは、Kubernetes namespace の代替表現です。プロジェクトはエンドユーザーに編集可能として公開されますが、namespace は公開されません。プロジェクトの直接作成は通常、管理者に制限されていますが、エンドユーザーは requestproject リソースを使用する必要があります。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
2.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| ProjectSpec は、プロジェクトの属性を記述します。 |
|
|
| ProjectStatus は、プロジェクトの現在のステータスに関する情報です。 |
2.1.1. .spec
- 説明
- ProjectSpec は、プロジェクトの属性を記述します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ファイナライザーは、ストレージからオブジェクトを完全に削除するために空にする必要がある値の不透明なリストです。 |
2.1.2. .status
- 説明
- ProjectStatus は、プロジェクトの現在のステータスに関する情報です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| プロジェクトの現在の状態として観察される最新の状態を表します。 | |
|
|
| フェーズは、プロジェクトの現在のライフサイクルフェーズです。
使用可能な列挙値: - |
2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/project.openshift.io/v1/projects-
GET: プロジェクトの種類のオブジェクトをリスト表示または監視します。 -
POST: プロジェクトを作成します。
-
/apis/project.openshift.io/v1/watch/projects-
GET: プロジェクトのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/project.openshift.io/v1/projects/{name}-
DELETE: プロジェクトを削除します。 -
GET: 指定されたプロジェクトを読み取ります。 -
PATCH: 指定されたプロジェクトを部分的に更新します。 -
PUT: 指定されたプロジェクトを置き換えます。
-
/apis/project.openshift.io/v1/watch/projects/{name}-
GET: プロジェクトの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
2.2.1. /apis/project.openshift.io/v1/projects
- HTTP メソッド
-
GET - 説明
- プロジェクトの種類のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- プロジェクトを作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
2.2.2. /apis/project.openshift.io/v1/watch/projects
- HTTP メソッド
-
GET - 説明
- プロジェクトのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
2.2.3. /apis/project.openshift.io/v1/projects/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| プロジェクトの名前 |
- HTTP メソッド
-
DELETE - 説明
- プロジェクトを削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたプロジェクトを読みます。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたプロジェクトを部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたプロジェクトを置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
2.2.4. /apis/project.openshift.io/v1/watch/projects/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| プロジェクトの名前 |
- HTTP メソッド
-
GET - 説明
- プロジェクトの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第3章 ProjectRequest [project.openshift.io/v1]
- 説明
ProjectRequest は、プロジェクトリクエストを完全に認定するために必要なオプションのセットです。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
3.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| 説明は、プロジェクトに適用する説明です。 |
|
|
| DisplayName は、プロジェクトに適用する表示名です。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 |
3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/project.openshift.io/v1/projectrequests-
GET: 種類 ProjectRequest のオブジェクトをリスト表示します。 -
POST:ProjectRequest を作成します。
-
3.2.1. /apis/project.openshift.io/v1/projectrequests
- HTTP メソッド
-
GET - 説明
- ProjectRequest の種類のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ProjectRequest を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}