Além do console baseado na web, o CloudSSO disponibiliza diversos métodos para acesso programático, incluindo OpenAPI Explorer, Alibaba Cloud SDK, Alibaba Cloud CLI e Terraform.
, and Terraform
OpenAPI Explorer
O Alibaba Cloud disponibiliza o OpenAPI Explorer para ajudar desenvolvedores a compreender e utilizar as API operations de diversos services do Alibaba Cloud de maneira ágil e eficiente. Essa ferramenta concentra funcionalidades como pesquisa inteligente, documentação, depuração online, baixe de SDK, exemplos de código, diagnóstico de erros e estatísticas de chamadas. No OpenAPI Explorer, você aciona as API operations dos services do Alibaba Cloud e visualiza as requisições e respostas correspondentes. A plataforma também gera automaticamente o código de exemplo do SDK correspondente para facilitar o uso. Para mais detalhes, consulte What is an API?
Versões da API
O OpenAPI Explorer gerencia as versões das APIs de service por meio de identificadores numéricos. O CloudSSO, por exemplo, disponibiliza a API da versão 2021-05-15. Esse código 2021-05-15 representa um identificador de versão e não uma data. A versão 2021-05-15 é a mais recente para o CloudSSO e contém as informações públicas atualizadas sobre a API.
|
Versão da API |
Descrição |
|
Recomendamos a adoção desta versão. |
Depuração online
O CloudSSO permite depurar as API operations diretamente no OpenAPI Explorer. Antes de realizar as chamadas, verifique as informações necessárias: versões da API, endpoints e métodos de integração.
Na página de depuração do CloudSSO, o painel de navegação à esquerda exibe as APIs disponíveis, como EnableService. O painel central serve para definir os parâmetros da chamada. Após definir os parâmetros, clique em Initiate Call. O painel à direita traz a documentação da API, exemplos de SDK e informações sobre códigos de erro.
Página de depuração online
Para depurar as APIs, acesse a página de depuração da API CloudSSO.
Endpoints
Selecione um endpoint conforme a região em que seus recursos estão localizados para reduzir a latência. Na região China (Shanghai), por exemplo, o endpoint público do CloudSSO é cloudsso.cn-shanghai.aliyuncs.com e o endpoint da Virtual Private Cloud (VPC) é cloudsso-vpc.cn-shanghai.aliyuncs.com.
Qualquer endpoint público aceita acesso global.
-
O endpoint da VPC permite conexão apenas a partir de VPCs em uma região específica do Alibaba Cloud. Os benefícios incluem:
Maior segurança: o endpoint da VPC restringe o acesso exclusivamente a redes VPC, garantindo privacidade e proteção reforçada.
Resposta mais rápida: o tráfego circula pela rede interna, o que elimina gargalos de largura de banda e reduz o tempo de resposta comparado ao endpoint público.
Economia de custos: a comunicação ocorre por meio da rede interna, reduzindo despesas com tráfego externo.
Para mais detalhes, consulte Endpoints.
Identidades de usuário
Ao acessar o OpenAPI Explorer com sua conta do Alibaba Cloud, a ferramenta utiliza essas credenciais para a depuração online por padrão. Como a conta raiz do Alibaba Cloud detém permissão para todas as API operations, utilizá-la diretamente em chamadas gera riscos de segurança. Recomendamos que você execute chamadas de API e rotinas de O&M atuando como um usuário do Resource Access Management (RAM). Antes de utilizar um usuário RAM, configure as permissões adequadas de acordo com a necessidade do seu negócio. O usuário deve ter autorização para gerenciar resources do CloudSSO. Consulte Use RAM to enable access control para mais informações.
|
Identidade |
Compatível |
|
Sim |
|
|
(Recomendado) RAM user |
Sim |
|
(Recomendado) RAM role |
Sim |
Referências
Métodos de integração
Os SDKs permitem integração direta com seus aplicativos e abrangem a maior variedade de operations. Recomendamos o uso de SDKs para chamar as API operations.
Visão geral dos métodos de integração
|
Método de integração |
Compatível |
|
(Recomendado) Alibaba Cloud SDKs |
Sim |
|
Sim |
|
|
Não |
|
|
Sim |
-
Alibaba Cloud SDKs
O Alibaba Cloud disponibiliza SDKs para Java, C#, Go, Python, TypeScript, Node.js, PHP e C++. A integração direta no seu aplicativo permite chamar as API operations sem precisar implementar assinaturas ou lógicas de timeout e retentativa, pois os SDKs encapsulam esses mecanismos e retornam objetos estruturados. Confira Alibaba Cloud SDKs para mais detalhes.
Utilize um Alibaba Cloud SDK para interagir com as APIs do CloudSSO. A lista de linguagens suportadas e o guia de instalação das dependências estão disponíveis em SDK do CloudSSO.
-
Alibaba Cloud CLI
A Alibaba Cloud CLI permite executar comandos
aliyunpara interagir com os services e gerenciar os resources no cloud. Saiba mais em What is Alibaba Cloud CLI?Chame as APIs do CloudSSO por meio da Alibaba Cloud CLI .
-
ROS
O ROS simplifica a administração dos resources de computação no cloud do Alibaba Cloud. Você define um modelo que descreve instâncias do Elastic Compute Service (ECS), ApsaraDB RDS e as dependências entre eles. Com base nesse modelo, o ROS cria e configura automaticamente todos os resources para automatizar a implantação e a O&M. Mais informações em What is ROS?
O ROS não suporta chamadas às API operations do CloudSSO.
-
Encapsulamento personalizado de API
Para realizar chamadas HTTP nativas, você precisa montar requisições personalizadas e assiná-las. O mecanismo de assinatura está detalhado em List of operations by function e Request syntax and signature method V3.
Notas de uso
Caso uma chamada de API do CloudSSO retorne erro, valide os parâmetros e os valores informados com base no código de erro.
Você também pode registrar o ID da requisição presente na resposta ou na mensagem de erro do SDK e utilizar Diagnóstico de API do Alibaba Cloud para solucionar o problema.
Referências
O CloudSSO se integra ao Alibaba Cloud Resource Directory para oferecer gerenciamento centralizado de identidades e controle de acesso entre múltiplas contas. Utilize o service para administrar usuários corporativos que precisam acessar resources no Alibaba Cloud e conceder permissões de forma unificada às contas no diretório. Além disso, uma única configuração habilita o acesso por single sign-on (SSO) via um provedor de identidade (IdP). Consulte What is CloudSSO?
Confira as linguagens de programação compatíveis com os SDKs do CloudSSO em SDK overview.