API について

Satellite API は、ユーザーにサービスを提供するために必要なコンピュート、ネットワーキング、およびストレージのリソースをアプリが得られるように、クラスターの IBM Cloud インフラストラクチャー・リソースのプロビジョニングと管理を自動化します。

この API は、クラスターおよびリソースを作成するために使用可能なさまざまなインフラストラクチャー・プロバイダーをサポートします。 v2 API は、可能な限り既存の機能を壊さないように設計されています。 しかし、次に示す v1 と v2 の API の違いを確認してください。

API エンドポイント・プレフィックス

v1 API: https://containers.cloud.ibm.com/global/v1

v2 API: https://containers.cloud.ibm.com/global/v2

API リファレンス資料

v1 API: https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2

v2 API： https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2

API アーキテクチャー・スタイル

v1 API: GET、POST、PUT、PATCH、DELETE などの HTTP メソッドを介して対話するリソースに焦点を当てた Representational State Transfer (REST)。

v2 API: HTTP メソッド GET および POST のみを介したアクションに焦点を当てたリモート・プロシージャー・コール (RPC)。

GET 応答

v1 API: リソース (GET v1/clusters など) の集合用の GET メソッドは、リスト内の各リソースについて、個々のリソース (GET v1/clusters/{idOrName} など) 用の GET メソッドと同じ詳細情報を返します。

v2 API: 応答をより迅速に返すために、リソース (GET v2/clusters など) のコレクション用の v2 GET メソッドは、個々のリソース (GET v2/clusters/{idOrName}など) 用の GET メソッドで詳述される情報のサブセットのみを返します。 一部のリスト応答には、返された項目がクラシック・インフラストラクチャーと VPC インフラストラクチャーのどちらに該当するかを示すプロバイダー・プロパティーが含まれています。 例えば、GET zones リストでは、クラシック・インフラストラクチャー・プロバイダーでのみ利用できる mon01 のような結果が返されることもあれば、VPC インフラストラクチャー・プロバイダーでのみ利用できる us-south-01 のような結果が返されることもあります。

クラスター、ワーカー・ノード、およびワーカー・プールの応答

v1 API: 応答には、GET クラスター内の VLAN やワーカー応答など、クラシック・インフラストラクチャー・プロバイダーに固有の情報のみが含まれます。

v2 API: 返される情報は、インフラストラクチャー・プロバイダーによって異なります。 そのようなプロバイダー固有の応答の場合は、要求にプロバイダーを指定できます。 例えば、VPC クラスターには VLAN がないため、VLAN 情報は返されません。 代わりに、サブネットや CIDR ネットワークの情報を返します。

{{../iam/iam-apikeys.md#work-with-apikeys}}

{{../iam/iam-apikey_iamtoken.md#iamtoken}}

{{../iam/iam-apikeys_services.md#token_auth}}

{{../iam/iam-apikeys_services.md#apikey_auth}}