Todos os produtos
Search
Central de documentação

Service Catalog:Visão geral de integração

Última atualização: Jun 28, 2026

O Service Catalog oferece suporte a vários métodos de integração, incluindo OpenAPI Explorer e Alibaba Cloud SDK. Escolha o método mais adequado às suas necessidades.

Visão geral do OpenAPI Explorer

O OpenAPI Explorer permite pesquisar, depurar e chamar operações de API dos serviços do Alibaba Cloud. Ele também gera automaticamente exemplos de código de SDK. Entre os recursos disponíveis estão pesquisa inteligente, documentação, depuração online, download de SDK, exemplos de código, diagnóstico de erros e estatísticas de chamadas. Para mais informações, consulte O que é uma API?

Versões

O OpenAPI Explorer usa números de versão para gerenciar as versões principais das operações de API dos serviços de nuvem. Por exemplo, o Service Catalog oferece suporte à API da versão 2021-09-01. O valor 2021-09-01 é um número de versão, não a data da última atualização da API. Cada versão fornece os dados de API mais recentes.

Versão da API

Descrição

2021-09-01

A versão recomendada.

Depuração online

Chame as operações de API do Service Catalog no OpenAPI Explorer. Antes de começar, certifique-se de entender a versão da API, os endpoints e os métodos de integração.

No OpenAPI Explorer, selecione a operação GetProductAsEndUser para depuração. Em Service Address, selecione a região de destino, como China (Hangzhou). Na área de configuração de parâmetros, insira o parâmetro obrigatório ProductId (ID do produto, string, por exemplo, prod-bp18r7q127****) e clique em Initiate Call. Antes de fazer a chamada, certifique-se de que um administrador concedeu ao usuário final permissões para usar o produto. Você pode obter o ProductId nas respostas de operações como UpdateProduct, LaunchProduct, CreateProduct, ListProductsAsAdmin e GetProductVersion.

Página de depuração online

Depure as operações de API na seguinte página: Lista de depuração de API do Service Catalog

Endpoints

Selecione um endpoint com base na região em que seus recursos residem para reduzir a latência. Por exemplo, se o seu Service Catalog reside na região China (Hangzhou), o endpoint público é servicecatalog.cn-hangzhou.aliyuncs.com e o endpoint VPC é servicecatalog-vpc.cn-hangzhou.aliyuncs.com.

  • Os endpoints públicos podem ser acessados globalmente.

  • Os endpoints VPC são acessíveis somente dentro de uma VPC em uma região específica do Alibaba Cloud. Os endpoints VPC oferecem os seguintes benefícios:

    • Maior segurança: os endpoints VPC são acessíveis somente dentro de uma VPC, o que proporciona maior segurança e privacidade.

    • Resposta mais rápida: os endpoints VPC usam a rede interna, o que proporciona respostas mais rápidas e evita a latência de rede e os limites de largura de banda.

    • Menor custo: os endpoints VPC são acessados pela rede interna.

Para mais informações, consulte Endpoints.

Identidades de usuário

Após fazer login no OpenAPI Explorer com sua conta do Alibaba Cloud, o OpenAPI Explorer usa essa conta para depuração online por padrão. Como uma conta do Alibaba Cloud tem permissões em todas as operações de API, usá-la para depuração apresenta riscos de segurança. Recomendamos chamar as operações de API como um usuário RAM. Antes de fazer isso, conceda as permissões necessárias ao usuário RAM de acordo com seus requisitos de negócio. O usuário RAM deve ter permissões para gerenciar o Service Catalog. Para mais informações, consulte Usar RAM para controle de acesso.

Identidade

Suportado

Conta do Alibaba Cloud

Sim

Usuário RAM (recomendado)

Sim

Função RAM (recomendado)

Sim

Referências

Métodos de integração

Nota

Os SDKs integram-se facilmente ao seu aplicativo e cobrem a mais ampla gama de operações. Recomendamos usar SDKs para chamar operações de API.

Visão geral dos métodos de integração

Método de integração

Suportado

Alibaba Cloud SDKs (recomendado)

Sim

Alibaba Cloud CLI

Não

Resource Orchestration Service (ROS)

Não

Encapsulamento personalizado

Sim

  • Alibaba Cloud SDKs

    • O Alibaba Cloud disponibiliza SDKs em diversas linguagens de programação, incluindo Java, C#, Go, Python, Node.js, TypeScript, PHP e C++. Os SDKs encapsulam a lógica de assinatura, o mecanismo de timeout e o mecanismo de repetição, e retornam objetos de resposta estruturados. Para mais informações, consulte Alibaba Cloud SDKs.

    • Use um Alibaba Cloud SDK para chamar as operações do Service Catalog. Para informações sobre linguagens suportadas e como instalar dependências, consulte Service Catalog SDK.

  • Alibaba Cloud CLI

    • O Alibaba Cloud CLI permite executar comandos aliyun para gerenciar serviços e recursos do Alibaba Cloud. Para mais informações, consulte O que é o Alibaba Cloud CLI?

    • Não é possível usar o Alibaba Cloud CLI para chamar as operações de API do Service Catalog.

  • ROS

    • O ROS é um serviço do Alibaba Cloud que simplifica o gerenciamento de recursos em nuvem. Crie um modelo para descrever os recursos necessários, como instâncias ECS e ApsaraDB RDS, e suas dependências. O ROS cria e configura automaticamente todos os recursos com base no modelo. Para mais informações, consulte O que é o ROS?

    • Não é possível usar o ROS para chamar as operações de API do Service Catalog.

Observações de uso

Se uma operação de API retornar um erro, verifique se os parâmetros e valores da solicitação são válidos com base no código de erro.

Você também pode registrar o RequestID da resposta ou da mensagem de erro do SDK e usar a página diagnóstico de problemas do OpenAPI para autodiagnóstico.

Referências

  • O Service Catalog é um serviço de Infraestrutura como Código (IaC) que ajuda empresas a configurar serviços em conformidade e definir restrições de lançamento. As empresas podem selecionar serviços de acordo com seus requisitos de negócio ao migrar cargas de trabalho para a nuvem, melhorando a eficiência na entrega de serviços de TI. Para mais informações, consulte O que é o Service Catalog?

  • Para mais informações sobre as linguagens de programação suportadas pelos SDKs do Service Catalog, consulte Visão geral do SDK.