Configurando a API do Satellite

Utilize a API do IBM Cloud Satellite para automatizar o provisionamento e o gerenciamento de seus locais, hosts e clusters em ambientes híbridos e multicloud.

O IBM Cloud Satellite compartilha a mesma interface de programação de aplicativos (API) que o IBM Cloud Kubernetes Service e Red Hat OpenShift on IBM Cloud, para que seja possível usar os mesmos métodos para criar e gerenciar consistentemente seus recursos do Satellite.

Sobre a API

A API do Satellite automatiza o fornecimento e o gerenciamento de recursos da infraestrutura do IBM Cloud para seus clusters para que seus apps tenham os recursos de cálculo, rede e armazenamento que eles precisam para atender seus usuários.

A API suporta os diferentes provedores de infraestrutura disponíveis para você criar clusters e recursos. A API v2 foi projetada para evitar a quebra da funcionalidade existente quando possível. No entanto, certifique-se de revisar as diferenças a seguir entre as APIs da v1 e da v2.

Prefixo do terminal de API
API v1: https://containers.cloud.ibm.com/global/v1
API v2: https://containers.cloud.ibm.com/global/v2
Docs de referência da API
API v1: https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2
API v2: https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2
Estilo arquitetural da API
API v1: Representational State Transfer (REST) focada em recursos com os quais você interage através de métodos HTTP, tais como GET, POST, PUT, PATCH e DELETE.
API v2: chamada de procedimento remoto (RPC) focada em ações apenas por meio dos métodos HTTP GET e POST.
Respostas de GET
API v1: o método GET para uma coleção de recursos (como GET v1/clusters) retorna os mesmos detalhes para cada recurso na lista que um método GET para um recurso individual (como GET v1/clusters/{idOrName}).
API v2: para retornar respostas mais rápido, o método v2 GET para uma coleção de recursos (como GET v2/clusters) retorna apenas um subconjunto de informações que é detalhado em um método GET para um recurso individual (como GET v2/clusters/{idOrName}). Algumas respostas da lista incluem uma propriedade dos provedores para identificar se o item retornado se aplica à infraestrutura clássica ou à do VPC. Por exemplo, a lista GET zones retorna alguns resultados, como mon01, que estão disponíveis somente no provedor de infraestrutura clássica, e us-south-01, que estão disponíveis somente no provedor de infraestrutura de VPC.
Respostas do cluster, do nó do trabalhador e do conjunto de trabalhadores
API v1: as respostas incluem apenas informações específicas para o provedor de infraestrutura clássica, como as VLANs no cluster GET e respostas do trabalhador.
API v2: as informações que são retornadas variam de acordo com o provedor de infraestrutura. Para essas respostas específicas do provedor, é possível especificar o provedor em sua solicitação. Por exemplo, clusters de VPC não retornam informações de VLAN já que não possuem VLANs. Em vez disso, eles retornam informações de sub-rede e de rede 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}}