API standards and multilingual preset SDKs
The OpenAPI of this product (OceanBasePro/2019-09-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Tag management
|
API |
Title |
Description |
| ModifyTagName | Modify Tag Group Name | This API is used to modify the name of a tag group. |
Cluster management
|
API |
Title |
Description |
| CreateInstance | Creation of Cluster | Create an OceanBase database cluster. |
| DescribeInstance | DescribeInstance | Queries the details of an OceanBase cluster. |
| DescribeInstances | Query cluster list | Retrieves a list of OceanBase clusters. |
| DescribeInstanceTopology | Query cluster topology information | Query the topology information of an OceanBase cluster. |
| DescribeAvailableSpec | Query available configurations for cluster specification changes | Queries the available configurations for specification changes of an OceanBase cluster. |
| DescribeAvailableZone | Query available configurations for cluster creation | Queries the available configurations on the purchase page for an OceanBase cluster. |
| DescribeInstanceCreatableZone | Query zone information | It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. |
| ModifyInstanceSpec | Modify Cluster Specifications and Storage Space | Modify the cluster specifications and storage space. |
| ModifyInstanceTemporaryCapacity | Modify cluster temporary capacity | Modify the temporary capacity of an OceanBase cluster. |
| RemoveStandbyInstance | RemoveStandbyInstance | You can call this operation to decouple a standby instance from its primary instance. |
| DescribeStandbyCreateMode | Obtain the standby cluster creation mode | DescribeStandbyCreateMode |
Tenant management
|
API |
Title |
Description |
| CreateTenantReadOnlyConnection | Creation of a Read-Only Endpoint | You can call this operation to create a read-only address for a specified tenant. |
| DescribeTenants | DescribeTenants | Lists tenant information for the specified OceanBase clusters. |
| DescribeInstanceTenantModes | Query Tenant Mode List Information | The return result of the request. |
| DescribeTenant | Query the specified tenant information under the specified cluster. | View information about a specified tenant in a specified cluster. |
| DescribeAvailableCpuResource | Query active CPU resource information. | The ID of the tenant. |
| DescribeCharset | Retrieve character set | Queries the character set information of an OceanBase tenant. |
| DescribeInstanceAvailableZones | DescribeInstanceAvailableZones | You can call this operation to query the zones of a cluster that can be set as the primary zone. |
| DescribeTenantZonesRead | Query Read-Only Zone Information of a Tenant | It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. |
| DescribeTimeZones | Obtain Time Zone List | It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. |
| DescribeZones | Obtain zone information | The deployment type of the cluster. Valid values: - multiple: multi-IDC deployment - single: single-IDC deployment - dual: dual-IDC deployment |
| ModifyTenantPrimaryZone | Switch Tenant Primary Zone | Alibaba Cloud CLI |
| DeleteTenants | Delete Tenant | The request ID. |
Tenant account management
|
API |
Title |
Description |
| CreateTenantUser | Create a tenant user | Creates a database account under a specified tenant. |
| DescribeTenantUsers | Query tenant account list | Queries the list of database access accounts under a tenant. |
| ModifyTenantUserPassword | Modify tenant user password | Modifies the logon password of a specified database account under a tenant. |
| ModifyTenantUserRoles | Modify tenant user role | Modifies the database permissions for a specified account in a tenant. |
Database management
|
API |
Title |
Description |
| CreateDatabase | Create Database | Alibaba Cloud provides SDKs in different languages to help you quickly integrate Alibaba Cloud products and services by using APIs. We recommend that you use an SDK to call APIs. In this way, you do not need to sign for verification. |
| ModifyDatabaseDescription | Modify Database Description | The return result of the request. |
| ModifyTenantUserStatus | Lock or unlock a specified database account | The status of the database account. Valid values: - LOCKED: The account is locked. - ONLINE: The account is unlocked. |
| ModifyDatabaseUserRoles | Modify database user roles | Alibaba Cloud CLI |
| DeleteDatabases | Delete Database | Delete one or more created databases. |
Parameter management
|
API |
Title |
Description |
| DescribeParameters | Query parameter information list | Queries the list of parameter information. |
| ModifyParameters | Modify Parameters | Alibaba Cloud provides SDKs in different languages to help you quickly integrate Alibaba Cloud products and services by using APIs. We recommend that you use an SDK to call APIs. In this way, you do not need to sign for verification. |
Session connection
|
API |
Title |
Description |
| BatchKillProcessList | Batch Shutdown Sessions | BatchKillProcessList |
| DescribeProcessStatsComposition | Query session information | DescribeProcessStatsComposition |
Diagnostics management
|
API |
Title |
Description |
| DescribeOasAnomalySQLList | Query Suspicious SQL List | This API returns a list of SQL statements flagged by the diagnostic system for potential performance issues. |
| DescribeSampleSqlRawTexts | DescribeSampleSqlRawTexts | You can call this operation to query the original text of a sampled SQL statement. |
| DescribeOasSQLDetails | Query SQL Detailed Information | Query detailed SQL information, such as the SQL text and the names of tables involved. |
| DescribeOasSQLPlans | Query SQL Execution Plan | Retrieves SQL execution plans from the diagnosis system by SQLID. |
| DescribeSQLSamples | DescribeSQLSamples | Query sampled data for slow SQL execution details. |
| DescribeOasTopSQLList | Query TopSQL List | Queries the list of SQL execution performance data collected by the diagnostic system. |
| DescribeOasSlowSQLList | Query Slow SQL Query List | This operation retrieves a list of slow SQL statements. |
| DescribeOutlineBinding | Query Outline Binding Information | Queries the bound Outline or throttling information for a SQL statement by its SQL ID. |
| DescribeRecommendIndex | Query SQL index recommendation information | It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. |
| DescribeSQLTuningAdvices | DescribeSQLTuningAdvices | You can call this operation to query SQL optimization suggestions for two purposes: creating indexes and binding execution plans. |
| DescribeSqlAuditStat | DescribeSqlAuditStat | You can call this operation to collect the execution statistics of an SQL statement by client IP address, user, and SQL statement ID. |
| CreateOasOutlineTask | CreateOasOutlineTask | You can call this operation to initiate outline binding tasks. |
Security settings
|
API |
Title |
Description |
| ModifyInstanceSSL | ModifyInstanceSSL | Modifies the SSL configuration of an instance. |
| DescribeInstanceSSL | Query cluster SSL | Queries the SSL details of an OceanBase cluster. |
| CreateSecurityIpGroup | Create a whitelist group | It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples. |
| DescribeSecurityIpGroups | Query the list of IP address whitelist groups | Alibaba Cloud CLI |
| DescribeTenantEncryption | DescribeTenantEncryption | You can call this operation to query the encryption information of a tenant. |
| ModifySecurityIps | Modify IP List | It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud. |
| ModifyTenantEncryption | ModifyTenantEncryption | You can call this operation to enable transparent encryption for a tenant. |
| DeleteSecurityIpGroup | Delete a whitelist group | The ID of the OceanBase cluster. |
| DescribeBackupEncryptedString | Obtain backup information with overall encryption | DescribeBackupEncryptedString |
Monitoring management
|
API |
Title |
Description |
| DescribeMetricsDataV2 | DescribeMetricsDataV2 | You can call this operation to return metric data. |
| DescribeMetricsData | DescribeMetricsData | This API retrieves single- or multi-dimensional monitoring metrics for an OceanBase cluster. |
| DescribeNodeMetrics | Query Edge Zone Metric Information | The operation that you want to perform. Set the value to **DescribeNodeMetrics**. |
| DescribeTenantMetrics | Query Tenant Metric Information | The monitoring metrics. For more information about supported metrics, see [View tenant statistics](~~212125~~). |
Data transmission
|
API |
Title |
Description |
Backup and recovery
|
API |
Title |
Description |
| DescribeBackupSetDownloadLink | DescribeBackupSetDownloadLink | You can call this operation to query the link for downloading a backup set of OceanBase Database. |
| DescribeDataBackupSet | DescribeDataBackupSet | You can call this operation to query the information about the backup sets of an OceanBase cluster. |
| CreateBackupSetDownloadLink | The return result of the request. | You can call this operation to create a backup set download link in OceanBase Database. |
| DescribeRestorableTenants | DescribeRestorableTenants | Queries information about restorable OceanBase Database tenants. |
Untranslated (other)
|
API |
Title |
Description |
| DescribeProxyService | DescribeProxyService | You can call this operation to query proxy service information of OceanBase Database. |
| DescribeTenantAddressProxyInfo | DescribeTenantAddressProxyInfo | You can call this operation to query the address proxy service information about a tenant. |
Other
|
API |
Title |
Description |
| BatchKillSessionList | BatchKillSessionList | You can call this operation to close sessions between the ApsaraDB for OceanBase and the application in batches. Please note that this operation is executed asynchronously. After calling this operation, you need to verify it by calling DescribeSessionList. |
| CreateTag | CreateTag | You can call this operation to create a tag group. |
| CreateTagValue | CreateTagValue | You can call this operation to create a tag. |
| CreateTenant | CreateTenant | You can call this operation to create a tenant. |
| CreateTenantSecurityIpGroup | CreateTenantSecurityIpGroup | You can call this operation to create the security whitelist for the tenant. |
| DeleteInstances | DeleteInstances | You can call this operation to release an OceanBase cluster. |
| DeleteTag | DeleteTag | You can call this operation to delete a tag group. |
| DeleteTagValue | DeleteTagValue | You can call this operation to delete a tag from a tag group. |
| DeleteTenantSecurityIpGroup | DeleteTenantSecurityIpGroup | You can call this operation to delete the information on the whitelist group of the tenant. |
| DeleteTenantUsers | DeleteTenantUsers | You can call this operation to delete one or more database accounts. |
| DescribeAvailableMemResource | DescribeAvailableMemResource | You can call this operation to query the available memory resource of an OceanBase Database tenant. |
| DescribeDatabases | DescribeDatabases | You can call this operation to query databases in a tenant. |
| DescribeInstanceSecurityConfigs | DescribeInstanceSecurityConfigs | You can call this operation to query security check items of an OceanBase cluster. |
| DescribeInstanceSummary | DescribeInstanceSummary | Obtains the overview information about OceanBase instances. |
| DescribeInstanceTags | DescribeInstanceTags | You can call this operation to query the tags of clusters. |
| DescribeOasSQLHistoryList | DescribeOasSQLHistoryList | You can call this API to view the SQL execution history. |
| DescribeParametersHistory | DescribeParametersHistory | You can call this operation to query the modification history of cluster or tenant parameters. |
| DescribeSessionList | DescribeSessionList | You can call this operation to query sessions between the ApsaraDB for OceanBase and the application. |
| DescribeTagValues | DescribeTagValues | You can call this operation to query tags. |
| DescribeTenantReadableScn | DescribeTenantReadableScn | You can call this operation to query the maximum readable timestamp of a tenant. |
| DescribeTenantSecurityConfigs | DescribeTenantSecurityConfigs | You can call this operation to query security check items of an OceanBase Database tenant. |
| DescribeTenantSecurityIpGroups | DescribeTenantSecurityIpGroups | You can call this operation to view the list of whitelist groups of the tenant. |
| DescribeTenantTags | DescribeTenantTags | You can call this operation to query the tags of tenants in a cluster. |
| DescribeTenantUserRoles | DescribeTenantUserRoles | You can call this operation to obtain the account authorization information of the tenant. |
| KillProcessList | KillProcessList | You can call this operation to close a session. |
| ModifyInstanceName | ModifyInstanceName | You can call this operation to change the name of an OceanBase cluster. |
| ModifyInstanceNodeNum | ModifyInstanceNodeNum | You can call this operation to modify the number of nodes in a cluster. |
| ModifyInstanceTags | ModifyInstanceTags | You can call this operation to modify the tags of a cluster. |
| ModifyTagValueName | ModifyTagValueName | You can call this operation to rename a tag. |
| ModifyTenantResource | ModifyTenantResource | You can call this operation to modify the specifications of a tenant in an OceanBase cluster. |
| ModifyTenantSecurityIpGroup | ModifyTenantSecurityIpGroup | You can call this operation to modify the information on the whitelist group of the tenant. |
| ModifyTenantTags | ModifyTenantTags | You can call this operation to modify the tags of a tenant. |
| ModifyTenantUserDescription | ModifyTenantUserDescription | You can call this operation to modify the description of a specified account in a tenant. |
| SwitchoverInstance | SwitchoverInstance | You can call this operation to switch between the primary and standby instances of OceanBase. |