Descripción general de la API - Hologres - Centro de documentación de Alibaba Cloud

Estándares de API y SDK preconfigurados multilenguaje

La OpenAPI de este producto (Hologram/2022-06-01) utiliza el estilo de firma ROA. 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.

Actualización

API	Título	Descripción
GetUpgradeable	Consultar si una instancia se puede actualizar.	Consulta si una instancia se puede actualizar.
GetUpgradeStatus	Consulta del estado de actualización.	Consulta el estado de la actualización.
GetLastUpgradeRecord	Consulta del registro de actualización.	Obtiene el historial de la última actualización.
ListUpgradeReleaseVersions	Listar versiones actualizables.	Obtiene la lista de versiones disponibles para actualización.
UpdateAutoUpgrade	Habilitar actualización automática de versión secundaria.	Habilita las actualizaciones automáticas de versiones secundarias. Una vez habilitada esta función, la instancia se actualiza automáticamente durante la ventana de tiempo.
UpgradeInstance	Actualizar una instancia.	Actualiza una instancia. Si la preparación es exitosa, la instancia puede iniciar la actualización directamente.
UpdateOperationEventScheduleTime	Actualiza la hora de ejecución del evento de O&M.	Modifica la hora de ejecución de un evento de O&M.
UpdateMaintenanceWindow	Establecer ventana de mantenimiento.	Establece la ventana de mantenimiento de una instancia para programar el mantenimiento del sistema.
PrepareUpgrade	PrepareUpgrade.	Prepara una instancia para una actualización mediante la ejecución de una evaluación previa a la actualización. Solo puede actualizar la instancia si la evaluación se aprueba. Si no se aprueba, póngase en contacto con el soporte técnico para realizar una actualización manual.
DiscardUpgrade	DiscardUpgrade.	Cancela una actualización. Solo puede llamar a esta operación si la tarea de actualización no ha comenzado o se encuentra en el estado `pre_check`. No es posible cancelar la actualización después de que la tarea entre en el estado `backup` o en cualquier estado posterior.

Etiquetas

API	Título	Descripción
UntagResources	UntagResources.	Elimina etiquetas de una o más instancias.
TagResources	TagResources.	Agrega etiquetas a uno o más recursos.
DescribeTags	DescribeTags.	Lista todas las etiquetas.

Ejecución de SQL

API	Título	Descripción
GetExecuteStatementEnabled	GetExecuteStatementEnabled.	Verifica si una instancia de Hologres especificada permite la ejecución de SQL a través de OpenAPI.
ExecuteStatement	ExecuteStatement.	Ejecuta una instrucción SQL de forma síncrona en una base de datos especificada a través de OpenAPI y devuelve el resultado.
EnableExecuteStatement	EnableExecuteStatement.	Habilita la ejecución de SQL mediante OpenAPI para una instancia de Hologres especificada.
DisableExecuteStatement	Deshabilitar la función executeStatement para una instancia.	Deshabilita los permisos de acceso a la API ExecuteStatement para una instancia de Hologres especificada.

Modelos grandes

API	Título	Descripción
ListInstanceModel	Lista de recursos de nodos de IA.	Consulta la lista de recursos de nodos de IA.
UpdateModelService	UpdateModelService.	Actualiza un servicio de modelo. Esta operación solo aplica a Hologres AI.
ListModelCatalog	Enumera los modelos.	Enumera los modelos.
CreateModelService	CreateModelService.	Crea un servicio de modelo que permite a las funciones de IA invocar modelos. Puede crear un servicio para dos tipos de modelos: un modelo de Alibaba Cloud Model Studio o un modelo en un nodo de IA de Hologres. Si utiliza un nodo de IA de Hologres, debe adquirir los recursos del nodo de IA por separado.
DeleteModelResource	DeleteModelResource.	Elimina un recurso de modelo. Esta acción elimina permanentemente todos los modelos desplegados en el nodo.
DeleteModelService	DeleteModelService.	Elimina un servicio de modelo especificado.
GetInstanceModel	Detalles de los modelos desplegados en la instancia.	Consulta la lista de servicios de modelos de gran tamaño vinculados a una instancia de Hologres.

Bases de datos

API	Título	Descripción
CreateDatabase	CreateDatabase.	Crea una base de datos.
CreateExternalDatabase	Crear una base de datos externa.	Crea una base de datos externa.
CreateUser	CreateUser.	Agrega un usuario de RAM o una cuenta STS a una instancia de Hologres. Una vez agregada, la cuenta se puede utilizar para iniciar sesión en la instancia.
DropUser	DropUser.	Elimina un usuario de RAM o una cuenta STS de una instancia de Hologres. Una vez eliminado, el usuario ya no puede iniciar sesión en la instancia. Para restaurar el acceso, llame a la operación CreateUser para agregar al usuario.
RevokeTablePermission	Revocar la autorización de la tabla.	Revoca la autorización de la tabla.
RevokeSchemaPermission	RevokeSchemaPermission.	Revoca permisos sobre un esquema de un usuario especificado dentro de una instancia de Hologres.
RevokeDatabasePermission	RevokeDatabasePermission.	Revoca permisos sobre una base de datos de un usuario especificado dentro de una instancia de Hologres.
ListDatabases	ListDatabases.	Consulta las bases de datos en una instancia de Hologres.
GrantTablePermission	Conceder permisos de tabla.	Concede permisos sobre una tabla de base de datos.
GrantSchemaPermission	GrantSchemaPermission.	Otorga permisos sobre un esquema a un usuario especificado dentro de una instancia de Hologres.
GrantDatabasePermission	GrantDatabasePermission.	Otorga permisos sobre una base de datos a un usuario especificado dentro de una instancia de Hologres.

Instancias

API	Título	Descripción
BindLeaderInstance	BindLeaderInstance.	Vincula una instancia seguidora a una instancia líder.
ListLeaderInstances	Obtiene la lista de instancias primarias.	Obtiene la lista de posibles ID de instancias primarias.
ListFollowerInstances	Lista de instancias secundarias.	Obtiene las instancias secundarias de solo lectura de una instancia principal de Hologres especificada.
UnBindLeaderInstance	UnBindLeaderInstance.	Desvincula una instancia de solo lectura de su instancia principal.
CreateInstance	CreateInstance.	Crea una instancia de Hologres en la región especificada.
DeleteInstance	Eliminar una instancia.	Libera una instancia.
RenewInstance	RenewInstance.	Renueva una instancia de Hologres por suscripción. También puede habilitar la renovación automática mensual.
RestartInstance	RestartInstance.	Reinicia una instancia de Hologres.
ResumeInstance	ResumeInstance.	Reanuda una instancia en pausa.
UpdateInstanceName	UpdateInstanceName.	Cambia el nombre de una instancia.
UpdateInstanceNetworkType	Modificar el tipo de red de una instancia.	Modifica el tipo de red de una instancia.
DisableHiveAccess	DisableHiveAccess.	Deshabilita la aceleración de data lake.
EnableHiveAccess	EnableHiveAccess.	Habilita la aceleración de data lake para una instancia de Hologres.
StopInstance	StopInstance.	Detiene una instancia en ejecución.
ScaleInstance	ScaleInstance.	Cambia las especificaciones y el espacio de almacenamiento de una instancia de Hologres.
ChangeResourceGroup	Cambiar grupo de recursos.	Actualiza el grupo de recursos de una instancia de Hologres.
ListInstances	Obtención de la lista de instancias.	Obtiene una lista de instancias.
GetInstance	Obtener detalles de la instancia.	Obtiene los detalles de una instancia.

Grupos de cómputo

API	Título	Descripción
UpdateWarehouseScheduleTask	Actualización del plan de escalado elástico programado para un grupo de cómputo.	Actualiza el plan de escalado elástico programado para un grupo de cómputo.
ListWarehouseScheduleTask	Lista de planes de escalado elástico basados en tiempo para grupos de cómputo.	Obtiene la lista de todas las tareas de los planes de escalado elástico basados en tiempo para los grupos de cómputo de una instancia especificada.
ListWarehouseScheduleEvent	ListWarehouseScheduleEvent.	Obtiene los eventos de programación elástica para una instancia y un rango de tiempo especificados.
CreateWarehouse	CreateWarehouse.	Crea un almacén.
CreateHoloWarehouse	CreateHoloWarehouse.	Crea un almacén virtual.
DeleteHoloWarehouse	DeleteHoloWarehouse.	Elimina un almacén virtual.
RebalanceHoloWarehouse	RebalanceHoloWarehouse.	Reequilibra los fragmentos en un almacén virtual.
ResumeHoloWarehouse	ResumeHoloWarehouse.	Reanuda un almacén virtual del estado Stopped a Running.
SuspendHoloWarehouse	SuspendHoloWarehouse.	Detiene un almacén virtual.
RenameHoloWarehouse	RenameHoloWarehouse.	Cambia el nombre de un almacén virtual.
ScaleHoloWarehouse	ScaleHoloWarehouse.	Escala un almacén de datos virtual.
RestartHoloWarehouse	RestartHoloWarehouse.	Reinicia un almacén virtual.
GetWarehouseDetail	GetWarehouseDetail.	Obtiene los detalles de un almacén virtual.
CreateWarehouseScheduleTask	Crear un plan de escalado elástico basado en tiempo.	Crea un plan de escalado elástico basado en tiempo.
ListWarehouses	ListWarehouses.	Obtiene una lista de almacenes virtuales.
DisableWarehouseAutoScale	DisableWarehouseAutoScale.	Deshabilita el escalado automático para un grupo de cómputo especificado.
DeleteWarehouseScheduleTask	DeleteWarehouseScheduleTask.	Elimina una tarea de programación de almacén.
EnableWarehouseAutoScale	EnableWarehouseAutoScale.	Habilita el escalado automático para un almacén.

Copias de seguridad

API	Título	Descripción
UpdateScheduledBackupConfig	UpdateScheduledBackupConfig.	Esta operación configura una política de respaldo para una instancia. Puede establecer un programa semanal para respaldar una instancia en días específicos, por ejemplo, cada lunes, miércoles y viernes a las 20:00:00. También puede especificar el número de respaldos completados que se deben conservar. El sistema elimina automáticamente los respaldos caducados.
UpdateBackupDataDesc	UpdateBackupDataDesc.	Actualiza la descripción de una copia de seguridad.
CreateManualBackup	CreateManualBackup.	Crea una copia de seguridad manual para una instancia.
ListBackupData	ListBackupData.	Obtiene una lista de instantáneas. Cada instantánea representa una copia de seguridad puntual que se puede utilizar para restaurar una nueva instancia con todos sus datos.
DeleteBackupData	DeleteBackupData.	Elimina una copia de seguridad.
GetScheduledBackupConfig	GetScheduledBackupConfig.	Obtiene la configuración de respaldo.

Seguridad

API	Título	Descripción
UpdateInstancePort	UpdateInstancePort.	Actualiza el puerto de una instancia.
UpdateHoloWebLoginSetting	UpdateHoloWebLoginSetting.	Modifica la configuración de inicio de sesión para holoweb.
GetHoloWebLoginSetting	GetHoloWebLoginSetting.	Obtiene la configuración de inicio de sesión de cuentas externas para HoloWeb.
DisableSupportAccount	DisableSupportAccount.	Deshabilita una cuenta de soporte.
EnableSupportAccount	Habilitación de la cuenta de servicio.	Habilita la cuenta de servicio.
EnableSSL	EnableSSL.	Habilita el cifrado SSL para una instancia de Hologres.
DisableSSL	DisableSSL.	Deshabilita el cifrado SSL para una instancia de Hologres.
GetCertificateAttribute	GetCertificateAttribute.	Obtiene los atributos del certificado SSL de una instancia de Hologres, incluido el estado de SSL y la hora de vencimiento del certificado.
GetRootCertificate	GetRootCertificate.	Obtiene el certificado SSL raíz de una instancia de Hologres para conexiones SSL del lado del cliente.
RenewSSLCertificate	RenewSSLCertificate.	Renueva el certificado SSL de una instancia de Hologres.

Otros

API	Título	Descripción
DisableOperationEvent	Deshabilitar registro de instancia.	Deshabilita el registro de la instancia.
ListMigrationZones	ListMigrationZones.	Enumera las zonas de disponibilidad a las que se puede migrar una instancia. Esta operación aplica a instancias desplegadas en tres zonas de disponibilidad.
ListOperationEvents	ListOperationEvents.	Obtiene eventos de acción que coinciden con los criterios especificados, con compatibilidad para paginación y ordenamiento.
ListRegions	Listar regiones.	Consulta la lista de todas las regiones compatibles con Hologres.
MigrateInstanceZone	MigrateInstanceZone.	Migra una instancia a una zona de disponibilidad destino. Esta operación solo admite instancias desplegadas en tres zonas de disponibilidad. La instancia se inicia en la zona de disponibilidad destino sin migrar su almacenamiento. El proceso tarda aproximadamente 5 minutos.