Descripción general de la API - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Estándares de API y SDK preconfigurados multilenguaje

La OpenAPI de este producto (Dds/2015-12-01) utiliza el estilo de firma RPC. Se han encapsulado SDK para los lenguajes de programación más comunes con el fin de facilitar el desarrollo. Los desarrolladores pueden descargar el SDK para invocar directamente la OpenAPI de este producto sin preocuparse por los detalles técnicos. Si el SDK existente no satisface sus necesidades, utilice el mecanismo de firma para una integración con autofirma. Dado que los detalles de la autofirma son muy complejos, este proceso puede tardar alrededor de 5 días hábiles. Por lo tanto, se recomienda unirse a nuestro grupo de servicio de DingTalk (147535001692) para llevar a cabo la integración de firmas bajo la guía de expertos.

Antes de usar la API, prepare su cuenta de identidad y su clave de acceso (AccessKey) para acceder eficazmente a la API mediante herramientas cliente (como SDK y CLI). Para obtener más información, consulte Obtener un AccessKey.

Escenarios de firma personalizada

Si su escenario empresarial tiene requisitos especiales y necesita integrar la API mediante autofirma, se recomienda consultar primero a nuestro equipo de soporte técnico (grupo de servicio de DingTalk: 147535001692) para obtener orientación profesional y garantizar una integración eficiente.

Preparación de cuenta y seguridad

Las cuentas de Alibaba Cloud tienen permisos administrativos completos sobre todos los recursos. Si un AccessKey se ve comprometido, todos los recursos asociados corren el riesgo de sufrir accesos no autorizados. Para garantizar la seguridad, se recomienda crear un RAM user con permisos de acceso exclusivos a la API y configurar su AccessKey, además de establecer directivas de RAM basadas en el principio de menor privilegio (PoLP). Utilice la cuenta de Alibaba Cloud únicamente en escenarios específicos donde se requieran explícitamente sus permisos.

Crear o clonar instancias

API	Título	Descripción
CreateDBInstance	Crear o clonar una instancia de conjunto de réplicas.	Crea o clona una instancia de conjunto de réplicas de ApsaraDB for MongoDB.
CreateShardingDBInstance	Crear o clonar una instancia de clúster fragmentado.	Crea o clona una instancia de clúster fragmentado de ApsaraDB for MongoDB.

Cambiar configuraciones de instancia

API	Título	Descripción
CreateNode	CreateNode.	Agrega un nodo shard o un nodo mongos a una instancia de clúster fragmentado de ApsaraDB for MongoDB.
CreateNodeBatch	CreateNodeBatch.	Agrega nodos mongos o shard en lote para una instancia de clúster fragmentado.
DeleteNode	DeleteNode.	Elimina un nodo shard o mongos de una instancia de clúster fragmentado de ApsaraDB for MongoDB.
ModifyDBInstanceSpec	ModifyDBInstanceSpec.	Cambia el tipo de instancia o el espacio de almacenamiento para instancias independientes, de conjunto de réplicas o serverless de ApsaraDB for MongoDB. Las instancias serverless están disponibles exclusivamente en el sitio web de Alibaba Cloud China.
ModifyNodeSpec	Cambia las especificaciones y la capacidad de almacenamiento de un nodo de una instancia de clúster fragmentado.	Cambia las especificaciones y la capacidad de almacenamiento de un nodo de una instancia de clúster fragmentado de ApsaraDB for MongoDB.
ModifyNodeSpecBatch	ModifyNodeSpecBatch.	Cambia la configuración de uno o más nodos Mongos o shard en una instancia de clúster fragmentado de ApsaraDB for MongoDB.
ModifyDBInstanceDiskType	ModifyDBInstanceDiskType.	Modifica el tipo de disco de una instancia de ApsaraDB for MongoDB.

Gestión de instancias

API	Título	Descripción
DeleteDBInstance	DeleteDBInstance.	Libera una instancia de MongoDB de pago por uso.
ModifyDBInstanceMaintainTime	ModifyDBInstanceMaintainTime.	Modifica la ventana de mantenimiento de una instancia de ApsaraDB for MongoDB.
ModifyDBInstanceDescription	ModifyDBInstanceDescription.	Modifica el nombre de una instancia de ApsaraDB for MongoDB.
ModifyDBInstanceNetExpireTime	ModifyDBInstanceNetExpireTime.	Extiende el período de retención del endpoint de red clásica de una instancia de ApsaraDB for MongoDB.
UpgradeDBInstanceEngineVersion	UpgradeDBInstanceEngineVersion.	Actualiza la versión de la base de datos de una instancia de ApsaraDB for MongoDB.
UpgradeDBInstanceKernelVersion	UpgradeDBInstanceKernelVersion.	Actualiza la versión menor de una instancia de ApsaraDB for MongoDB.
SwitchDBInstanceHA	SwitchDBInstanceHA.	Cambia los nodos primario y secundario de una instancia de ApsaraDB for MongoDB.
RestartDBInstance	Reiniciar una instancia de ApsaraDB for MongoDB.	Reinicia una instancia de ApsaraDB for MongoDB.
DestroyInstance	DestroyInstance.	Destruye una instancia de ApsaraDB for MongoDB.
RestartNode	Reiniciar un solo nodo de una instancia de MongoDB.	Reinicia un solo nodo de una instancia de ApsaraDB for MongoDB.

Gestión de renovaciones

API	Título	Descripción
ModifyInstanceAutoRenewalAttribute	ModifyInstanceAutoRenewalAttribute.	Habilita o deshabilita la renovación automática para una instancia de ApsaraDB for MongoDB.
TransformInstanceChargeType	TransformInstanceChargeType.	Cambia el método de facturación de una instancia de pago por uso a suscripción o de suscripción a pago por uso.
DescribePrice	Consulta de precios.	Consulta la información de precios.
DescribeRenewalPrice	DescribeRenewalPrice.	Obtiene el precio de renovación de una instancia específica de MongoDB por un mes.
TransformToPrePaid	TransformToPrePaid.	Cambia el método de facturación de una instancia de ApsaraDB for MongoDB de pago por uso a suscripción.
RenewDBInstance	RenewDBInstance.	Renueva manualmente una instancia de suscripción de ApsaraDB for MongoDB.

Consultar instancias

API	Título	Descripción
DescribeDBInstanceSpecInfo	DescribeDBInstanceSpecInfo.	Obtiene los detalles del tipo de instancia.
DescribeReplicaSetRole	DescribeReplicaSetRole.	Obtiene la información de roles y los detalles de conexión de una instancia de MongoDB.
DescribeKernelReleaseNotes	DescribeKernelReleaseNotes.	Consulta las notas de la versión de las versiones menores de una instancia de ApsaraDB for MongoDB.
DescribeAvailableEngineVersion	DescribeAvailableEngineVersion.	Consulta las versiones del motor a las que se puede actualizar una instancia de ApsaraDB for MongoDB.
DescribeDBInstances	Consulta de la lista de instancias de MongoDB.	Consulta la lista de instancias de MongoDB.
DescribeDBInstanceSwitchLog	DescribeDBInstanceSwitchLog.	Consulta los registros de conmutación entre primario y secundario de una instancia de ApsaraDB for MongoDB.
DescribeDBInstanceAttribute	Consulta información sobre una instancia de ApsaraDB for MongoDB.	Consulta la información sobre una instancia de ApsaraDB for MongoDB.
DescribeRoleZoneInfo	DescribeRoleZoneInfo.	Consulta el rol y la zona de cada nodo en una instancia de ApsaraDB for MongoDB.
DescribeInstanceAutoRenewalAttribute	DescribeInstanceAutoRenewalAttribute.	Consulta el estado de renovación automática de instancias de MongoDB.
DescribeActiveOperationTaskCount	Consultar el recuento de tareas activas de O&M.	Consulta el número de tareas activas de operación y mantenimiento en una instancia de ApsaraDB for MongoDB.
DescribeActiveOperationTasks	DescribeActiveOperationTasks.	Consulta los detalles de las tareas de operaciones y mantenimiento para instancias de MongoDB.
DescribeActiveOperationTaskType	DescribeActiveOperationTaskType.	Consulta los tipos de tareas de operación y mantenimiento y la cantidad de tareas de cada tipo para una instancia de ApsaraDB for MongoDB.
DescribeDBInstancesOverview	DescribeDBInstancesOverview.	Consulta la información general de una o más instancias de ApsaraDB for MongoDB.
DescribeHistoryTasks	DescribeHistoryTasks.	Consulta una lista de tareas en el centro de tareas.
DescribeHistoryTasksStat	DescribeHistoryTasksStat.	Consulta la información general de una tarea en el centro de tareas.
ModifyTaskInfo	ModifyTaskInfo.	Modifica la información de una tarea en el centro de tareas para una instancia de ApsaraDB for MongoDB.
ModifyActiveOperationTasks	ModifyActiveOperationTasks.	Modifica la hora de cambio de las tareas programadas de O\&M para una instancia de ApsaraDB for MongoDB.

Gestión de recursos

API	Título	Descripción
DescribeAvailableResource	DescribeAvailableResource.	Consulta los recursos disponibles en la zona especificada.
EvaluateResource	EvaluateResource.	Evalúa la disponibilidad de recursos antes de comprar una nueva instancia o cambiar la configuración de una instancia existente.
DescribeAvailabilityZones	DescribeAvailabilityZones.	Consulta una lista de las zonas compatibles con una instancia de ApsaraDB for MongoDB.
ModifyResourceGroup	ModifyResourceGroup.	Mueve una instancia de ApsaraDB for MongoDB a un grupo de recursos especificado.

Gestión de regiones

API	Título	Descripción
DescribeRegions	DescribeRegions.	Consulta todas las regiones y zonas admitidas para una instancia de ApsaraDB for MongoDB.
MigrateToOtherZone	MigrateToOtherZone.	Migra una instancia de ApsaraDB for MongoDB a otra zona.
MigrateAvailableZone	MigrateAvailableZone.	Migra una instancia de ApsaraDB for MongoDB a una zona específica.

Gestión de conexiones

API	Título	Descripción
ModifyInstanceVpcAuthMode	ModifyInstanceVpcAuthMode.	Deshabilita el acceso sin contraseña a través de una red privada virtual (VPC) para una instancia de ApsaraDB for MongoDB.
ModifyDBInstanceNetworkType	Cambiar el tipo de red de una instancia.	Cambia el tipo de red de una instancia de MongoDB.
ModifyDBInstanceConnectionString	ModifyDBInstanceConnectionString.	Modifica la dirección de conexión y el puerto de una instancia de MongoDB.
DescribeShardingNetworkAddress	DescribeShardingNetworkAddress.	Obtiene la información de conexión de una instancia de clúster fragmentado de MongoDB.
AllocatePublicNetworkAddress	AllocatePublicNetworkAddress.	Asigna un endpoint público a una instancia.
ReleasePublicNetworkAddress	ReleasePublicNetworkAddress.	Libera el endpoint público de una instancia de ApsaraDB for MongoDB.
AllocateNodePrivateNetworkAddress	AllocateNodePrivateNetworkAddress.	Solicita un endpoint interno para un nodo shard o Configserver en una instancia de clúster fragmentado de ApsaraDB for MongoDB.
ReleaseNodePrivateNetworkAddress	ReleaseNodePrivateNetworkAddress.	Libera el endpoint interno de un nodo shard o Configserver para una instancia de clúster fragmentado.

Gestión de etiquetas

API	Título	Descripción
ListTagResources	ListTagResources.	Consulta la relación entre las instancias de ApsaraDB for MongoDB y las etiquetas.
DescribeTags	DescribeTags.	Consulta todas las etiquetas en una región especificada.
TagResources	TagResources.	Vincula etiquetas a instancias de ApsaraDB for MongoDB.
UntagResources	UntagResources.	Elimina una etiqueta si la etiqueta no está agregada a otra instancia.

Gestión de cuentas

API	Título	Descripción
CreateAccount	CreateAccount.	Crea una cuenta con permisos de solo lectura para nodos shard en una instancia de clúster fragmentado de ApsaraDB for MongoDB que utiliza discos en la nube.
ResetAccountPassword	ResetAccountPassword.	Restablece la contraseña de la cuenta root en una instancia de ApsaraDB for MongoDB.
ModifyAccountDescription	ModifyAccountDescription.	Modifica la descripción de la cuenta raíz en una instancia de ApsaraDB for MongoDB.
DescribeAccounts	DescribeAccounts.	Consulta las cuentas de base de datos de una instancia de ApsaraDB for MongoDB.

Listas blancas y grupos de seguridad

API	Título	Descripción
ModifySecurityIps	Establecer la lista blanca de IP para acceder a una instancia.	Modifica la lista blanca de IP de una instancia de MongoDB.
ModifySecurityGroupConfiguration	ModifySecurityGroupConfiguration.	Modifica el security group de ECS vinculado a una instancia de ApsaraDB for MongoDB.
DescribeSecurityIps	DescribeSecurityIps.	Obtiene las listas blancas de IP de una instancia de ApsaraDB for MongoDB.
DescribeSecurityGroupConfiguration	DescribeSecurityGroupConfiguration.	Consulta los security groups de Elastic Compute Service (ECS) asociados a una instancia de ApsaraDB for MongoDB.
ModifyGlobalSecurityIPGroup	ModifyGlobalSecurityIPGroup.	Modifica la plantilla global de lista blanca de IP asociada a una instancia de ApsaraDB for MongoDB.
DescribeGlobalSecurityIPGroup	DescribeGlobalSecurityIPGroup.	Consulta la plantilla global de lista blanca de IP de una instancia de ApsaraDB for MongoDB.
ModifyGlobalSecurityIPGroupName	ModifyGlobalSecurityIPGroupName.	Modifica el nombre de una plantilla global de lista blanca de IP asociada a una instancia de ApsaraDB for MongoDB.
DescribeGlobalSecurityIPGroupRelation	DescribeGlobalSecurityIPGroupRelation.	Consulta la asignación entre una instancia y una plantilla de lista blanca global de direcciones IP.
CreateGlobalSecurityIPGroup	CreateGlobalSecurityIPGroup.	Crea una plantilla de lista blanca de IP global.
ModifyGlobalSecurityIPGroupRelation	ModifyGlobalSecurityIPGroupRelation.	Modifica la asignación entre una plantilla de lista blanca global y una instancia de ApsaraDB for MongoDB.
DeleteGlobalSecurityIPGroup	DeleteGlobalSecurityIPGroup.	Elimina una plantilla de lista blanca de direcciones IP globales.

Claves

API	Título	Descripción
ModifyDBInstanceTDE	ModifyDBInstanceTDE.	Modifica el estado del cifrado de datos transparente (TDE) de una instancia de MongoDB.
CheckCloudResourceAuthorized	CheckCloudResourceAuthorized.	Verifica si las claves de Key Management Service (KMS) están autorizadas para una instancia de ApsaraDB for MongoDB.
DescribeUserEncryptionKeyList	DescribeUserEncryptionKeyList.	Consulta las claves personalizadas de una instancia.
DescribeDBInstanceEncryptionKey	DescribeDBInstanceEncryptionKey.	Consulta la clave de cifrado de una instancia de MongoDB.
DescribeDBInstanceTDEInfo	Consultar si TDE está habilitado para una instancia de MongoDB.	Consulta si el cifrado transparente de datos (TDE) está habilitado para una instancia de ApsaraDB for MongoDB.
DescribeKmsKeys	DescribeKmsKeys.	Consulta las claves de Key Management Service (KMS) disponibles para el cifrado de discos.

Cifrado SSL

API	Título	Descripción
ModifyDBInstanceSSL	ModifyDBInstanceSSL.	Modifica la configuración SSL de una instancia de MongoDB.
DescribeDBInstanceSSL	Consulta de los detalles de configuración SSL de una instancia de MongoDB.	Consulta los detalles de la configuración SSL de una instancia de MongoDB.

Registros de auditoría

API	Título	Descripción
ModifyAuditLogFilter	Modificar los tipos de recopilación de registros de auditoría para una instancia.	Modifica los tipos de recopilación de registros de auditoría para una instancia de ApsaraDB for MongoDB.
ModifyAuditPolicy	ModifyAuditPolicy.	Habilita o deshabilita el registro de auditoría para una instancia de MongoDB, o modifica el período de retención del registro.
DescribeAuditRecords	Consulta de registros de auditoría de una instancia.	Consulta los registros de auditoría de una instancia de ApsaraDB for MongoDB.
DescribeAuditPolicy	DescribeAuditPolicy.	Verifica si el registro de auditoría está habilitado para una instancia de MongoDB.
DescribeAuditLogFilter	DescribeAuditLogFilter.	Consulta los tipos de registros de auditoría recopilados para una instancia de MongoDB.
DescribeMongoDBLogConfig	DescribeMongoDBLogConfig.	Consulta la configuración del servicio de registros de MongoDB.

Gestión de registros

API	Título	Descripción
DescribeSlowLogRecords	DescribeSlowLogRecords.	Consulta las entradas del registro de consultas lentas para una instancia de MongoDB.
DescribeErrorLogRecords	Consulta de los registros de error de una instancia.	Consulta los registros de error de una instancia de ApsaraDB for MongoDB.
DescribeRunningLogRecords	Consulta de registros de ejecución de la instancia.	Consulta los registros de ejecución de una instancia de ApsaraDB for MongoDB.

Monitoreo de rendimiento

API	Título	Descripción
ModifyDBInstanceMonitor	ModifyDBInstanceMonitor.	Establece la granularidad de recopilación de monitoreo para una instancia de MongoDB.
DescribeDBInstancePerformance	DescribeDBInstancePerformance.	Consulta los datos de rendimiento de una instancia de MongoDB.
DescribeDBInstanceMonitor	DescribeDBInstanceMonitor.	Consulta la frecuencia de recopilación de datos de monitoreo para una instancia de ApsaraDB for MongoDB.

Gestión de parámetros

API	Título	Descripción
ModifyParameters	ModifyParameters.	Modifica los parámetros de una instancia de ApsaraDB for MongoDB.
DescribeParameterModificationHistory	DescribeParameterModificationHistory.	Consulta los registros de modificación de parámetros de una instancia de ApsaraDB for MongoDB.
DescribeParameterTemplates	DescribeParameterTemplates.	Consulta las plantillas de parámetros predeterminadas para instancias de MongoDB.
DescribeParameters	DescribeParameters.	Consulta la configuración de parámetros de una instancia de ApsaraDB for MongoDB.

Copia de seguridad y recuperación

API	Título	Descripción
ModifyAdvancedBackupStatus	Habilitar copia de seguridad avanzada.	Habilita la copia de seguridad avanzada.
ModifyAdvancedBackupPolicy	Modificar la política de copia de seguridad avanzada.	Modifica la política de copia de seguridad avanzada.
DescribeAdvancedBackupStatus	Consultar si la copia de seguridad avanzada está habilitada.	Consulta si la copia de seguridad avanzada está habilitada.
DescribeAdvancedBackupPolicy	Consulta de la política de respaldo avanzada.	Consulta la política de respaldo avanzada.
CreateBackup	CreateBackup.	Crea una copia de seguridad para una instancia de MongoDB.
ModifyBackupPolicy	ModifyBackupPolicy.	Modifica la política de respaldo de una instancia de MongoDB.
DescribeBackupPolicy	DescribeBackupPolicy.	Consulta la política de respaldo de una instancia de MongoDB.
DescribeBackups	Consulta la lista de backups de una instancia.	Consulta la lista de backups de una instancia de ApsaraDB for MongoDB.
DescribeBackupDBs	DescribeBackupDBs.	Consulta las bases de datos en un momento específico o las bases de datos en un conjunto de respaldo especificado antes de restaurar una base de datos para una instancia de ApsaraDB for MongoDB.
DescribeRestoreDBInstanceList	DescribeRestoreDBInstanceList.	Consulta las instancias de ApsaraDB for MongoDB cuyas copias de seguridad se restauraron en los últimos siete días.
CheckRecoveryCondition	CheckRecoveryCondition.	Consulta si los datos de una instancia de ApsaraDB for MongoDB se pueden restaurar.
TransferClusterBackup	TransferClusterBackup.	Cambia el modo de respaldo de una instancia de clúster fragmentado de ApsaraDB for MongoDB al modo de respaldo de clúster. Después de cambiar la instancia al modo de respaldo de clúster, la instancia admite respaldos de alta frecuencia.
DescribeClusterBackups	DescribeClusterBackups.	Consulta los conjuntos de respaldo de clúster para una instancia de clúster fragmentado de ApsaraDB for MongoDB que utiliza discos en la nube.
DescribeClusterRecoverTime	Consulta del intervalo de tiempo restaurable de un clúster fragmentado.	Consulta el intervalo de tiempo restaurable de una instancia de clúster fragmentado que utiliza discos en la nube en ApsaraDB for MongoDB.
DescribeBackupStorage	DescribeBackupStorage.	Consulta el uso de copias de seguridad para una instancia de réplica set o clúster fragmentado de MongoDB que utiliza discos en la nube.
DescribeBackupTasks	DescribeBackupTasks.	Consulta los trabajos de respaldo en curso para instancias de ReplicaSet o clúster fragmentado de MongoDB que utilizan discos en la nube.
DescribeInstanceRecoverTime	Consulta de intervalos de tiempo restaurables de una instancia de conjunto de réplica.	Consulta los intervalos de tiempo restaurables de una instancia de conjunto de réplica de ApsaraDB for MongoDB con discos en la nube.

Otros

API	Título	Descripción
DescribeActiveOperationTask	DescribeActiveOperationTask.	Consulta la información detallada sobre las tareas de una instancia de ApsaraDB for MongoDB.
AllocateDBInstanceSrvNetworkAddress	AllocateDBInstanceSrvNetworkAddress.	Solicita una cadena de conexión SRV para una instancia de ApsaraDB for MongoDB.
DescribeActiveOperationTaskRegion	Consulta de tipos de tareas de mantenimiento y cantidades de tareas.	Consulta los tipos y la cantidad de tareas de operación y mantenimiento para una instancia de MongoDB.
DescribeActiveOperationMaintenanceConfig	DescribeActiveOperationMaintenanceConfig.	Consulta la configuración de tareas de operación y mantenimiento (O&M) para una instancia de MongoDB.
CheckServiceLinkedRole	CheckServiceLinkedRole.	Verifica si se ha creado un rol vinculado a servicio (SLR) para una instancia.
ModifyDBInstanceConfig	ModifyDBInstanceConfig.	Modifica la configuración de la instancia.
ModifyDBInstanceAttribute	ModifyDBInstanceAttribute.	Modifica la configuración de protección contra liberación de la instancia.
ModifySrvNetworkAddress	Modificar dirección de red SRV.	Modifica la dirección de conexión SRV de una instancia de MongoDB.
CancelActiveOperationTasks	CancelActiveOperationTasks.	Cancela eventos de operaciones y mantenimiento (O&M) en lote.
CreateNodeRoleTag	Crear una etiqueta de rol de nodo.	Crea una etiqueta de rol para un nodo de instancia.
DescribeRdsVSwitchs	DescribeRdsVSwitchs.	Obtiene una lista de vSwitches.
DescribeRdsVpcs	DescribeRdsVpcs.	Obtiene una lista de VPCs.
DescribeRoleTagStatus	DescribeRoleTagStatus.	Describe el estado de una etiqueta para un nodo.
DescribeVpcsForMongoDB	DescribeVpcsForMongoDB.	Consulta una lista paginada de VPC.
ModifyActiveOperationMaintenanceConfig	ModifyActiveOperationMaintenanceConfig.	Modifica la configuración de tareas de operaciones y mantenimiento (O&M) para una instancia de MongoDB.
DescribeBinlogFiles	DescribeBinlogFiles.	Consulta los archivos de respaldo de registros para una instancia de ApsaraDB for MongoDB.
ModifyBackupExpireTime	ModifyBackupExpireTime.	Modifica el tiempo de vida (TTL) de un conjunto de copias de seguridad de MongoDB.
DeleteBackup	DeleteBackup.	Elimina un conjunto de copias de seguridad de MongoDB.