Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (oos/2019-06-01) utiliza o estilo de assinatura RPC. 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.
Região
|
API |
Título |
Descrição |
| GetGitRepository | Query a git repository. | Consulta os detalhes de um repositório Git. |
| DescribeRegions | Consultar regiões suportadas. | Consulta as regiões atualmente suportadas. |
Modelo
|
API |
Título |
Descrição |
| CreateTemplate | Create a template. | Cria um modelo. |
| DeleteTemplates | Excluir vários modelos. | Exclui vários modelos. |
| DeleteTemplate | Excluir um modelo. | Exclui um modelo. |
| UpdateTemplate | Atualizar um modelo existente. | Atualiza um modelo existente. |
| ListTemplateVersions | Consultar vários objetos de versão de um modelo. | Consulta vários objetos de versão de um modelo. |
| ListTemplates | Consultar modelos. | Consulta modelos. Suporta múltiplos métodos de filtragem. |
| GetTemplate | Obter um modelo. | Obtém um modelo, incluindo seu conteúdo. |
| ListExecutionRiskyTasks | Obter tarefas de alto risco em um modelo. | Obtém tarefas de alto risco em um modelo. |
| ValidateTemplateContent | Validate whether a template is valid | Valida se um modelo é válido. |
| UpdateTemplateAttributes | Update template properties | Atualiza as propriedades do modelo. |
| GetTemplateParameterConstraints | Obter valores disponíveis para parâmetros de modelo. | Obtém os valores disponíveis para parâmetros de modelo. |
Execução
|
API |
Título |
Descrição |
| DeleteExecutions | Excluir uma execução. | Exclui uma execução. |
| StartExecution | Start a task execution. | Inicia uma execução de tarefa. |
| UpdateExecution | Atualizar uma execução não concluída. | Atualiza uma execução que não foi concluída (com status Running ou Waiting). |
| GetExecutionTemplate | Obter o modelo usado por uma execução de tarefa. | Obtém o modelo usado por uma execução de tarefa, incluindo seu conteúdo. |
| ListExecutions | Consultar execuções de tarefas. | Consulta execuções de tarefas com suporte a múltiplos métodos de filtragem. |
| ListExecutionLogs | Obter logs detalhados da execução. | Obtém os logs detalhados de uma execução. |
| ListTaskExecutions | Consultar execuções de tarefas. | Consulta execuções de tarefas com suporte a múltiplos métodos de filtragem. |
| ListResourceExecutionStatus | Consultar informações de execução de O&M agendada que incluem instâncias ECS. | Consulta as informações de execução de O&M agendada que incluem instâncias ECS. |
| CancelExecution | Cancelar uma execução de tarefa. | Cancela uma execução de tarefa. |
| GenerateExecutionPolicy | Obter política do RAM necessária para execução. | Obtém a política do RAM necessária para a execução do modelo. |
| NotifyExecution | Notify an execution how to proceed | Notifica uma execução em espera sobre como proceder. |
| TriggerExecution | Disparar execução de evento. | Envia um corpo de mensagem para uma execução de tarefa de gatilho de evento, gatilho de alarme ou gatilho de temporizador, o que faz com que a tarefa de evento, alarme ou temporizador crie uma nova execução filha. |
| StartDebugExecution | Testar execução de uma tarefa. | Inicia uma execução de tarefa. |
| ListTaskExecutionInvocations | Obter o ID de invocação do comando do Cloud Assistant em uma execução de tarefa. | Obtém o ID de invocação do comando do Cloud Assistant em uma execução de tarefa. |
Ação
|
API |
Título |
Descrição |
| ListActions | Consultar ações disponíveis. | Consulta as ações disponíveis, incluindo ações atômicas e ações de produtos em nuvem. |
Parâmetro
|
API |
Título |
Descrição |
| Parâmetro comum | Parâmetro comum | |
| CreateParameter | Create a common parameter. | Cria um parâmetro comum. |
| DeleteParameter | Excluir um parâmetro comum. | Exclui um parâmetro comum. |
| UpdateParameter | Atualizar um parâmetro comum existente. | Atualiza um parâmetro comum existente. |
| GetParameter | Obter um parâmetro comum. | Obtém um parâmetro comum ou um parâmetro público, incluindo o valor do parâmetro. |
| ListParameters | Consultar parâmetros. | Consulta parâmetros e parâmetros comuns. Vários métodos de consulta são suportados. |
| ListParameterVersions | Consultar vários objetos de versão de um parâmetro comum. | Consulta vários objetos de versão de um parâmetro comum. |
| GetParametersByPath | Obter parâmetros comuns por caminho. | Obtém parâmetros por caminho. |
| GetParameters | Obter os detalhes de um ou mais parâmetros comuns. | Obtém os detalhes de um ou mais parâmetros. |
| Parâmetro criptografado | Parâmetro criptografado | |
| CreateSecretParameter | Criar um parâmetro criptografado. | Cria um parâmetro criptografado. Certifique-se de ter permissão para chamar a operação da API CreateSecret do KMS antes de chamar esta operação. |
| DeleteSecretParameter | Excluir um parâmetro criptografado. | Exclui um parâmetro criptografado. Certifique-se de ter permissão para chamar a operação da API DeleteSecret do KMS antes de chamar esta operação. |
| UpdateSecretParameter | Atualizar um parâmetro de criptografia. | Atualiza um parâmetro de criptografia. Certifique-se de ter permissão para chamar a operação da API UpdateSecretValue do KMS antes de chamar esta operação. |
| GetSecretParameter | Obter um parâmetro criptografado e seu valor. | Obtém um parâmetro criptografado, incluindo seu valor. Certifique-se de ter permissão para chamar a operação da API GetSecretValue do KMS antes de chamar esta operação. |
| ListSecretParameters | Listar parâmetros criptografados. | Consulta parâmetros comuns. Vários métodos de consulta são suportados. |
| ListSecretParameterVersions | Consultar múltiplas versões de um parâmetro de criptografia. | Consulta múltiplas versões de um parâmetro de criptografia. |
| GetSecretParametersByPath | Obter parâmetros de criptografia por caminho. | Obtém parâmetros de criptografia por caminho. Certifique-se de ter permissão para chamar a operação da API GetSecretValue do KMS antes de chamar esta operação. |
| GetSecretParameters | Obter os detalhes de um ou mais parâmetros de criptografia. | Obtém os detalhes de um ou mais parâmetros de criptografia. Certifique-se de ter permissão para chamar a operação da API GetSecretValue do KMS antes de chamar esta operação. |
Gerenciamento de patches
|
API |
Título |
Descrição |
| Linha de base de patches | Linha de base de patches | |
| CreatePatchBaseline | Create a patch baseline. | Cria uma linha de base de patches. |
| DeletePatchBaseline | Delete a patch baseline. | Exclui uma linha de base de patches. |
| UpdatePatchBaseline | Update a patch baseline. | Atualiza uma linha de base de patches. |
| GetPatchBaseline | Get patch baseline. | Obtém os detalhes de uma linha de base de patches. |
| ListPatchBaselines | Listar linhas de base de patches. | Obtém uma lista de linhas de base de patches. |
| RegisterDefaultPatchBaseline | Register a default patch baseline | Registra uma linha de base de patches padrão. |
| Status de patches | Status de patches | |
| ListInstancePatchStates | Listar estados de patches de instâncias. | Obtém informações de patches para instâncias. |
| ListInstancePatches | Listar hotfixes da instância. | Obtém informações de patches para uma instância. |
Inventário de configurações
|
API |
Título |
Descrição |
| ListInventoryEntries | Consultar registros da lista de verificação de configuração de uma instância. | Consulta os registros da lista de verificação de configuração de uma instância. |
| GetInventorySchema | GetInventorySchema. | Consulta as propriedades de uma lista de configurações. |
| SearchInventory | Consultar detalhes da lista de verificação de configuração ou informações agregadas. | Consulta os detalhes ou informações agregadas de uma lista de verificação de configuração. |
Configuração de estado desejado
|
API |
Título |
Descrição |
| CreateStateConfiguration | Criar uma configuração de estado desejado. | Cria uma configuração de estado desejado. |
| DeleteStateConfigurations | Excluir várias configurações de estado desejado. | Exclui várias configurações de estado desejado em lote. |
| UpdateStateConfiguration | Atualizar uma configuração de estado desejado. | Atualiza uma configuração de estado desejado. |
| ListStateConfigurations | Consultar configurações de estado desejado. | Consulta as configurações de estado desejado. |
Item de O&M
|
API |
Título |
Descrição |
| CreateOpsItem | Create an opsItem. | Cria um OpsItem. |
| GetOpsItem | Obter um item de O&M. | Obtém os detalhes de um item de O&M. |
| ListOpsItems | Query opsItems. | Consulta OpsItems. |
| UpdateOpsItem | Atualizar um OpsItem. | Modifica um OpsItem. |
| DeleteOpsItems | Excluir itens de O&M em lote. | Exclui itens de O&M. |
| GenerateOpsItem | Generate O&M items. | Gera itens de O&M. |
Configuração de serviço
|
API |
Título |
Descrição |
| SetServiceSettings | Definir configurações de serviço. | Ativa ou desativa a entrega de registros de execução de modelos, especifica o local de armazenamento da entrega e associa um ID de empresa do China DevOps. |
| GetServiceSettings | Obter informações de configuração do serviço. | Obtém as informações de configuração de um serviço, incluindo a configuração do recurso de entrega de registros de execução de tarefas e a empresa Apsara Devops associada. |
Gerenciamento de aplicativos
|
API |
Título |
Descrição |
| Aplicativo | Aplicativo | |
| CreateApplication | Criar uma aplicação. | Cria uma aplicação. A região de serviço para gerenciamento de aplicações suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| DeleteApplication | Excluir um aplicativo. | Exclui um aplicativo. A região de serviço para gerenciamento de aplicativos suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| UpdateApplication | Atualizar um aplicativo. | Atualiza um aplicativo. A região de serviço para gerenciamento de aplicativos suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| GetApplication | Obter os detalhes de uma aplicação. | Obtém os detalhes de uma aplicação. A região de serviço para gerenciamento de aplicações suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| ListApplications | Consultar lista de aplicações. | Consulta a lista de aplicações. A região de serviço para gerenciamento de aplicações suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| ListDeployRevisions | ListDeployRevisions. | Lista as revisões de uma aplicação. |
| CreateDeployRevision | Create a deployment artifact. | Cria um artefato de implantação. |
| GetDeployRevision | GetDeployRevision. | Obtém os detalhes de uma revisão de aplicativo. |
| Grupo de aplicativos | Grupo de aplicativos | |
| CreateApplicationGroup | Criar um grupo de aplicativos. | Cria um grupo de aplicativos. A região de serviço para gerenciamento de aplicativos suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| DeleteApplicationGroup | Excluir um grupo de aplicativos. | Exclui um grupo de aplicativos. A região de serviço para gerenciamento de aplicativos suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| UpdateApplicationGroup | Atualizar as informações de um grupo de aplicativos. | Atualiza as informações de um grupo de aplicativos. A região de serviço para gerenciamento de aplicativos suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| GetApplicationGroup | Obter detalhes de um grupo de aplicativos. | Obtém os detalhes de um grupo de aplicativos. A região de serviço para gerenciamento de aplicativos suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| ListApplicationGroups | Consultar grupos de aplicativos. | Consulta a lista de grupos de aplicativos. A região de serviço para gerenciamento de aplicativos suporta apenas Hangzhou. Use o endpoint de Hangzhou. |
| DeployApplicationGroup | Implantar um grupo de aplicativos. | Implanta um grupo de aplicativos. O gerenciamento de aplicativos é suportado apenas na região de Hangzhou. Use o endpoint de Hangzhou. |
| ContinueDeployApplicationGroup | Continuar a implantação de um grupo de aplicativos. | Continua a implantação de um grupo de aplicativos quando a implantação falha. O gerenciamento de aplicativos é suportado apenas na região de Hangzhou. Use o endpoint de Hangzhou. |
| DescribeApplicationGroupBill | Consultar custos de recursos do grupo de aplicativos. | Consulta os custos de recursos de um grupo de aplicativos. |
Git
|
API |
Título |
Descrição |
| CheckGitRepoFileExists | Verificar se um arquivo existe em um repositório especificado. | Verifica se um arquivo existe em um repositório. |
| ListGitOrganizations | Consulta organizações de uma conta de logon. | Obtém as organizações de um usuário autorizado. |
| ListGitRepositories | Listar repositórios. | Consulta a lista de repositórios Git. |
| CreateGitRepository | Criar um repositório Git. | Cria um repositório. |
| ListGitAccounts | Listar contas Git vinculadas. | Obtém as contas de plataforma gerenciadas que o usuário atual do Alibaba Cloud autorizou no gerenciamento de aplicativos. |
| ListGitBranches | Consulta branches de um repositório especificado. | Obtém todas as branches de um repositório Git especificado. |
| CheckGitRepositoryExists | Check whether a repository exists | Verifica se um repositório existe. |
| GetGitBranch | Obter detalhes da branch. | Consulta os detalhes de uma branch do Git. Suporta a consulta de repositórios públicos sem autorização. |
| ListGitRepositoryContents | Obter conteúdo de arquivos e diretórios do repositório. | Obtém informações de arquivos e diretórios de um repositório. |
Tag
|
API |
Título |
Descrição |
| ListTagKeys | Query created labels. | Consulta labels criadas. |
| ListTagValues | Consultar valores de rótulo criados. | Consulta os valores de rótulo criados. |
| ListTagResources | Consultar relações entre recursos e tags. | Consulta as relações visíveis entre recursos e tags. |
| UntagResources | Excluir relações entre tags de usuário e recursos. | Exclui as relações entre tags de usuário e recursos para remover tags de usuário dos recursos. |
| TagResources | Criar relações tag-recurso. | Cria relações tag-recurso para adicionar tags de usuário aos recursos. |
Grupo de recursos
|
API |
Título |
Descrição |
| ChangeResourceGroup | Alterar grupo de recursos. | Modifica o grupo de recursos ao qual um recurso em nuvem pertence. |
Extensão
|
API |
Título |
Descrição |
| UpdateInstancePackageState | Atualizar uma extensão instalada em uma instância. | Atualiza uma extensão instalada em uma instância. |
| ListInstancePackageStates | Consultar extensões instaladas em uma instância. | Lista os estados dos pacotes de software de uma instância. |
Configuração do assistente de IA
|
API |
Título |
Descrição |
| CreateChatConfiguration | Criar uma configuração de chat. | Cria, atualiza, consulta e exclui configurações de chat para plataformas como DingTalk. |
| UpdateChatConfiguration | Update chat configuration. | Cria, atualiza, consulta e exclui configurações de chat para plataformas como DingTalk. |
| GetChatConfiguration | Visualizar configuração de chat. | Cria, atualiza, consulta e exclui configurações de chat para plataformas como DingTalk. |
| ListChatConfigurations | List chat configurations. | Cria, atualiza, consulta e exclui configurações de chat para plataformas como DingTalk. |
| DeleteChatConfiguration | Excluir uma configuração de chat. | Cria, atualiza, consulta e exclui configurações de chat para plataformas como DingTalk. |