Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (sae/2019-05-06) utiliza o estilo de assinatura ROA. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.
Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.
Cenários de assinatura personalizada
Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.
Preparação de conta e segurança
As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.
Ativação de serviço
|
API |
Título |
Descrição |
| OpenSaeService | OpenSaeService. | Ativa o Serverless App Engine (SAE) gratuitamente. |
Gerenciamento geral de serviços
|
API |
Título |
Descrição |
| Namespaces e VPCs | Namespaces e VPCs | |
| CreateIngress | CreateIngress. | Cria uma regra de roteamento. |
| DeleteIngress | DeleteIngress. | Exclui uma instância de ingress. |
| UpdateNamespaceVpc | UpdateNamespaceVpc. | Atualiza a VPC associada a um namespace. |
| UpdateApplicationVswitches | UpdateApplicationVswitches. | Atualiza a configuração do vSwitch para uma aplicação. |
| UpdateIngress | UpdateIngress. | Atualiza a configuração de uma instância Ingress. |
| DescribeNamespaces | DescribeNamespaces. | Consulta uma lista de namespaces. |
| DescribeNamespaceList | DescribeNamespaceList. | Consulta uma lista de namespaces. |
| ListAppEvents | ListAppEvents. | Lista os eventos de aplicação. |
| ListNamespaceChangeOrders | ListNamespaceChangeOrders. | Lista ordens de implantação em um namespace. |
| DescribeNamespaceResources | DescribeNamespaceResources. | Consulta os recursos em um namespace. |
| DescribeIngress | DescribeIngress. | Consulta os detalhes de um Ingress. |
| ListIngresses | ListIngresses. | Obtém uma lista de Ingresses. |
| DescribePipeline | DescribePipeline. | Consulta as informações do lote. |
| Monitoramento Top N da página de visão geral | Monitoramento Top N da página de visão geral | |
| GetArmsTopNMetric | GetArmsTopNMetric. | Consulta as N principais aplicações no Monitoramento de Aplicações. |
| GetChangeOrderMetric | GetChangeOrderMetric. | Obtém as N principais aplicações com ordens de mudança anormais. Para isso, chame a API GetChangeOrderMetric. |
| GetWarningEventMetric | GetWarningEventMetric. | Consulta as N principais aplicações nas quais ocorrem eventos de Warning. |
Aplicações de microsserviços
|
API |
Título |
Descrição |
| Ciclo de vida da aplicação | Ciclo de vida da aplicação | |
| StopApplication | StopApplication. | Interrompe um aplicativo. |
| StartApplication | StartApplication. | Inicia uma aplicação. |
| ReduceApplicationCapacityByInstanceIds | ReduceApplicationCapacityByInstanceIds. | Reduz a capacidade de uma aplicação com base nos IDs das instâncias. |
| UpdateApplicationDescription | UpdateApplicationDescription. | Atualiza a descrição de uma aplicação. |
| UpdateAppSecurityGroup | UpdateAppSecurityGroup. | Atualiza um grupo de segurança de aplicação. |
| DescribeApplicationStatus | DescribeApplicationStatus. | Chama a API DescribeApplicationStatus para obter o status de uma aplicação. |
| ListChangeOrders | ListChangeOrders | Lista as ordens de alteração. |
| DescribeChangeOrder | DescribeChangeOrder. | Obtém informações sobre uma ordem de mudança. |
| DescribeInstanceSpecifications | DescribeInstanceSpecifications. | Obtém uma lista de especificações de instâncias de aplicativo disponíveis. |
| DeployApplication | DeployApplication | Implanta uma aplicação. |
| RescaleApplicationVertically | RescaleApplicationVertically. | Altera o tipo de instância de uma aplicação. |
| ConfirmPipelineBatch | ConfirmPipelineBatch. | Confirma se o próximo lote deve ser iniciado. |
| AbortAndRollbackChangeOrder | AbortAndRollbackChangeOrder. | Encerra uma ordem de alteração e reverte a aplicação correspondente. |
| RestartApplication | RestartApplication. | Reinicia uma aplicação. |
| AbortChangeOrder | AbortChangeOrder. | Interrompe uma ordem de alteração. |
| BatchStopApplications | BatchStopApplications. | Interrompe aplicativos em lotes. |
| BatchStartApplications | BatchStartApplications. | Inicia vários aplicativos simultaneamente. |
| DowngradeApplicationApmService | DowngradeApplicationApmService. | Desativa o monitoramento da Edição Avançada do ARMS. |
| UpgradeApplicationApmService | UpgradeApplicationApmService. | Ativa o recurso de monitoramento avançado do Application Real-Time Monitoring Service (ARMS). |
| Lista de microsserviços | Lista de microsserviços | |
| ListConsumedServices | ListConsumedServices. | Obtém uma lista de microsserviços inscritos. |
| ListPublishedServices | ListPublishedServices. | Consulta uma lista de microsserviços publicados. |
| ListAppServices | ListAppServices. | Lista microsserviços. |
| Gerenciamento de itens de configuração | Gerenciamento de itens de configuração | |
| CreateConfigMap | CreateConfigMap. | Cria um ConfigMap em um namespace. |
| DeleteConfigMap | DeleteConfigMap. | Exclui uma instância de ConfigMap. |
| UpdateConfigMap | UpdateConfigMap. | Atualiza uma instância de ConfigMap. |
| DescribeConfigMap | DescribeConfigMap. | Consulta os detalhes de uma instância ConfigMap. |
| ListNamespacedConfigMaps | ListNamespacedConfigMaps. | Lista as instâncias de ConfigMap em um namespace. |
| Roteamento por tags de liberação canário | Roteamento por tags de liberação canário | |
| CreateGreyTagRoute | CreateGreyTagRoute. | Cria uma regra de lançamento canário para uma aplicação Spring Cloud ou Dubbo. |
| DeleteGreyTagRoute | DeleteGreyTagRoute. | Exclui uma rota de tag cinza pelo ID da regra especificado. |
| UpdateGreyTagRoute | UpdateGreyTagRoute. | Atualiza uma rota de tag cinza. |
| DescribeGreyTagRoute | DescribeGreyTagRoute | Obtém uma regra de lançamento canário pelo ID da regra. |
| ListGreyTagRoute | ListGreyTagRoute. | Consulta os detalhes de uma regra de escala de cinza com base no ID da aplicação. |
| Liberação canário de ponta a ponta | Liberação canário de ponta a ponta | |
| CreateOrUpdateSwimmingLaneGroup | CreateOrUpdateSwimmingLaneGroup. | Cria ou atualiza um grupo de swimming lane. |
| CreateOrUpdateSwimmingLane | CreateOrUpdateSwimmingLane. | Cria ou atualiza uma swimlane. |
| ListApplicationsForSwimmingLane | ListApplicationsForSwimmingLane. | Obtém uma lista de aplicações para releases canário de link completo. |
| ListSwimmingLaneGatewayRoutes | ListSwimmingLaneGatewayRoutes. | Lista as rotas de gateway que podem ser associadas a uma swimming lane. |
| ListSwimmingLaneGroupTags | ListSwimmingLaneGroupTags. | Lista todas as tags de swimlane. |
| DescribeSwimmingLane | DescribeSwimmingLane. | Obtém os detalhes de uma swimlane. |
| ListAllSwimmingLanes | ListAllSwimmingLanes. | Lista todas as swimlanes. |
| ListAllSwimmingLaneGroups | ListAllSwimmingLaneGroups. | Retorna uma lista de todos os grupos de swimlane. |
| DeleteSwimmingLaneGroup | DeleteSwimmingLaneGroup. | Exclui um grupo de swimlane. |
| UpdateSwimmingLaneEnableAttribute | UpdateSwimmingLaneEnableAttribute. | Atualiza o status de ativação de uma swimming lane. |
| Consulta de informações da aplicação | Consulta de informações da aplicação | |
| DescribeApplicationConfig | DescribeApplicationConfig. | Obtém a configuração de uma aplicação. |
| DescribeInstanceLog | DescribeInstanceLog. | Obtém o log de uma instância. |
| DescribeComponents | DescribeComponents. | Chama a API DescribeComponents para obter as versões de componentes necessárias para criar uma implantação de aplicação. |
| DescribeEdasContainers | DescribeEdasContainers. | Obtém os componentes do contêiner de microsserviços de um aplicativo. |
| DescribeApplicationImage | DescribeApplicationImage. | Obtém informações sobre uma imagem de aplicativo. |
| DescribeApplicationInstances | DescribeApplicationInstances. | Obtém uma lista de instâncias de aplicação. |
| DescribeApplicationGroups | DescribeApplicationGroups. | Obtém grupos de instâncias de aplicativo usando DescribeApplicationGroups. |
| QueryResourceStatics | QueryResourceStatics. | Obtém o uso de recursos de uma aplicação. |
| ListLogConfigs | ListLogConfigs. | Retorna uma lista de logs de aplicação. |
| RestartInstances | RestartInstances. | Reinicia uma ou mais instâncias em uma aplicação. |
| GetAvailabilityMetric | GetAvailabilityMetric. | Consulta as N principais aplicações nas quais existem instâncias anômalas. As aplicações são classificadas pelo número total de instâncias anômalas. |
| DescribeAppServiceDetail | DescribeAppServiceDetail. | Descreve os detalhes de metadados de um serviço de aplicação. |
| ListAppServicesPage | ListAppServicesPage. | Chama ListAppServicesPage para obter uma lista de serviços de aplicativo. |
| Gerenciamento de SLB | Gerenciamento de SLB | |
| DescribeApplicationNlbs | DescribeApplicationNlbs. | Consulta a configuração do NLB da aplicação. |
| BindNlb | BindNlb. | Vincula uma instância de Network Load Balancer (NLB) a uma aplicação. |
| DescribeApplicationSlbs | DescribeApplicationSlbs. | Consulta as configurações das instâncias do Server Load Balancer (SLB) de uma aplicação. |
| BindSlb | BindSlb. | Vincula uma instância do Server Load Balancer (SLB) à aplicação. |
| UnbindSlb | UnbindSlb. | Desvincula uma instância de SLB pública ou privada de uma aplicação. |
| UnbindNlb | UnbindNlb. | Desvincula um listener NLB de uma aplicação. |
| Regras de escalonamento da aplicação | Regras de escalonamento da aplicação | |
| CreateApplicationScalingRule | CreateApplicationScalingRule. | Cria uma política de auto scaling de aplicação. |
| DeleteApplicationScalingRule | DeleteApplicationScalingRule. | Exclui uma política de Auto Scaling de uma aplicação. |
| DisableApplicationScalingRule | DisableApplicationScalingRule. | Desativa uma política de Auto Scaling para uma aplicação. |
| EnableApplicationScalingRule | EnableApplicationScalingRule. | Ativa uma política de auto scaling para uma aplicação. |
| UpdateApplicationScalingRule | UpdateApplicationScalingRule. | Atualiza a política de auto scaling da aplicação. |
| DescribeApplicationScalingRule | DescribeApplicationScalingRule. | Descreve uma única política de auto scaling para uma aplicação. |
| DescribeApplicationScalingRules | DescribeApplicationScalingRules. | Descreve as políticas do Auto Scaling para um aplicativo. |
Tarefas de job
|
API |
Título |
Descrição |
| DeleteHistoryJob | DeleteHistoryJob. | Exclui um job. |
| DescribeJobStatus | DescribeJobStatus. | Consulta o status de um job. |
| DescribeJob | DescribeJob. | Chama a API DescribeJob para obter a configuração do modelo de tarefa. |
| ExecJob | ExecJob. | Chama ExecJob para executar um job. |
| SuspendJob | SuspendJob. | Suspende um ou mais trabalhos. |
| DescribeJobHistory | DescribeJobHistory. | Consulta as informações sobre jobs. |
Outros
|
API |
Título |
Descrição |
| DescribeConfigurationPrice | DescribeConfigurationPrice. | Consulta o preço de uma configuração. |
| GetWebshellToken | GetWebshellToken. | Obtém o token usado para fazer login remoto no Webshell de uma instância. |
| UpdateAppMode | UpdateAppMode. | Atualiza o modo ocioso de um aplicativo. |
| QueryArmsEnable | QueryArmsEnable. | Consulta se o monitoramento do ARMS está ativado para uma aplicação especificada. |
| DescribeApplicationMseService | DescribeApplicationMseService. | Consulta as informações do aplicativo de governança de microsserviços MSE associado. |
| BatchRestartApplications | BatchRestartApplications. | Reinicia aplicativos em lotes. |
| UpdateNamespaceSlsConfigs | UpdateNamespaceSlsConfigs. | Atualiza a configuração do SLS no nível do namespace. |
| DisableArms | DisableArms. | Desativa o monitoramento do ARMS. |
| ResumeTraffic | ResumeTraffic. | Retoma o tráfego em uma instância a partir do Classic Load Balancer (CLB), Network Load Balancer (NLB), roteamento de gateway CLB, roteamento de gateway Application Load Balancer (ALB) e Kubernetes Service. |
| SuspendTraffic | SuspendTraffic. | Interrompe o roteamento de tráfego do acesso à aplicação do Classic Load Balancer (CLB), acesso à aplicação do Network Load Balancer (NLB), rotas de gateway do CLB, rotas de gateway do Application Load Balancer (ALB) ou serviços do Kubernetes (K8s) para as instâncias especificadas. |
Others
|
API |
Título |
Descrição |
| CreateApplication | CreateApplication. | Cria uma aplicação. |
| CreateJob | CreateJob. | Cria um modelo de tarefa. |
| CreateNamespace | CreateNamespace. | Cria um namespace. |
| CreateSecret | CreateSecret. | Cria um Secret em um namespace. |
| DeleteApplication | DeleteApplication. | Exclui uma aplicação. |
| DeleteInstances | DeleteInstances. | Exclui uma ou mais instâncias de aplicação. |
| DeleteJob | DeleteJob. | Exclui um modelo de job. |
| DeleteNamespace | DeleteNamespace. | Exclui um namespace. |
| DeleteSecret | DeleteSecret. | Exclui um segredo. |
| DescribeNamespace | DescribeNamespace. | Consulta os detalhes de um namespace. |
| DescribeRegions | DescribeRegions. | Consulta as regiões disponíveis. |
| DescribeSecret | DescribeSecret. | Consulta os detalhes de um segredo. |
| GetApplication | GetApplication. | Obtém informações básicas sobre uma aplicação. |
| GetScaleAppMetric | GetScaleAppMetric. | Consulta as N principais aplicações nas quais o auto scaling tem efeito. |
| ListAppVersions | ListAppVersions. | Lista as versões históricas de uma aplicação. |
| ListApplications | ListApplications. | Obtém uma lista de aplicações. |
| ListJobs | ListJobs. | Obtém uma lista de modelos de job. |
| ListSecrets | ListSecrets. | Lista os Secrets em um namespace. |
| ListTagResources | ListTagResources. | Chama a API ListTagResources para listar as tags associadas às suas aplicações. |
| RescaleApplication | RescaleApplication. | Redimensiona um aplicativo. |
| RollbackApplication | RollbackApplication. | Reverte uma aplicação. |
| TagResources | TagResources. | Adiciona uma ou mais tags aos recursos especificados. |
| UntagResources | UntagResources. | Remove uma ou mais tags de recursos especificados. |
| UpdateJob | UpdateJob. | Chama a API UpdateJob para atualizar um modelo de job. |
| UpdateNamespace | UpdateNamespace. | Atualiza as informações de um namespace. |
| UpdateSecret | UpdateSecret. | Atualiza uma instância de Secret. |