リソースとエンドポイント
Astra Control REST API のリソースを使用すると、 Astra の導入を自動化できます。各リソースは、 1 つ以上のエンドポイントを介してアクセスされます。以下に、自動化導入の一環として使用できる REST リソースの概要を示します。
Astra Control リソースへのアクセスに使用されるパスと完全な URL の形式は、いくつかの値に基づいています。を参照してください "URL 形式" を参照してください。も参照してください "API リファレンス" Astra のリソースとエンドポイントの使用方法の詳細については、を参照してください。 |
Astra Control REST リソースの要約
Astra Control REST API に用意されているプライマリリソースエンドポイントは、 3 つのカテゴリに分類されています。各リソースは、特定の場所を除いて、すべての CRUD 操作(作成、読み取り、更新、削除)を使用してアクセスできます。
[* リリース *] 列は、リソースが最初に導入されたときのアストラリリースを示します。このフィールドは、現在のリリースで新しく追加されたリソースに対して太字で表示されます。
コアリソース
コアリソースエンドポイントは、 Astra ランタイム環境の確立と保守に必要な基盤サービスを提供します。
リソース | リリース。 | 説明 |
---|---|---|
アカウント: |
21.12 |
アカウントリソースを使用すると、マルチテナント Astra Control 導入環境内の分離されたテナントを管理できます。 |
ASUP |
21.08 |
ASUP リソースには、ネットアップサポートに転送される AutoSupport バンドルが表示されます。 |
クレデンシャル |
21.04 |
クレデンシャルリソースには、 Astra ユーザ、クラスタ、バケット、ストレージバックエンドで使用できるセキュリティ関連の情報が含まれています。 |
使用権 |
21.08 |
使用権リソースは、アクティブなライセンスとサブスクリプションに基づいて、アカウントで使用可能な機能と容量を表します。 |
イベント |
21.04 |
イベントリソースは、通知として分類されたサブセットも含めて、システムで発生するすべてのイベントを表します。 |
実行フック |
21.12 |
実行フックリソースは、管理対象アプリケーションのスナップショットの実行前または実行後に実行できるカスタムスクリプトを表します。 |
フィーチャー( Feature ) |
21.08 |
機能リソースは、選択した Astra 機能を表します。この機能を照会することで、システムで有効になっているか無効になっているかを確認できます。アクセスは読み取り専用に制限されます。 |
フックソース |
21.12 |
フックソースリソースは、実行フックで使用される実際のソースコードを表します。ソースコードを実行コントロールから分離すると、スクリプトを共有できるようにするなど、いくつかの利点があります。 |
使用許諾 |
21.08 |
ライセンスリソースは、 Astra アカウントで使用可能なライセンスを表します。 |
通知 |
21.04 |
通知リソースは、通知の送信先を持つ Astra イベントを表します。アクセスはユーザ単位で提供されます。 |
パッケージ |
*22.04 * |
パッケージリソースは、パッケージ定義の登録とアクセスを提供します。ソフトウェアパッケージは、ファイル、イメージ、その他のアーティファクトなどのさまざまなコンポーネントで構成されます。 |
ロールのバインド |
21.04 |
ロールバインドリソースは ' 特定のユーザーとアカウントのペア間の関係を表します2 つの間のリンクに加えて、特定のロールを通じて各に一連の権限が指定されます。 |
設定 |
21.08 |
設定リソースは、特定のアストラアカウントの機能を説明するキーと値のペアの集まりです。 |
サブスクリプション。 |
21.08 |
サブスクリプションリソースは、 Astra アカウントのアクティブなサブスクリプションです。 |
トークン |
21.04 |
トークンリソースとは、プログラムによって Astra Control REST API にアクセスできるトークンのことです。 |
未読通知 |
21.04 |
未読通知リソースは、特定のユーザーに割り当てられているがまだ読み込まれていない通知を表します。 |
アップグレード |
*22.04 * |
アップグレードリソースを使用して、ソフトウェアコンポーネントにアクセスしたり、アップグレードを開始したりできます。 |
ユーザ |
21.04 |
ユーザリソースは、 Astra を使用するユーザで、定義したロールに基づいてシステムにアクセスできる。 |
アプリケーションリソースの管理
管理対象アプリケーションリソースエンドポイントは、管理対象の Kubernetes アプリケーションへのアクセスを提供します。
リソース | リリース。 | 説明 |
---|---|---|
アプリケーションアセット |
21.04 |
アプリケーションアセットリソースは、 Astra アプリケーションの管理に必要な状態情報の内部コレクションです。 |
アプリケーションのバックアップ |
21.04 |
アプリケーションのバックアップリソースは、管理対象アプリケーションのバックアップを表します。 |
アプリケーションスナップショット |
21.04 |
アプリケーションスナップショットリソースは、管理対象アプリケーションのスナップショットを表します。 |
実行フックのオーバーライド |
21.12 |
実行フックの上書きリソースを使用すると、特定のアプリケーションにプリインストールされているネットアップのデフォルトの実行フックを必要に応じて無効にできます。 |
マネージドアプリケーション |
21.04 |
マネージドアプリケーションリソースは、 Astra が管理する Kubernetes アプリケーションを表しています。 |
スケジュール |
21.04 |
スケジュールリソースとは、データ保護ポリシーの一部として管理対象アプリケーションにスケジュールされているデータ保護処理のことです。 |
トポロジリソース
トポロジリソースエンドポイントは、管理対象外のアプリケーションとストレージリソースへのアクセスを提供します。
リソース | リリース。 | 説明 |
---|---|---|
アプリケーション |
21.04 |
アプリケーションリソースは、 Astra が管理していないアプリケーションも含め、 Kubernetes のすべてのアプリケーションを表します。 |
バケット |
21.08 |
バケットリソースは、 Astra が管理するアプリケーションのバックアップを保存するために使用する S3 クラウドバケットです。 |
クラウド |
21.08 |
クラウドリソースとは、アストラクライアントから接続してクラスタやアプリケーションを管理できるクラウドのことです。 |
クラスタ |
21.08 |
クラスタリソースは Kubernetes で管理されない Kubernetes クラスタを表します。 |
クラスタノード |
21.12 |
クラスタノードリソースは、 Kubernetes クラスタ内の個々のノードにアクセスできるようにすることで、解決策を提供します。 |
管理対象クラスタ |
21.08 |
管理対象クラスタリソースは、 Kubernetes で現在管理されている Kubernetes クラスタを表します。 |
管理対象のストレージバックエンド |
21.12 |
管理対象のストレージバックエンドリソースを使用して、バックエンドストレージプロバイダの抽象化された表現にアクセスできます。これらのストレージバックエンドは、管理対象のクラスタやアプリケーションで使用できます。 |
ネームスペース |
21.12 |
ネームスペースリソースは、 Kubernetes クラスタ内で使用されるネームスペースへのアクセスを提供します。 |
ストレージバックエンド |
21.08 |
ストレージバックエンドリソースは、 Astra が管理するクラスタとアプリケーションで使用できるストレージサービスのプロバイダです。 |
ストレージクラス |
21.08 |
ストレージクラスのリソースは、さまざまなクラスやタイプのストレージを表しており、特定の管理対象クラスタで使用できます。 |
ボリューム |
21.04 |
ボリュームリソースは、管理対象アプリケーションに関連付けられた Kubernetes ストレージボリュームを表します。 |
現在のリリースの新しいエンドポイント
現行の 22.04 Astra Control リリースでは、次の REST エンドポイントが追加されています。また、いくつかの既存リソースのバージョンもアップグレードされています。
-
/accounts / { account_id } /core/v1/packages
-
/accounts / { account_id } /core/v1/packages/{ package_id }
-
/accounts / { account_id } /core/v1/upgrades
-
/accounts / { account_id } /core/v1/upgrades/{ upgrade_id }
-
/accounts/{account_id}/topology/v1/appBackups を指定します
-
/accounts / { account_id } /topology/v1/appBackups / { appBackup_id }
-
/accounts / { account_id } /topology/v1/clouds/{ cloud_id } /clusters/{ cluster_id } /clusterNodes
-
/accounts / { account_id } /topology/v1/clouds/{ cloud_id } /clusters/{ cluster_id } /clusterNodes / { clusternode_id }
-
/accounts / { account_id } /topology/v1/managedClusters / { managedCluster_id } /apps/{ app_id } /appAssets
-
/accounts / { account_id } /topology/v1/managedClusters / { managedCluster_id } /apps/{ APP_id } /appAssets/{ appAsset_id }
-
/accounts / { account_id } /topology/v1/managedClusters / { managedCluster_id } / clusterNodes
-
/accounts / { account_id } /topology/v1/managedClusters / { managedCluster_id } /clusterNodes / { clusternode_id }
その他のリソースとエンドポイント
Astra の導入をサポートするために使用できる追加のリソースとエンドポイントがいくつかあります。
これらのリソースとエンドポイントは、現在のところ、 Astra Control REST API リファレンスドキュメントに含まれていません。 |
- OpenAPI
-
OpenAPI エンドポイントは、現在の OpenAPI JSON ドキュメントおよびその他の関連リソースへのアクセスを提供します。
- OpenMetrics
-
OpenMetrics エンドポイントは、 OpenMetrics リソースを介してアカウントメトリックへのアクセスを提供します。サポートは、 Astra Control Center 導入モデルで利用できます。