IBM Cloud Docs
设置 API

设置 API

IBM Cloud Satellite 与 IBM Cloud Kubernetes Service 和 Red Hat OpenShift on IBM Cloud共享相同的应用程序编程接口 (API),以便您可以使用相同的方法来一致地创建和管理 Satellite 资源。

关于 API

Satellite应用程序接口API 可自动为集群调配和管理IBM Cloud基础设施资源,从而使您的应用程序拥有为用户提供服务所需的计算、网络和存储资源。

API 支持可用于创建集群和资源的不同基础架构提供者。 v2 API 旨在尽可能避免现有功能中断。 但是,请确保查看 v1v2 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 体系结构样式
v1API:表示状态传输 (REST):侧重于通过 HTTP 方法(如 "GET、"POST、"PUT、"PATCH"和 "DELETE)进行交互的资源。
v2API:远程过程调用 (RPC),仅通过“GET 和”POST HTTP 方法进行操作。
GET 响应
v1API:资源集合(如 "GET v1/clusters)的“GET 方法返回列表中每个资源的详细信息,与单个资源(如 "GET v1/clusters/{idOrName})的”GET 方法返回的详细信息相同。
v2应用程序接口:为了更快地返回响应,针对资源集合(如 "GET v2/clusters)的v2“GET 方法只返回在针对单个资源(如 "GET v2/clusters/{idOrName})的”GET 方法中详细说明的信息子集。 一些列表响应包含 provider 属性,用于确定返回的项是适用于经典还是 VPC 基础架构。 例如,GET zones 列表返回的结果中,一些结果(如 mon01)仅在经典基础架构提供者中提供,而另一些结果(如 us-south-01)仅在 VPC 基础架构提供者中提供。
集群、工作程序节点和工作程序池响应
v1API:响应只包括经典基础架构提供商特有的信息,如 "GET 群集中的 VLAN 和 Worker 响应。
v2API:返回的信息因基础设施提供商而异。 对于此类特定于提供者的响应,可以在请求中指定提供者。 例如,VPC 集群不会返回 VLAN 信息,因为它们没有 VLAN。 这些集群会改为返回子网和 CIDR 网络信息。

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

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

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

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