第12章 Red Hat Quay API の使用

Red Hat Quay は、以下の完全な OAuth 2 RESTful API を提供します。

  • URL https://<yourquayhost>/api/v1 で各 Red Hat Quay インスタンスのエンドポイントから利用できます。
  • Swagger UI を有効にして Red Hat Quay 設定を取得し、削除し、送信し、配置できるようにブラウザーでエンドポイントに接続できます。
  • API 呼び出しを実行し、OAuth トークンを使用するアプリケーションからアクセスできます。
  • JSON としてデータを送受信します。

以下では、Red Hat Quay API にアクセスし、これを使用して Red Hat Quay クラスターで設定を表示し、変更する方法を説明します。付録 A には API エンドポイントが一覧表示され、これらについて説明されています。

12.1. Quay.io から Quay API へのアクセス

独自の Red Hat Quay クラスターがまだ実行中でない場合は、Web ブラウザーから Quay.io で利用可能な Red Hat Quay API を確認できます。

https://docs.quay.io/api/swagger/

表示される API Explorer には Quay.io API エンドポイントが表示されます。スーパーユーザー API エンドポイントや (リポジトリーミラーリングなど) Quay.io で有効にされていない Red Hat Quay 機能のエンドポイントは表示されません。

API Explorer から、以下の情報を取得したり、変更したりすることが可能です。

  • Billing (請求)、サブスクリプション、Plan (計画)
  • リポジトリービルドおよびビルドトリガー
  • エラーメッセージおよびグローバルメッセージ
  • リポジトリーイメージ、マニフェスト、パーミッション、通知、脆弱性およびイメージの署名
  • 使用ログ
  • 組織、メンバーおよび OAuth アプリケーション
  • ユーザーおよびロボットアカウント
  • その他

これを選択してエンドポイントを開き、エンドポイントの各部分の Model Schema を表示します。エンドポイントを開き、必要なパラメーター (リポジトリー名やイメージなど) を入力し、「Try it out!」ボタンを選択して Quay.io エンドポイントに関連する設定をクエリーするか、または変更します。