Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (hbr/2017-09-08) 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.
Cofre de backup
|
API |
Título |
Descrição |
| CreateVault | Criar um cofre de backup | Cria um cofre de backup. |
| CreateReplicationVault | **[Obsoleto]** Criar um cofre de destino de replicação e configurar a replicação entre regiões. | **[Obsoleto]** Cria um cofre de destino de replicação e configura a replicação entre regiões. Esta operação de API não suporta replicação entre contas e está obsoleta. Use CreateVault e CreateVaultReplication em vez disso para obter funcionalidades completas. |
| DeleteVault | DeleteVault. | Exclui um cofre de backup. |
| UpdateVault | Atualizar a configuração de um cofre de backup | Atualiza a configuração de um cofre de backup. |
| DescribeVaults | Consulta de informações do cofre de backup | Consulta as informações de um ou mais cofres de backup que atendem às condições especificadas. |
Plano de backup
|
API |
Título |
Descrição |
| CreateBackupPlan | Create a backup plan. | Cria um plano de backup. |
| DeleteBackupPlan | Excluir um plano de backup | Exclui um plano de backup. |
| DisableBackupPlan | DisableBackupPlan. | Desativa um plano de backup. |
| EnableBackupPlan | EnableBackupPlan. | Retoma um plano de backup. |
| UpdateBackupPlan | Atualização de um plano de backup | Atualiza um plano de backup. |
| DescribeBackupPlans | Consulta planos de backup que atendem a condições especificadas. | Obtém um ou mais planos de backup que atendem às condições especificadas. |
| ExecuteBackupPlan | Executar um plano de backup. | Executa um plano de backup. |
Política de backup
|
API |
Título |
Descrição |
| CreatePolicyV2 | Create a policy. | Cria uma política. |
| DeletePolicyV2 | DeletePolicyV2 | Exclui uma política. |
| UpdatePolicyV2 | Modify a policy. | Modifica uma política. |
| DescribePoliciesV2 | Consultar uma ou mais políticas. | Consulta uma ou mais políticas. |
| CreatePolicyBindings | Associar origens de dados a uma política | Vincula uma ou mais origens de dados a uma política. |
| DeletePolicyBinding | Desassociar uma política de fontes de dados. | Desassocia uma fonte de dados de uma política. Após a desassociação, a política não poderá mais proteger a fonte de dados. Proceda com cautela. |
| UpdatePolicyBinding | Modificação da associação entre uma política e uma fonte de dados | Modifica a associação entre uma política e uma fonte de dados. |
| DescribePolicyBindings | Consultar lista de vínculos de políticas. | Consulta uma ou mais fontes de dados vinculadas a uma política, ou consulta uma ou mais políticas vinculadas a uma fonte de dados. |
| ExecutePolicyV2 | Execute Policy. | Executa uma política para uma ou todas as fontes de dados vinculadas. |
Cliente de backup
|
API |
Título |
Descrição |
| DeleteBackupClient | DeleteBackupClient. | Exclui um cliente do Cloud Backup. |
| DeleteBackupClientResource | Exclusão de recursos do cliente de backup | Exclui os recursos associados a um cliente de backup. |
| UpdateClientSettings | Update client configuration. | Atualiza a configuração de um cliente de backup. |
| DescribeBackupClients | Obter informações do cliente de backup. | Obtém informações sobre um ou mais clientes de backup que atendem às condições especificadas. |
| InstallBackupClients | InstallBackupClients. | Instala clientes de backup em uma ou mais instâncias ECS. |
| UninstallBackupClients | Desinstalar o cliente de backup | Desinstala o cliente de backup de uma ou mais instâncias ECS. |
| UpgradeBackupClients | UpgradeBackupClients. | Atualiza um cliente HBR em uma ou mais instâncias do Elastic Compute Service (ECS). |
Snapshot de backup
|
API |
Título |
Descrição |
| ListSnapshots | Consulta de pontos de backup | Consulta pontos de backup. |
| DeleteSnapshot | Excluir um snapshot de backup. | Exclui um snapshot de backup. |
| DescribeOtsTableSnapshots | DescribeOtsTableSnapshots. | Consulta os detalhes das instâncias do Tablestore que possuem backup. |
| DescribeRecoverableOtsInstances | DescribeRecoverableOtsInstances. | Consulta as tabelas de uma instância do Tablestore restaurável. |
| SearchHistoricalSnapshots | Obter snapshots de backup. | Obtém um ou mais snapshots de backup históricos que atendem às condições especificadas. |
| DescribeUdmSnapshots | DescribeUdmSnapshots. | Consulta os snapshots de backups completos. |
Tarefa de restauração
|
API |
Título |
Descrição |
| CreateRestoreJob | Create a restore job. | Cria um trabalho de restauração. |
| CancelRestoreJob | Cancelamento de um trabalho de restauração | Cancela um trabalho de restauração. |
| DescribeRestoreJobs2 | DescribeRestoreJobs2 | Consulta os trabalhos de restauração que correspondem aos critérios especificados. |
Tarefa de backup
|
API |
Título |
Descrição |
| CancelBackupJob | Cancelar um trabalho de backup | Cancela um trabalho de backup. |
| CreateBackupJob | Cria um trabalho de backup | Cria um trabalho de backup manual. |
| DescribeBackupJobs2 | Consulta de trabalhos de backup | Consulta um ou mais trabalhos de backup que atendem às condições especificadas. |
Backup do SAP HANA
|
API |
Título |
Descrição |
| CreateHanaBackupPlan | Criar um plano de backup do SAP HANA | Cria um plano de backup do SAP HANA. |
| CreateHanaInstance | Registrar uma instância SAP HANA | Registra uma instância SAP HANA. |
| CreateClients | Instalar clientes | Instala um ou mais clientes do Cloud Backup em uma instância especificada. |
| DeleteClient | DeleteClient. | Exclui um cliente. |
| CreateHanaRestore | Criação de um trabalho de restauração do SAP HANA | Cria um trabalho de restauração para um banco de dados SAP HANA. |
| DeleteHanaBackupPlan | DeleteHanaBackupPlan. | Exclui um plano de backup do SAP HANA. |
| DeleteHanaInstance | DeleteHanaInstance. | Exclui uma instância SAP HANA. |
| UninstallClient | Desinstalar um cliente | Desinstala um cliente de backup do HBR. |
| UpdateHanaBackupPlan | Atualizar um plano de backup do SAP HANA | Atualiza um plano de backup do SAP HANA. |
| EnableHanaBackupPlan | EnableHanaBackupPlan. | Ativa um plano de backup do SAP HANA. |
| DisableHanaBackupPlan | DisableHanaBackupPlan. | Desativa um plano de backup do SAP HANA. |
| UpdateHanaInstance | UpdateHanaInstance. | Atualiza uma instância SAP HANA. |
| UpgradeClient | UpgradeClient. | Atualiza o cliente do Cloud Backup. |
| StartHanaDatabaseAsync | StartHanaDatabaseAsync. | Inicia um banco de dados SAP HANA. |
| StopHanaDatabaseAsync | Parar um banco de dados SAP HANA | Para um banco de dados SAP HANA. |
| UpdateHanaRetentionSetting | Atualiza o período de retenção de backup de um banco de dados SAP HANA | Atualiza o período de retenção de backup de um banco de dados SAP HANA. |
| UpdateHanaBackupSetting | Atualizar os parâmetros de backup do banco de dados SAP HANA | Atualiza os parâmetros de backup de um banco de dados SAP HANA. |
| DescribeHanaBackupPlans | DescribeHanaBackupPlans. | Consulta um ou mais planos de backup do SAP HANA que correspondem aos critérios especificados. |
| DescribeHanaInstances | DescribeHanaInstances. | Consulta uma ou mais instâncias SAP HANA que atendem às condições especificadas. |
| DescribeClients | DescribeClients. | Consulta um ou mais clientes do Cloud Backup que atendem às condições especificadas. |
| DescribeHanaDatabases | DescribeHanaDatabases. | Consulta as informações sobre bancos de dados SAP HANA. |
| DescribeHanaRetentionSetting | DescribeHanaRetentionSetting. | Consulta o período de retenção de backup de um banco de dados SAP HANA. |
| DescribeHanaBackupSetting | DescribeHanaBackupSetting. | Consulta os parâmetros de backup de um banco de dados SAP HANA. |
| DescribeHanaBackupsAsync | DescribeHanaBackupsAsync. | Consulta um ou mais backups do SAP HANA que atendem às condições especificadas. |
| DescribeHanaRestores | DescribeHanaRestores. | Consulta um ou mais trabalhos de restauração do SAP HANA que atendem às condições especificadas. |
Edição essencial do backup de ECS
|
API |
Título |
Descrição |
| DeleteAirEcsInstance | Remover uma instância ECS somente de restauração do ECS Backup Essential Edition. | Remove uma instância ECS somente de restauração do ECS Backup Essential Edition. |
Backup de contêineres
|
API |
Título |
Descrição |
| DescribeContainerResource | DescribeContainerResource. | Consulta a lista de recursos do cluster de contêineres. |
| DeleteContainerCluster | DeleteContainerCluster. | Cancela o registro de um cluster de contêiner no Cloud Backup. Após cancelar o registro do cluster, você não poderá recuperar os backups do cluster. |
| DescribeContainerCluster | DescribeContainerCluster. | Consulta um ou mais clusters de contêineres que atendem às condições especificadas. |
| UpdateContainerCluster | Atualizar informações do cluster de contêineres. | Atualiza as informações do cluster de contêineres, incluindo o nome do cluster de contêineres, o tipo de rede, etc. |
| AddContainerCluster | Registrar um cluster de contêineres | Registra um cluster de contêineres. |
Outros
|
API |
Título |
Descrição |
| OpenHbrService | Ativar Cloud Backup | Ativa o serviço Cloud Backup. |
| DescribeRegions | Consulta de regiões disponíveis. | Consulta as regiões disponíveis. |
| DescribeTask | DescribeTask. | Consulta um job assíncrono. |
| DescribeVaultReplicationRegions | DescribeVaultReplicationRegions. | Consulta as regiões que suportam replicação entre regiões. |
| DetachNasFileSystem | Excluir um ponto de montagem interno | Exclui um ponto de montagem interno de um sistema de arquivos NAS do Apsara File Storage criado pelo Cloud Backup. |
| GenerateRamPolicy | GenerateRamPolicy. | Gera uma política do Resource Access Management (RAM). |
| ChangeResourceGroup | Altera o grupo de recursos de uma instância | Modifica o grupo de recursos de uma instância. |
| CreateTempFileUploadUrl | CreateTempFileUploadUrl. | Gera os parâmetros e a assinatura necessários para uma URL de upload de arquivo. |
| GetTempFileDownloadLink | GetTempFileDownloadLink. | Obtém os links de download de arquivos, como relatórios de jobs. |
| CheckRole | Verificar permissões. | Verifica se o usuário atual tem permissões para acessar um recurso ou página específica. |
| DescribeCrossAccounts | DescribeCrossAccounts. | Consulta os relacionamentos de gerenciamento entre contas. |
| DeleteUdmEcsInstance | DeleteUdmEcsInstance. | Interrompe a proteção para o backup de instância do Elastic Compute Service (ECS). |
| DeleteUdmDisk | DeleteUdmDisk. | Cancela um disco protegido. |
| AddCrossAccount | Adicionar uma relação de gerenciamento entre contas | Adiciona uma relação de gerenciamento entre contas. |
| AddDataSource | Criar uma fonte de dados | Cria uma fonte de dados. |
| BrowseFiles | Navegar pelos arquivos de backup | Navega pela lista de arquivos de backup. |
| CreateVaultReplication | Configurar a replicação do cofre de backup | Configura a replicação do cofre de backup. |
| DeleteCrossAccount | DeleteCrossAccount. | Exclui um relacionamento de gerenciamento entre contas. |
| DeleteVaultReplication | DeleteVaultReplication. | Interrompe a replicação do cofre de backup. |
| DescribeDataSources | DescribeDataSources. | Consulta uma lista de fontes de dados. Filtra os resultados por tipo de fonte de dados, ID da fonte de dados, nome da fonte de dados ou ID do grupo de clientes. |
| GetBasicStatistics | GetBasicStatistics. | Obtém as estatísticas básicas do Backup. |
| ListProtectedResources | Consulta recursos protegidos | Consulta a lista de recursos protegidos. |
| RemoveDataSource | RemoveDataSource. | Exclui uma fonte de dados. |
| UpdateDataSource | UpdateDataSource. | Atualiza a configuração da fonte de dados. |
| DescribeFeatureTrialInfo | Obter informações de teste gratuito da funcionalidade. | Consulta o status de ativação do teste gratuito e a hora de expiração de uma funcionalidade especificada. Atualmente, apenas as informações de teste gratuito do backup do Tablestore podem ser consultadas. |
| GetTrialInfo | Obter informações de avaliação gratuita. | Consulta as informações de avaliação gratuita de um bucket do OSS ou sistema de arquivos NAS especificado. |