配置 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 应用程序接口:https://containers.cloud.ibm.com/global/v1
v2 应用程序接口:https://containers.cloud.ibm.com/global/v2
API 参考文档
v1 应用程序接口:https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2
v2 应用程序接口: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 方法(例如 GET v1/clusters )返回的每个资源的详细信息,与针对单个资源的 GET 方法(例如 GET v1/clusters/{idOrName} )返回的详细信息相同。
v2 API:为了更快地返回响应,针对一组资源(例如 GET v2/clusters )调用的 v2 GET 方法,仅返回部分信息;而针对单个资源(例如 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}}