Visão geral da API - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Padrões de API e SDKs predefinidos multilíngues

A OpenAPI deste produto (Dds/2015-12-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.

Criar ou clonar instâncias

API	Título	Descrição
CreateDBInstance	CreateDBInstance.	Cria ou clona uma instância de conjunto de réplicas do ApsaraDB for MongoDB.
CreateShardingDBInstance	CreateShardingDBInstance.	Cria ou clona uma instância de cluster sharded do MongoDB.

Alterar configurações de instância

API	Título	Descrição
CreateNode	CreateNode.	Adiciona um nó shard ou um nó mongos a uma instância de cluster fragmentado do ApsaraDB for MongoDB.
CreateNodeBatch	CreateNodeBatch.	Adiciona em lote nós mongos ou shard para uma instância de cluster fragmentado.
DeleteNode	DeleteNode.	Exclui um shard ou nó mongos de uma instância de cluster sharded do ApsaraDB for MongoDB.
ModifyDBInstanceSpec	ModifyDBInstanceSpec.	Altera o tipo de instância ou o espaço de armazenamento para instâncias standalone, conjunto de réplicas ou serverless do ApsaraDB for MongoDB. As instâncias serverless são exclusivas do site da Alibaba Cloud China.
ModifyNodeSpec	ModifyNodeSpec.	Altera o tipo de instância e o espaço de armazenamento de um nó em uma instância de cluster sharded do MongoDB.
ModifyNodeSpecBatch	ModifyNodeSpecBatch.	Altera a configuração de um ou mais nós Mongos ou shard em uma instância de cluster fragmentado do ApsaraDB for MongoDB.
ModifyDBInstanceDiskType	ModifyDBInstanceDiskType.	Modifica o tipo de disco de uma instância do ApsaraDB for MongoDB.

Gerenciamento de instâncias

API	Título	Descrição
DeleteDBInstance	DeleteDBInstance.	Libera uma instância MongoDB pós-paga.
ModifyDBInstanceMaintainTime	ModifyDBInstanceMaintainTime.	Modifica a janela de manutenção de uma instância ApsaraDB for MongoDB.
ModifyDBInstanceDescription	ModifyDBInstanceDescription.	Modifica o nome de uma instância do ApsaraDB for MongoDB.
ModifyDBInstanceNetExpireTime	ModifyDBInstanceNetExpireTime.	Estende o período de retenção do endpoint de rede clássica de uma instância do ApsaraDB for MongoDB.
UpgradeDBInstanceEngineVersion	UpgradeDBInstanceEngineVersion.	Atualiza a versão do banco de dados de uma instância ApsaraDB for MongoDB.
SwitchDBInstanceHA	SwitchDBInstanceHA.	Alterna os nós primário e secundário de uma instância do ApsaraDB for MongoDB.
RestartDBInstance	RestartDBInstance.	Reinicia uma instância do ApsaraDB for MongoDB.
RestartNode	RestartNode.	Reinicia um único nó de uma instância do MongoDB.

Gerenciamento de renovação

API	Título	Descrição
TransformInstanceChargeType	TransformInstanceChargeType.	Altera o método de cobrança de uma instância de pay-as-you-go para assinatura ou de assinatura para pay-as-you-go.
DescribePrice	DescribePrice.	Consulta preços.
DescribeRenewalPrice	DescribeRenewalPrice.	Obtém o preço para renovar uma instância MongoDB específica por um mês.
TransformToPrePaid	TransformToPrePaid.	Altera o método de cobrança de uma instância ApsaraDB for MongoDB de pagamento conforme o uso para assinatura.
RenewDBInstance	RenewDBInstance.	Renova manualmente uma instância por assinatura do ApsaraDB for MongoDB.

Consultar instâncias

API	Título	Descrição
DescribeDBInstanceSpecInfo	DescribeDBInstanceSpecInfo.	Obtém os detalhes do tipo de instância.
DescribeReplicaSetRole	DescribeReplicaSetRole.	Obtém as informações de função e os detalhes de conexão de uma instância MongoDB.
DescribeKernelReleaseNotes	DescribeKernelReleaseNotes.	Consulta as notas de versão das versões secundárias de uma instância ApsaraDB for MongoDB.
DescribeAvailableEngineVersion	DescribeAvailableEngineVersion.	Consulta as versões do engine para as quais uma instância do ApsaraDB for MongoDB pode ser atualizada.
DescribeDBInstances	DescribeDBInstances.	Consulta uma lista de instâncias do MongoDB.
DescribeDBInstanceSwitchLog	DescribeDBInstanceSwitchLog.	Consulta os logs de alternância primário/secundário de uma instância do ApsaraDB for MongoDB.
DescribeDBInstanceAttribute	DescribeDBInstanceAttribute.	Consulta informações sobre uma instância do ApsaraDB for MongoDB.
DescribeRoleZoneInfo	DescribeRoleZoneInfo.	Consulta a função e a zona de cada nó em uma instância do ApsaraDB for MongoDB.
DescribeInstanceAutoRenewalAttribute	DescribeInstanceAutoRenewalAttribute.	Consulta o status de renovação automática de instâncias MongoDB.
DescribeActiveOperationTaskCount	DescribeActiveOperationTaskCount.	Consulta o número de tarefas de operação e manutenção em uma instância do ApsaraDB for MongoDB.
DescribeActiveOperationTasks	DescribeActiveOperationTasks.	Consulta os detalhes das tarefas de O&M para instâncias MongoDB.
DescribeActiveOperationTaskType	DescribeActiveOperationTaskType.	Consulta os tipos de tarefas de Operação e Manutenção e o número de tarefas de cada tipo para uma instância ApsaraDB for MongoDB.
DescribeDBInstancesOverview	DescribeDBInstancesOverview.	Consulta a visão geral de uma ou mais instâncias do ApsaraDB for MongoDB.
DescribeHistoryTasks	DescribeHistoryTasks	Consulta uma lista de tarefas no centro de tarefas.

Gerenciamento de recursos

API	Título	Descrição
DescribeAvailableResource	DescribeAvailableResource.	Consulta os recursos disponíveis na zona especificada.
EvaluateResource	EvaluateResource.	Avalia a disponibilidade de recursos antes de comprar uma nova instância ou alterar a configuração de uma instância existente.
DescribeAvailabilityZones	DescribeAvailabilityZones.	Consulta a lista de zonas suportadas por uma instância ApsaraDB for MongoDB.
ModifyResourceGroup	ModifyResourceGroup.	Move uma instância do ApsaraDB for MongoDB para um grupo de recursos especificado.

Gerenciamento de regiões

API	Título	Descrição
DescribeRegions	DescribeRegions.	Consulta todas as regiões e zonas suportadas para uma instância ApsaraDB for MongoDB.
MigrateToOtherZone	MigrateToOtherZone.	Migra uma instância do ApsaraDB for MongoDB para outra zona.
MigrateAvailableZone	MigrateAvailableZone.	Migra uma instância do ApsaraDB for MongoDB para uma zona específica.

Gerenciamento de conexões

API	Título	Descrição
ModifyInstanceVpcAuthMode	ModifyInstanceVpcAuthMode.	Desativa o acesso sem senha pela Virtual Private Cloud (VPC) para uma instância do ApsaraDB for MongoDB.
ModifyDBInstanceNetworkType	Alterar o tipo de rede de uma instância	Altera o tipo de rede de uma instância do MongoDB.
ModifyDBInstanceConnectionString	ModifyDBInstanceConnectionString.	Modifica o endereço de conexão e a porta de uma instância do MongoDB.
DescribeShardingNetworkAddress	DescribeShardingNetworkAddress.	Obtém as informações de conexão de uma instância de cluster sharded do MongoDB.
AllocatePublicNetworkAddress	AllocatePublicNetworkAddress.	Aloca um endpoint público para uma instância.
ReleasePublicNetworkAddress	ReleasePublicNetworkAddress.	Libera o endpoint público de uma instância do ApsaraDB for MongoDB.
AllocateNodePrivateNetworkAddress	AllocateNodePrivateNetworkAddress.	Solicita um endpoint interno para um nó de shard ou Configserver em uma instância de cluster sharded do ApsaraDB for MongoDB.
ReleaseNodePrivateNetworkAddress	ReleaseNodePrivateNetworkAddress.	Libera o endpoint interno de um shard ou nó Configserver para uma instância de cluster fragmentado.

Gerenciamento de tags

API	Título	Descrição
ListTagResources	ListTagResources	Consulta a relação entre as instâncias do ApsaraDB for MongoDB e as tags.
DescribeTags	DescribeTags.	Consulta todas as tags em uma região especificada.
TagResources	TagResources.	Vincula tags a instâncias do ApsaraDB for MongoDB.
UntagResources	UntagResources.	Remove uma tag se ela não estiver adicionada a outra instância.

Gerenciamento de contas

API	Título	Descrição
CreateAccount	CreateAccount.	Cria uma conta com permissões somente leitura para nós shard em uma instância de cluster fragmentado do ApsaraDB for MongoDB que utiliza discos em nuvem.
ResetAccountPassword	ResetAccountPassword.	Redefine a senha da conta root em uma instância do ApsaraDB for MongoDB.
ModifyAccountDescription	Modificar descrição da conta.	Modifica a descrição da conta root em uma instância ApsaraDB for MongoDB.
DescribeAccounts	DescribeAccounts.	Consulta as contas de banco de dados de uma instância do ApsaraDB for MongoDB.

Listas brancas e grupos de segurança

API	Título	Descrição
ModifySecurityIps	ModifySecurityIps.	Modifica a lista de permissões de endereços IP de uma instância do ApsaraDB for MongoDB.
ModifySecurityGroupConfiguration	ModifySecurityGroupConfiguration.	Modifica o grupo de segurança ECS associado a uma instância do ApsaraDB for MongoDB.
DescribeSecurityIps	DescribeSecurityIps.	Obtém as listas brancas de IP de uma instância do ApsaraDB for MongoDB.
DescribeGlobalSecurityIPGroup	DescribeGlobalSecurityIPGroup.	Consulta o modelo global de lista de permissões de IP de uma instância do ApsaraDB for MongoDB.
ModifyGlobalSecurityIPGroupName	ModifyGlobalSecurityIPGroupName.	Modifica o nome de um modelo global de lista de permissões de IP associado a uma instância do ApsaraDB for MongoDB.
DescribeGlobalSecurityIPGroupRelation	DescribeGlobalSecurityIPGroupRelation.	Consulta o mapeamento entre uma instância e um modelo de lista de permissões de endereços IP global.
CreateGlobalSecurityIPGroup	CreateGlobalSecurityIPGroup.	Cria um modelo de lista de permissões de IP global.
DeleteGlobalSecurityIPGroup	DeleteGlobalSecurityIPGroup.	Exclui um modelo de lista de permissões de endereços IP global.

Chaves

API	Título	Descrição
ModifyDBInstanceTDE	ModifyDBInstanceTDE.	Modifica o status de Transparent Data Encryption (TDE) de uma instância MongoDB.
CheckCloudResourceAuthorized	CheckCloudResourceAuthorized.	Verifica se as chaves do Key Management Service (KMS) estão autorizadas para uma instância do ApsaraDB for MongoDB.
DescribeUserEncryptionKeyList	DescribeUserEncryptionKeyList.	Consulta as chaves personalizadas para uma instância.
DescribeDBInstanceEncryptionKey	DescribeDBInstanceEncryptionKey.	Consulta a chave de criptografia de uma instância do MongoDB.
DescribeDBInstanceTDEInfo	Consulta se o TDE está ativado para uma instância do MongoDB	Consulta se a Criptografia de Dados Transparente (TDE) está ativada para uma instância do ApsaraDB for MongoDB.
DescribeKmsKeys	DescribeKmsKeys.	Consulta as chaves do Key Management Service (KMS) disponíveis para criptografia de disco.

Criptografia SSL

API	Título	Descrição
ModifyDBInstanceSSL	ModifyDBInstanceSSL.	Modifica a configuração SSL de uma instância do MongoDB.
DescribeDBInstanceSSL	DescribeDBInstanceSSL.	Consulta os detalhes da configuração SSL de uma instância do MongoDB.

Logs de auditoria

API	Título	Descrição
ModifyAuditLogFilter	ModifyAuditLogFilter.	Modifica os tipos de log de auditoria coletados para uma instância do MongoDB.
ModifyAuditPolicy	ModifyAuditPolicy.	Ativa ou desativa o log de auditoria de uma instância MongoDB ou modifica o período de retenção do log.
DescribeAuditRecords	DescribeAuditRecords.	Consulta as entradas de log de auditoria de uma instância do MongoDB.
DescribeAuditPolicy	DescribeAuditPolicy.	Verifica se o registro de log de auditoria está ativado para uma instância MongoDB.
DescribeAuditLogFilter	DescribeAuditLogFilter.	Consulta os tipos de log de auditoria coletados para uma instância MongoDB.
DescribeMongoDBLogConfig	DescribeMongoDBLogConfig.	Consulta a configuração do MongoDB Log Service.

Gerenciamento de logs

API	Título	Descrição
DescribeSlowLogRecords	DescribeSlowLogRecords.	Consulta entradas de log de consultas lentas para uma instância MongoDB.
DescribeErrorLogRecords	DescribeErrorLogRecords.	Consulta as entradas de log de erros de uma instância do MongoDB.
DescribeRunningLogRecords	DescribeRunningLogRecords.	Consulta os logs de execução de uma instância do MongoDB.

Monitoramento de desempenho

API	Título	Descrição
ModifyDBInstanceMonitor	ModifyDBInstanceMonitor.	Define a granularidade de coleta de monitoramento para uma instância do MongoDB.
DescribeDBInstancePerformance	DescribeDBInstancePerformance.	Consulta os dados de desempenho de uma instância do MongoDB.
DescribeDBInstanceMonitor	DescribeDBInstanceMonitor.	Consulta a frequência de coleta de dados de monitoramento de uma instância do ApsaraDB for MongoDB.

Gerenciamento de parâmetros

API	Título	Descrição
ModifyParameters	ModifyParameters.	Modifica os parâmetros de uma instância do ApsaraDB for MongoDB.
DescribeParameterModificationHistory	DescribeParameterModificationHistory.	Consulta os registros de modificação de parâmetros de uma instância do ApsaraDB for MongoDB.
DescribeParameterTemplates	DescribeParameterTemplates.	Consulta os modelos de parâmetros padrão para instâncias do MongoDB.
DescribeParameters	DescribeParameters.	Consulta as configurações de parâmetros de uma instância do ApsaraDB for MongoDB.

Backup e recuperação

API	Título	Descrição
CreateBackup	CreateBackup.	Cria um backup para uma instância MongoDB.
ModifyBackupPolicy	ModifyBackupPolicy.	Modifica a política de backup de uma instância do MongoDB.
DescribeBackupPolicy	DescribeBackupPolicy.	Consulta a política de backup de uma instância do MongoDB.
DescribeBackups	DescribeBackups.	Consulta os backups de uma instância MongoDB.
DescribeBackupDBs	DescribeBackupDBs	Consulta os bancos de dados em um horário especificado ou os bancos de dados em um conjunto de backups especificado antes de restaurar um banco de dados para uma instância do ApsaraDB for MongoDB.
DescribeRestoreDBInstanceList	DescribeRestoreDBInstanceList.	Consulta as instâncias do ApsaraDB for MongoDB cujos backups são restaurados em até sete dias.
TransferClusterBackup	TransferClusterBackup.	Alterna o modo de backup de uma instância de cluster fragmentado do ApsaraDB for MongoDB para o modo de backup de cluster. Após a instância ser alternada para o modo de backup de cluster, a instância oferece suporte a backup de alta frequência.
DescribeClusterBackups	DescribeClusterBackups.	Consulta os conjuntos de backup de cluster para uma instância de cluster sharded do ApsaraDB for MongoDB que usa discos em nuvem.
DescribeClusterRecoverTime	Consultar intervalo de tempo restaurável de um cluster fragmentado.	Consulta o intervalo de tempo restaurável de uma instância de cluster fragmentado que utiliza discos em nuvem no ApsaraDB for MongoDB.
DescribeBackupStorage	DescribeBackupStorage.	Consulta o uso de backup de uma instância de conjunto de réplicas ou cluster fragmentado do MongoDB que utiliza discos em nuvem.
DescribeBackupTasks	DescribeBackupTasks.	Consulta os trabalhos de backup em andamento para instâncias de ReplicaSet ou cluster sharded do MongoDB que usam discos em nuvem.
DescribeInstanceRecoverTime	Consulta os intervalos de tempo restauráveis de uma instância de conjunto de réplicas.	Consulta os intervalos de tempo restauráveis de uma instância de conjunto de réplicas do ApsaraDB for MongoDB com discos em nuvem.

Outros

API	Título	Descrição
DescribeActiveOperationTask	DescribeActiveOperationTask.	Consulta as informações detalhadas sobre as tarefas de uma instância do ApsaraDB for MongoDB.
AllocateDBInstanceSrvNetworkAddress	AllocateDBInstanceSrvNetworkAddress.	Solicita uma string de conexão SRV para uma instância do ApsaraDB for MongoDB.
DescribeActiveOperationTaskRegion	Tipos e quantidades de tarefas de manutenção.	Consulta os tipos e o número de tarefas de O&M de uma instância do MongoDB.
DescribeActiveOperationMaintenanceConfig	DescribeActiveOperationMaintenanceConfig.	Consulta a configuração da tarefa de operação e manutenção (O&M) de uma instância do MongoDB.
ModifyDBInstanceConfig	ModifyDBInstanceConfig.	Modifica a configuração da instância.
ModifyDBInstanceAttribute	ModifyDBInstanceAttribute	Modifica a configuração de proteção contra liberação da instância.
ModifySrvNetworkAddress	ModifySrvNetworkAddress.	Modifica o endereço de conexão SRV de uma instância do MongoDB.
CancelActiveOperationTasks	CancelActiveOperationTasks.	Cancela eventos de Operações e Manutenção (O&M) em lote.
CreateNodeRoleTag	CreateNodeRoleTag.	Cria uma tag de função para um nó de instância.
DescribeRdsVSwitchs	DescribeRdsVSwitchs.	Obtém uma lista de vSwitches.
DescribeRdsVpcs	DescribeRdsVpcs.	Obtém uma lista de VPCs.
DescribeRoleTagStatus	DescribeRoleTagStatus.	Descreve o status de uma tag para um nó.
DescribeVpcsForMongoDB	DescribeVpcsForMongoDB.	Consulta uma lista paginada de VPCs.
ModifyActiveOperationMaintenanceConfig	ModifyActiveOperationMaintenanceConfig.	Modifica a configuração da tarefa de Operações e Manutenção (O&M) para uma instância MongoDB.
DescribeBinlogFiles	DescribeBinlogFiles.	Consulta os arquivos de backup de log de uma instância do ApsaraDB for MongoDB.
ModifyBackupExpireTime	ModifyBackupExpireTime.	Modifica o tempo de vida (TTL) de um conjunto de backups do MongoDB.
DeleteBackup	DeleteBackup.	Exclui um conjunto de backup do MongoDB.

Others

API	Título	Descrição
CheckRecoveryCondition	CheckRecoveryCondition.	Consulta se os dados de uma instância ApsaraDB for MongoDB podem ser restaurados.
CheckServiceLinkedRole	CheckServiceLinkedRole.	Verifica se uma função vinculada a serviço (SLR) foi criada para uma instância.
DescribeHistoryTasksStat	DescribeHistoryTasksStat.	Consulta a visão geral de uma tarefa no centro de tarefas.
DescribeSecurityGroupConfiguration	DescribeSecurityGroupConfiguration.	Consulta os grupos de segurança do Elastic Compute Service (ECS) associados a uma instância do ApsaraDB for MongoDB.
DestroyInstance	DestroyInstance.	Destrói uma instância do ApsaraDB for MongoDB.
ModifyActiveOperationTasks	ModifyActiveOperationTasks.	Modifica o horário de alternância de tarefas de O&M agendadas para uma instância do ApsaraDB for MongoDB.
ModifyGlobalSecurityIPGroup	ModifyGlobalSecurityIPGroup.	Modifica o modelo global de lista de permissões de IP associado a uma instância do ApsaraDB for MongoDB.
ModifyGlobalSecurityIPGroupRelation	ModifyGlobalSecurityIPGroupRelation.	Modifica o mapeamento entre um modelo de lista de permissões global e uma instância do ApsaraDB for MongoDB.
ModifyInstanceAutoRenewalAttribute	ModifyInstanceAutoRenewalAttribute.	Ativa ou desativa a renovação automática para uma instância do ApsaraDB for MongoDB.
ModifyTaskInfo	Modificação de informações da tarefa.	Modifica as informações de uma tarefa na central de tarefas de uma instância do ApsaraDB for MongoDB.
UpgradeDBInstanceKernelVersion	UpgradeDBInstanceKernelVersion.	Atualiza a versão secundária de uma instância ApsaraDB for MongoDB.