All Products
Search
Document Center

ApsaraDB for OceanBase:List of operations by function

Last Updated:Jan 31, 2023
This product(OceanBasePro/2019-09-01) OpenAPI adopts RPC Signature style, see signature details Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our service nail group (11370001915) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Cluster management

APITitleDescription
CreateInstanceCreateInstanceYou can call this operation to create an OceanBase database cluster.
ModifyInstanceNameModifyInstanceNameYou can call this operation to change the name of an OceanBase cluster.
DescribeInstanceDescribeInstanceYou can call this operation to query the detailed information of an OceanBase cluster.
DescribeInstancesDescribeInstancesYou can call this operation to obtain the list of OceanBase clusters.
DescribeInstanceTopologyDescribeInstanceTopologyYou can call this operation to query the topology of an OceanBase cluster.

Tenant management

APITitleDescription
CreateTenantCreateTenantYou can call this operation to create a tenant.
CreateTenantReadOnlyConnectionCreateTenantReadOnlyConnectionYou can call this operation to create a read-only address for a specified tenant.
DeleteTenantsDeleteTenantsYou can call this operation to delete one or more tenants from an OceanBase cluster.
ModifyTenantPrimaryZoneModifyTenantPrimaryZoneYou can call this operation to switch the primary zone of the tenant.
ModifyTenantResourceModifyTenantResourceYou can call this operation to modify the specifications of a tenant in an OceanBase cluster.
DescribeTenantsDescribeTenantsYou can call this operation to query the tenants in an OceanBase cluster.
DescribeInstanceTenantModesDescribeInstanceTenantModesYou can call this operation to query the modes of tenants.
DescribeTenantDescribeTenantYou can call this operation to query the information of a specific tenant in a specific cluster.
DescribeAvailableCpuResourceDescribeAvailableCpuResourceYou can call this operation to query the CPU resources available for a tenant.
DescribeAvailableMemResourceDescribeAvailableMemResourceYou can call this operation to query the available memory resource of an OceanBase Database tenant.
DescribeCharsetDescribeCharsetYou can call this operation to query the character set of an OceanBase Database tenant.
DescribeInstanceCreatableZoneDescribeInstanceCreatableZoneYou can call this operation to query the zones of a cluster that can be set as the primary zone.
DescribeTenantZonesReadDescribeTenantZonesReadYou can call this operation to query the information about read-only zones of a tenant.
DescribeTimeZonesDescribeTimeZonesYou can call this API to query the time zones supported by an OceanBase Database tenant.
DescribeZonesDescribeZonesYou can call this operation to learn of zones where a cluster can be created in an Alibaba Cloud region.

Tenant user management

APITitleDescription
CreateTenantUserCreateTenantUserYou can call this operation to create an account in a tenant that has access to a database.
DeleteTenantUsersDeleteTenantUsersYou can call this operation to delete one or more database accounts.
ModifyTenantUserDescriptionModifyTenantUserDescriptionYou can call this operation to modify the description of a specified account in a tenant.
ModifyTenantUserPasswordModifyTenantUserPasswordYou can call this operation to change the logon password of a specified account in a tenant.
ModifyTenantUserRolesModifyTenantUserRolesYou can call this operation to modify the database privileges of a specified account in a tenant.
DescribeTenantUsersDescribeTenantUsersYou can call this operation to query all accounts in a tenant that have access to the database.
DescribeTenantUserRolesDescribeTenantUserRolesYou can call this operation to obtain the account authorization information of the tenant.

Database management

APITitleDescription
CreateDatabaseCreateDatabaseYou can call this operation to create a database in a tenant.
DeleteDatabasesDeleteDatabasesYou can call this operation to delete one or more tenants from an OceanBase cluster.
DeleteInstancesDeleteInstancesYou can call this operation to release an OceanBase cluster.
ModifyDatabaseDescriptionModifyDatabaseDescriptionYou can call this operation to modify the description of an OceanBase database.
ModifyTenantUserStatusModifyTenantUserStatusYou can call this operation to lock or unlock a specified database account.
DescribeDatabasesDescribeDatabasesYou can call this operation to query databases in a tenant.
ModifyDatabaseUserRolesModifyDatabaseUserRolesYou can call this operation to modify the privileges of an account on a database.

Parameter management

APITitleDescription
ModifyParametersModifyParametersYou can call this operation to modify the parameters of a cluster or tenant.
DescribeParameters DescribeParametersYou can call this operation to query the information of cluster or tenant parameters.
DescribeParametersHistory DescribeParametersHistoryYou can call this operation to query the modification history of cluster or tenant parameters.

Security settings

APITitleDescription
CreateSecurityIpGroupCreateSecurityIpGroupYou can call this operation to create an IP address whitelist group.
DeleteSecurityIpGroup DeleteSecurityIpGroupYou can call this operation to delete an IP address whitelist group of an OceanBase cluster.
ModifySecurityIpsModifySecurityIpsYou can call this operation to modify the IP address list in a group.
DescribeSecurityIpGroupsDescribeSecurityIpGroupsYou can call this operation to view the list of IP address whitelist groups.

Metrics management

APITitleDescription
DescribeNodeMetricsDescribeNodeMetricsYou can call this operation to query the detailed metrics information of an OceanBase Database node.
DescribeTenantMetricsDescribeTenantMetricsYou can call this operation to query the metrics of a specified OceanBase Database tenant.

Diagnostic management

APITitleDescription
DescribeAnomalySQLListDescribeAnomalySQLListYou can call this operation to obtain the list of SQL statements that may have performance problems according to the diagnostic system.
DescribeOutlineBindingDescribeOutlineBindingYou can call this operation to query the outline binding information or throttling information of an SQL statement in the database based on an SQLID.
DescribeRecommendIndexDescribeRecommendIndexYou can call this operation to query the index recommended by the diagnostic system based on an SQL ID.
DescribeSlowSQLHistoryListDescribeSlowSQLHistoryListYou can call this operation to query the execution history of an SQL statement by SQL ID that is determined as a slow SQL statement during a specified period of time.
DescribeSQLDetailsDescribeSQLDetailsYou can call this operation to query the SQL text of an SQL statement based on the SQL ID.
DescribeSlowSQLListDescribeSlowSQLListYou can call this operation to query the list of slow SQL statements
DescribeSQLHistoryListDescribeSQLHistoryListYou can call this operation to query the execution history of an SQL statement in a specified period based on an SQL ID.
DescribeSQLPlansDescribeSQLPlansYou can call this operation to query the information about the SQL execution plans stored in the diagnostic system based on an SQL ID.
DescribeTopSQLListDescribeTopSQLListYou can call this operation to query SQL execution performance data collected by the diagnostic system.

Data migration

APITitleDescription
CreateOmsMysqlDataSource You can call this operation to create a MySQL data source.
CreateOmsOpenAPIProjectCreateOmsOpenAPIProjectYou can call this operation to create a data synchronization project.
StartOmsOpenAPIProjectStartOmsOpenAPIProject
StopOmsOpenAPIProjectStopOmsOpenAPIProject
ResumeOmsOpenAPIProjectResumeOmsOpenAPIProjectYou can call this operation to resume a data synchronization project.
ResetOmsOpenAPIProjectResetOmsOpenAPIProjectYou can call this operation to reset a data synchronization project.
ReleaseOmsOpenAPIProjectReleaseOmsOpenAPIProjectYou can call this operation to release a data synchronization project.
DeleteOmsOpenAPIProjectDeleteOmsOpenAPIProjectYou can call this operation to delete a data synchronization project.
DeleteOmsOpenAPIProjectDeleteOmsOpenAPIProject
DescribeOmsOpenAPIProjectDescribeOmsOpenAPIProject
DescribeOmsOpenAPIProjectStepsDescribeOmsOpenAPIProjectSteps
SearchOmsOpenAPIMonitorMetricSearchOmsOpenAPIMonitorMetric
SearchOmsOpenAPIProjectsSearchOmsOpenAPIProjects