Estándares de API y SDK preconfigurados multilenguaje
La OpenAPI de este producto (OceanBasePro/2019-09-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.
Gestión de etiquetas
|
API |
Título |
Descripción |
| ModifyTagValueName | ModifyTagValueName. | Cambia el nombre de una etiqueta. |
| ModifyTagName | Modificar nombre de grupo de etiquetas. | Modifica el nombre de un grupo de etiquetas. |
| DescribeTagValues | Consultar valores de etiqueta. | Consulta etiquetas. |
| DeleteTagValue | DeleteTagValue. | Elimina una etiqueta de un grupo de etiquetas. |
| DeleteTag | DeleteTag. | Elimina un grupo de etiquetas. |
| CreateTagValue | CreateTagValue. | Crea una etiqueta. |
| CreateTag | CreateTag. | Crea un grupo de etiquetas. |
| ModifyInstanceTags | Modificar etiquetas de instancia. | Modifica las etiquetas de un clúster. |
| DescribeTenantTags | DescribeTenantTags. | Consulta las etiquetas de los inquilinos en un clúster. |
| ModifyTenantTags | ModifyTenantTags. | Modifica las etiquetas de un inquilino. |
| DescribeInstanceTags | DescribeInstanceTags. | Consulta las etiquetas de los clústeres. |
Gestión de clústeres
|
API |
Título |
Descripción |
| CreateInstance | Creación de clúster. | Crea un clúster de base de datos OceanBase. |
| DescribeInstance | DescribeInstance. | Consulta los detalles de un clúster de OceanBase. |
| DescribeInstances | Consultar lista de clústeres. | Obtiene una lista de clústeres de OceanBase. |
| DescribeInstanceTopology | Consulta de información de topología del clúster. | Consulta la información de topología de un clúster de OceanBase. |
| DescribeAvailableSpec | Consultar configuraciones disponibles para cambios de especificación del clúster. | Consulta las configuraciones disponibles para cambios de especificación de un clúster de OceanBase. |
| DescribeAvailableZone | Consulta de configuraciones disponibles para la creación de clústeres. | Consulta las configuraciones disponibles en la página de compra para un clúster de OceanBase. |
| DescribeInstanceCreatableZone | Consulta de información de zonas. | Es una herramienta de gestión de activos y configuración de Alibaba Cloud que permite administrar múltiples productos y servicios de Alibaba Cloud mediante comandos. Es fácil de usar y resulta de gran ayuda para la migración a la nube. |
| ModifyInstanceName | ModifyInstanceName. | Puede llamar a esta operación para cambiar el nombre de un clúster de OceanBase. |
| ModifyInstanceSpec | Modificar especificaciones del clúster y espacio de almacenamiento. | Modifica las especificaciones del clúster y el espacio de almacenamiento. |
| ModifyInstanceNodeNum | ModifyInstanceNodeNum. | Modifica el número de nodos en un clúster. |
| ModifyInstanceTemporaryCapacity | Modificar la capacidad temporal del clúster. | Modifica la capacidad temporal de un clúster de OceanBase. |
| SwitchoverInstance | SwitchoverInstance. | Permite alternar entre las instancias principal y en espera de OceanBase. |
| RemoveStandbyInstance | RemoveStandbyInstance. | Puede llamar a esta operación para desacoplar una instancia en espera de su instancia principal. |
| DeleteInstances | DeleteInstances. | Libera un clúster de OceanBase. |
| DescribeInstanceSummary | DescribeInstanceSummary. | Obtiene la información general de las instancias de OceanBase. |
| DescribeStandbyCreateMode | Obtener el modo de creación del clúster en espera. | Consulta el modo de creación de un clúster en espera. |
Gestión de inquilinos
|
API |
Título |
Descripción |
| DescribeTenantReadableScn | DescribeTenantReadableScn. | Puede llamar a esta operación para consultar la marca de tiempo máxima legible de un inquilino. |
| CreateTenant | CreateTenant. | Crea un inquilino. |
| CreateTenantReadOnlyConnection | Creación de un endpoint de solo lectura. | Crea una dirección de solo lectura para un inquilino especificado. |
| CreateTenantSecurityIpGroup | CreateTenantSecurityIpGroup. | Puede llamar a esta operación para crear la lista blanca de seguridad del inquilino. |
| DescribeTenants | DescribeTenants. | Enumera la información de los inquilinos para los clústeres de OceanBase especificados. |
| DescribeInstanceTenantModes | Consulta de información de la lista de modos de inquilino. | El resultado de retorno de la solicitud. |
| DescribeTenant | Consulta un inquilino especificado en un clúster especificado. | Consulta la información de un inquilino especificado en un clúster especificado. |
| DescribeAvailableCpuResource | Consulta la información de recursos de CPU activos. | El ID del inquilino. |
| DescribeAvailableMemResource | DescribeAvailableMemResource. | Puede llamar a esta operación para consultar los recursos de memoria disponibles de un inquilino de OceanBase Database. |
| DescribeCharset | Obtener conjunto de caracteres. | Consulta la información del conjunto de caracteres de un inquilino de OceanBase. |
| DescribeInstanceAvailableZones | DescribeInstanceAvailableZones. | Puede llamar a esta operación para consultar las zonas de un clúster que se pueden configurar como zona principal. |
| DescribeTenantZonesRead | Consulta de información de zonas de solo lectura de un inquilino. | Es una herramienta CLI en línea que permite recuperar y depurar API de forma rápida. Puede generar dinámicamente muestras de código SDK ejecutables. |
| DescribeTimeZones | Obtener lista de zonas horarias. | Es una herramienta CLI en línea que permite recuperar y depurar API de forma rápida. Puede generar dinámicamente muestras de código SDK ejecutables. |
| DescribeTenantSecurityIpGroups | DescribeTenantSecurityIpGroups. | Consulta la lista de grupos de listas blancas del inquilino. |
| DescribeZones | Obtener información de zonas. | El tipo de despliegue del clúster. Valores válidos: - multiple: despliegue en múltiples IDC - single: despliegue en un solo IDC - dual: despliegue en dos IDC |
| ModifyTenantPrimaryZone | Cambiar la zona principal del inquilino. | CLI de Alibaba Cloud. |
| ModifyTenantResource | ModifyTenantResource. | Modifica las especificaciones de un inquilino en un clúster de OceanBase. |
| ModifyTenantSecurityIpGroup | ModifyTenantSecurityIpGroup. | Modifica la información del grupo de lista blanca del inquilino. |
| DeleteTenants | Eliminar inquilino. | El ID de la solicitud. |
| DeleteTenantSecurityIpGroup | DeleteTenantSecurityIpGroup. | Elimina la información del grupo de lista blanca del inquilino. |
Gestión de cuentas de inquilino
|
API |
Título |
Descripción |
| CreateTenantUser | Crear un usuario de inquilino. | Crea una cuenta de base de datos en un inquilino especificado. |
| DescribeTenantUsers | Consultar lista de cuentas de inquilino. | Consulta la lista de cuentas de acceso a bases de datos bajo un inquilino. |
| DescribeTenantUserRoles | DescribeTenantUserRoles. | Obtiene la información de autorización de cuenta del inquilino. |
| ModifyTenantUserDescription | ModifyTenantUserDescription. | Modifica la descripción de una cuenta especificada en un inquilino. |
| ModifyTenantUserPassword | Modificar contraseña de usuario del inquilino. | Modifica la contraseña de inicio de sesión de una cuenta de base de datos especificada en un inquilino. |
| ModifyTenantUserRoles | Modificar rol de usuario del inquilino. | Modifica los permisos de base de datos para una cuenta especificada en un inquilino. |
| DeleteTenantUsers | DeleteTenantUsers. | Elimina una o más cuentas de base de datos. |
Gestión de bases de datos
|
API |
Título |
Descripción |
| CreateDatabase | Crear base de datos. | Alibaba Cloud proporciona SDK en diferentes lenguajes para ayudarle a integrar rápidamente productos y servicios de Alibaba Cloud mediante API. Se recomienda utilizar un SDK para llamar a las API. De este modo, no necesita firmar para la verificación. |
| DescribeDatabases | DescribeDatabases. | Consulta las bases de datos en un inquilino. |
| ModifyDatabaseDescription | Modify Database Description. | El resultado de retorno de la solicitud. |
| ModifyTenantUserStatus | Bloquear o desbloquear una cuenta de base de datos especificada. | El estado de la cuenta de base de datos. Valores válidos: - LOCKED: La cuenta está bloqueada. - ONLINE: La cuenta está desbloqueada. |
| ModifyDatabaseUserRoles | Modificar roles de usuario de base de datos. | CLI de Alibaba Cloud. |
| DeleteDatabases | Eliminar base de datos. | Elimina una o más bases de datos creadas. |
Gestión de parámetros
|
API |
Título |
Descripción |
| DescribeParameters | Consultar lista de información de parámetros. | Consulta la lista de información de parámetros. |
| DescribeParametersHistory | DescribeParametersHistory. | Consulta el historial de modificaciones de parámetros de clúster o inquilino. |
| ModifyParameters | Modificar parámetros. | Alibaba Cloud proporciona SDK en diferentes lenguajes para ayudarle a integrar rápidamente productos y servicios de Alibaba Cloud mediante API. Se recomienda utilizar un SDK para llamar a las API. De este modo, no es necesario realizar la firma para la verificación. |
Conexión de sesión
|
API |
Título |
Descripción |
| DescribeSessionList | DescribeSessionList. | Puede llamar a esta operación para consultar las sesiones entre ApsaraDB for OceanBase y la aplicación. |
| BatchKillSessionList | BatchKillSessionList. | Puede llamar a esta operación para cerrar sesiones entre ApsaraDB for OceanBase y la aplicación en lotes. Tenga en cuenta que esta operación se ejecuta de forma asíncrona. Después de llamar a esta operación, debe verificarla mediante la llamada a DescribeSessionList. |
| BatchKillProcessList | Cierre de sesiones por lotes. | BatchKillProcessList. |
| DescribeProcessStatsComposition | Consulta de información de sesiones. | DescribeProcessStatsComposition. |
| KillProcessList | KillProcessList. | Cierra una sesión. |
Gestión de diagnósticos
|
API |
Título |
Descripción |
| DescribeOasAnomalySQLList | Consulta de la lista de SQL sospechosos. | Esta API devuelve una lista de sentencias SQL marcadas por el sistema de diagnóstico por posibles problemas de rendimiento. |
| DescribeSampleSqlRawTexts | DescribeSampleSqlRawTexts. | Puede llamar a esta operación para consultar el texto original de una sentencia SQL muestreada. |
| DescribeOasSQLDetails | Consultar información detallada de SQL. | Consulta información detallada de SQL, como el texto SQL y los nombres de las tablas involucradas. |
| DescribeOasSQLPlans | Consulta de plan de ejecución de SQL. | Obtiene planes de ejecución de SQL del sistema de diagnóstico mediante SQLID. |
| DescribeSQLSamples | DescribeSQLSamples. | Consulta datos muestreados de los detalles de ejecución de SQL lentas. |
| DescribeOasSQLHistoryList | DescribeOasSQLHistoryList. | Consulta el historial de ejecución de SQL. |
| DescribeOasTopSQLList | Query TopSQL List | Queries the list of SQL execution performance data collected by the diagnostic system. |
| DescribeOasSlowSQLList | Consulta de la lista de consultas SQL lentas. | Esta operación obtiene una lista de sentencias SQL lentas. |
| DescribeOutlineBinding | Consulta de información de vinculación de Outline. | Consulta la información de Outline vinculado o de limitación de una sentencia SQL mediante su ID de SQL. |
| DescribeRecommendIndex | Consulta de información de recomendación de índices SQL. | Es una herramienta CLI en línea que permite recuperar y depurar API de forma rápida. Puede generar dinámicamente muestras de código SDK ejecutables. |
| DescribeSQLTuningAdvices | DescribeSQLTuningAdvices. | Puede llamar a esta operación para consultar sugerencias de optimización de SQL con dos propósitos: crear índices y vincular planes de ejecución. |
| DescribeSqlAuditStat | Consultar estadísticas de ejecución de SQL. | Consulta las estadísticas de ejecución de SQL por las dimensiones de IP del cliente, usuario e ID de SQL. |
| CreateOasOutlineTask | CreateOasOutlineTask. | Puede llamar a esta operación para iniciar tareas de vinculación de outlines. |
Configuración de seguridad
|
API |
Título |
Descripción |
| ModifyInstanceSSL | ModifyInstanceSSL. | Modifica la configuración SSL de una instancia. |
| DescribeInstanceSSL | Consultar SSL del clúster. | Consulta los detalles de SSL de un clúster de OceanBase. |
| CreateSecurityIpGroup | Crear un grupo de lista blanca. | Es una herramienta CLI en línea que permite recuperar y depurar API de forma rápida. Puede generar dinámicamente muestras de código SDK ejecutables. |
| DescribeSecurityIpGroups | Consulta la lista de grupos de listas blancas de direcciones IP. | CLI de Alibaba Cloud. |
| DescribeTenantSecurityConfigs | DescribeTenantSecurityConfigs. | Consulta los elementos de verificación de seguridad de un inquilino de OceanBase Database. |
| DescribeTenantEncryption | DescribeTenantEncryption. | Consulta la información de cifrado de un inquilino. |
| DescribeInstanceSecurityConfigs | DescribeInstanceSecurityConfigs. | Puede llamar a esta operación para consultar los elementos de verificación de seguridad de un clúster de OceanBase. |
| ModifySecurityIps | Modificar lista de IP. | Es una herramienta de gestión de activos y configuración de Alibaba Cloud con la que puede administrar múltiples productos y servicios de Alibaba Cloud mediante comandos. Es fácil de usar y resulta de gran ayuda para la migración a la nube. |
| ModifyTenantEncryption | ModifyTenantEncryption. | Puede llamar a esta operación para habilitar el cifrado transparente para un inquilino. |
| DeleteSecurityIpGroup | Eliminar un grupo de lista blanca. | El ID del clúster de OceanBase. |
| DescribeBackupEncryptedString | Obtener información de respaldo con cifrado global. | DescribeBackupEncryptedString. |
Gestión de monitoreo
|
API |
Título |
Descripción |
| DescribeMetricsDataV2 | DescribeMetricsDataV2 | Puede llamar a esta operación para devolver datos de métricas. |
| DescribeMetricsData | DescribeMetricsData. | Esta API obtiene métricas de monitoreo unidimensionales o multidimensionales para un clúster de OceanBase. |
| DescribeNodeMetrics | Consulta de información de métricas de zona perimetral. | La operación que desea realizar. Establezca el valor en **DescribeNodeMetrics**. |
| DescribeTenantMetrics | Consulta de información de métricas del inquilino. | Las métricas de monitoreo. Para obtener más información sobre las métricas admitidas, consulte [Ver estadísticas del inquilino](~~212125~~). |
Transmisión de datos
|
API |
Título |
Descripción |
Copia de seguridad y recuperación
|
API |
Título |
Descripción |
| DescribeBackupSetDownloadLink | DescribeBackupSetDownloadLink. | Consulta el enlace de descarga de un conjunto de respaldo de OceanBase Database. |
| DescribeDataBackupSet | DescribeDataBackupSet. | Consulta la información de los conjuntos de respaldo de un clúster de OceanBase. |
| CreateBackupSetDownloadLink | Resultado de retorno de la solicitud. | Crea un enlace de descarga de conjunto de respaldo en OceanBase Database. |
| DescribeRestorableTenants | DescribeRestorableTenants. | Consulta información sobre los inquilinos de OceanBase Database que se pueden restaurar. |
Sin traducir (otros)
|
API |
Título |
Descripción |
Otros
|
API |
Título |
Descripción |
| DescribeProxyService | DescribeProxyService. | Puede llamar a esta operación para consultar la información del servicio de proxy de OceanBase Database. |
| DescribeTenantAddressProxyInfo | DescribeTenantAddressProxyInfo. | Consulta la información del servicio de proxy de direcciones de un inquilino. |