設定 Satellite API
使用 IBM Cloud Satellite API,可自動化處理混合雲與多雲環境中各據點、主機及叢集的配置與管理。
IBM Cloud Satellite 與 IBM Cloud Kubernetes Service 和 Red Hat OpenShift on IBM Cloud共用相同的應用程式設計介面 (API),以便您可以使用相同的方法來一致地建立及管理 Satellite 資源。
關於 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:代表性狀態傳輸(REST),其重點在於您透過 HTTP 方法與之互動的資源,例如
GET、POST、PUT、PATCH以及DELETE。 - v2 API:遠端程序呼叫( RPC ),其操作僅限於
GET、POST及 HTTP 這三種方法。 GET回應- v1 API:針對資源集合(例如
GET v1/clusters)呼叫的GET方法,會針對清單中的每個資源回傳與針對單一資源(例如GET v1/clusters/{idOrName})呼叫GET方法時相同的詳細資訊。 - v2 API:為了加快回應速度,針對資源集合(例如
GET v2/clusters)所呼叫的 v2GET方法,僅會回傳部分資訊;而針對單一資源(例如GET v2/clusters/{idOrName})所呼叫的GET方法,則會提供更詳細的資訊。 一些清單回應包含 provider 內容,用於確定傳回的項目是適用於標準還是 VPC 基礎架構。 例如,GET zones清單傳回的結果中,一些結果(如mon01)僅在標準基礎架構提供者中提供,而另一些結果(如us-south-01)僅在 VPC 基礎架構提供者中提供。 - 叢集、工作者節點和工作者節點儲存區回應
- 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}}