# Alibaba Cloud ApsaraDB for OceanBase API

> Alibaba Cloud ApsaraDB for OceanBase API on Apizie: 140 endpoints (Asynchronously closes sessions in batches. You must call the DescribeProcessStatsComposition operation to…, Performs a batch shutdown of session information between OceanBase Cloud and business applications. This…, Cancels a modification operation based on the ID of the modification record, Creates a download link for an OceanBase backup task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-oceanbasepro`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/oceanbasepro
- Page: https://www.apizie.tech/api/cloud/aliyun-oceanbasepro
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-oceanbasepro/openapi.json

Alibaba Cloud OpenAPI for ApsaraDB for OceanBase (oceanbasepro, version 2019-09-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Asynchronously closes sessions in batches. You must call the DescribeProcessStatsComposition operation to…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/batch-kill-process-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| SessionList | string | yes | The list of sessions |
| TenantId | string | yes | The ID of the tenant |

### Performs a batch shutdown of session information between OceanBase Cloud and business applications. This…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/batch-kill-session-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The ID of the tenant |
| SessionList | string | yes | The list of sessions. Concatenate the array elements with commas. The session information is obtained from the response of the… |

### Cancels a modification operation based on the ID of the modification record
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/cancel-project-modify-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the modification record |

### Creates a download link for an OceanBase backup task
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-backup-set-download-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster to which the target backup set belongs |
| BackupSetId | string | yes | The ID of the target backup set |

### Creates a database under a specified tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| DatabaseName | string | yes | The name of the database. You cannot use certain reserved keywords. Examples: test, sys, oceanbase, information_schema, mysql, and… |
| TenantId | string | yes | The tenant ID. Only the OceanBase MySQL mode is supported |
| Encoding | string | yes | The encoding format of the database. Valid values: utf8mb4, utf16, gbk, gb18030, and binary |
| Collation | string | no | The collation. Valid values: If Encoding is set to utf8mb4: utf8mb4_general_ci, utf8mb4_bin, and utf8mb4_unicode_ci. If Encoding is set to… |
| InstanceId | string | yes | The OceanBase cluster ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client and ensure that the… |
| Description | string | no | The description of the database |

### Creates an OceanBase database cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| ChargeType | string | yes | The billing method of the instance. Valid values: PrePay: subscription. If you select this billing method, make sure that your account… |
| Series | string | yes | The edition of the instance. Valid values: normal: Standard Cluster Edition (Cloud Disk). This is the default value. normal_ssd: Standard… |
| Zones | string | yes | The zone ID of the instance. Separate multiple zone IDs with commas (,). For more information, see… |
| InstanceClass | string | yes | The specifications of the cluster. The following specifications are supported: 4C16GB: 4 cores and 16 GB of memory. 8C32GB: 8 cores and 32… |
| DiskSize | integer | no | The storage capacity of the cluster. Unit: GB. The storage capacity limits vary based on the cluster specifications: 8C32GB: 100 GB to… |
| Period | integer | no | The subscription duration of the resource. The unit is specified by PeriodUnit. This parameter is required and takes effect only when… |
| PeriodUnit | string | no | The unit of the subscription duration. Valid values for subscription: Month and Year. Default value: Month for subscription. For the… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. This parameter takes effect only when ChargeType is set to PrePaid. Valid values: true: enables… |
| AutoRenewPeriod | integer | no | The duration for each auto-renewal cycle. This parameter is required when AutoRenew is set to true. If PeriodUnit is set to Year, valid… |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| InstanceName | string | no | The name of the OceanBase cluster. The name must be 1 to 20 characters in length and can contain letters and Chinese characters. If you do… |
| ObVersion | string | no | The version of OceanBase Server |
| DiskType | string | no | The storage type of the cluster. This parameter takes effect only for Standard Cluster Edition (Cloud Disk). Valid values: cloud_essd_pl1:… |
| DryRun | string | no | Specifies whether to perform a dry run on the request. Default value: false. Valid values: true: performs a dry run without creating the… |
| ReplicaMode | string | no | The number of full-featured replicas. Valid values: 3: three full-featured replicas. 2: two full-featured replicas. For three-zone… |
| IsolationOptimization | string | no | Specifies whether to enable cgroups |
| PrimaryInstance | string | no | The ID of the primary instance |
| PrimaryRegion | string | no | The region of the primary instance |
| CpuArch | string | no | The CPU architecture |

### Creates a tag
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the tag |

### Creates a MySQL data source
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-my-sql-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the data source |
| Type | string | yes | The type of the data source. Valid values: INTERNET, VPC, RDS, PolarDB, and DG |
| VpcId | string | no | The ID of the VPC |
| InstanceId | string | no | The ID of the database instance |
| DgInstanceId | string | no | The ID of the database gateway |
| Ip | string | no | The IP address of the database host |
| Port | integer | no | The port number of the database host |
| Schema | string | no | The name of the database. If you specify this parameter, only data migration or synchronization is performed on this database |
| UserName | string | yes | The name of the database user used for data migration or synchronization |
| Password | string | yes | The password of the database user. The password must be encoded in Base64 |
| Description | string | no | The description of the data source. The description can be up to 128 characters in length |
| UseSsl | string | no | The UseSsl |

### Creates an OceanBase data source
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-ocean-base-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the data source |
| Type | string | yes | The type of the data source |
| Tenant | string | yes | The name of the OceanBase database tenant |
| Cluster | string | no | The name of the cluster to which the OceanBase database tenant belongs |
| VpcId | string | no | The unique ID of the VPC applied for by the user |
| Ip | string | no | The IP address of the database host |
| Port | integer | no | The port number of the database host |
| LogProxyIp | string | no | The IP address of the LogProxy |
| LogProxyPort | string | no | The LogProxy port |
| UserName | string | yes | The database username |
| Password | string | yes | The password of the database user. The password must be Base64-encoded |
| Description | string | no | The description of the data source |
| ConfigUrl | string | no | The address used to obtain the actual addresses of the underlying servers of the OceanBase database |
| DrcUserName | string | no | The user is mainly used to read incremental logs and database object structure information of the OceanBase database. Create this user… |
| DrcPassword | string | no | The password of the user under the sys tenant. The password must be Base64-encoded |
| InnerDrcPassword | string | no | The password of __oceanbase_inner_drc_user. The password must be Base64-encoded |

### Creates a MySQL data source
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-oms-mysql-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the data source. The name must be 2 to 128 characters in length and can contain letters, digits, underscores (_), periods (.),… |
| Type | string | yes | The MySQL type. Valid values: INTERNET, VPC, RDS, PolarDB, and DG |
| VpcId | string | no | The ID of the VPC to which the data source belongs. This parameter is required if Type is set to VPC |
| InstanceId | string | no | The ID of the cloud instance to which the data source belongs. This parameter is required if Type is set to RDS, PolarDB, or DG |
| DgDatabaseId | string | no | The ID of the Database Gateway instance. This parameter is required if Type is set to DG |
| Ip | string | no | The IP address of the data source. This parameter is required if Type is set to INTERNET or VPC |
| Port | string | no | The port of the data source. This parameter is required if Type is set to INTERNET or VPC |
| Schema | string | no | The name of the database. If this parameter is specified, subsequent migration or synchronization operations are performed only on this… |
| Username | string | yes | The username for the database connection |
| Password | string | yes | The password for the database connection. The password must be passed in after Base64 encoding. For example, the value of the password… |
| Description | string | no | The description of the data source. It must be 2 to 256 characters in length. The default value is null |

### This API is used to create a data migration or data synchronization task.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| UseOss | string | no | Indicates whether to use OSS for Creation |
| OssKey | string | no | The OssKey obtained by calling GetUploadOssUrl |
| Id | string | yes | The ID of the data migration or data synchronization task. You can obtain the ID of the task to be configured by invoking the ListProjects… |
| Name | string | yes | The name of the data migration or data synchronization task |
| Type | string | yes | The type of the job, which can be `MIGRATION` (indicating a data migration task) or `SYNC` (indicating a data synchronization task) |
| LabelIds | string | no | A collection of label IDs. Up to 5 labels are supported (JSON-encoded) |
| WorkerGradeId | string | yes | The instance ID of the transmission instance. You must invoke the ListProjects API to obtain the ID of the task to be configured |
| SourceEndpointId | string | yes | The ID of the source data source. You can obtain the ID by invoking the `ListDataSource` API. The format is e_**** |
| SinkEndpointId | string | yes | The DataSource ID of the target endpoint. You can obtain the ID by invoking the `ListDataSource` API. The format is e_**** |
| TransferMapping | string | yes | Mapping information of transfer objects (JSON-encoded) |
| CommonTransferConfig | string | no | Common transfer configuration (JSON-encoded) |
| EnableStructTransfer | string | no | Specifies whether to allow structure transfer |
| StructTransferConfig | string | no | Configuration for structure transfer. (JSON-encoded) |
| EnableFullTransfer | string | no | Specifies whether to enable full data transfer |
| EnableFullVerify | string | no | Specifies whether to enable full verification |
| FullTransferConfig | string | no | Configuration for full data transfer (JSON-encoded) |
| EnableIncrTransfer | string | no | Specifies whether to enable incremental synchronization |
| EnableReverseIncrTransfer | string | no | Whether reverse incremental synchronization is enabled |
| IncrTransferConfig | string | no | Configuration for incremental synchronization (JSON-encoded) |
| ReverseIncrTransferConfig | string | no | Reverse incremental transfer configuration. (JSON-encoded) |

### This operation modifies the objects of a data migration or data synchronization task that is running,…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-project-modify-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data migration or data synchronization task |
| Databases | string | yes | A list of database objects (JSON-encoded) |

### Use this API to create an RDS PostgreSQL data source
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-rds-postgre-sqldata-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the data source |
| InstanceId | string | yes | The ID of the database instance |
| DatabaseName | string | yes | The name of the database |
| UserName | string | yes | The name of the database user |
| Password | string | yes | The Base64-encoded password for the database user |
| Description | string | no | The description for the data source |

### It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-security-ip-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| SecurityIps | string | yes | The return result of the request. |
| SecurityIpGroupName | string | yes | The name of the whitelist group. |

### You can call this operation to create a tag group
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Key | string | yes | The name of the tag group |
| ClientToken | string | no | The identifier of the client |

### You can call this operation to create a tag
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-tag-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Value | string | yes | The name of the tag |
| Key | string | yes | The name of the tag group |
| ClientToken | string | no | The identifier of the client |

### You can call this operation to create a tenant.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-tenant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantName | string | yes | The name of the tenant. It must start with a letter or an underscore (), and contain 2 to 20 characters, which can be uppercase letters,… |
| Cpu | integer | yes | The number of CPU cores of the tenant. The CPU specification of a single tenant cannot exceed that of the corresponding cluster. For… |
| Memory | integer | yes | The memory size of the tenant, in GB. The memory size of a single tenant cannot exceed that of the corresponding cluster. For example, if… |
| TimeZone | string | yes | The time zone of the tenant. For more information, see DescribeTimeZones… |
| TenantMode | string | yes | The tenant mode. Valid values: Oracle and MySQL. For more information, see DescribeInstanceTenantModes… |
| Charset | string | yes | The character set. For more information, see DescribeCharset… |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| UserVpcId | string | yes | The ID of the VPC. If no suitable VPC is available, create a VPC as prompted. For more information, see "What is a VPC". |
| UserVSwitchId | string | yes | The ID of the vSwitch. If no suitable vSwitch is available, create a vSwitch as prompted. For more information, see Use a vSwitch. |
| PrimaryZone | string | yes | The primary zone of the tenant. It is one of the zones in which the cluster is deployed. |
| Description | string | no | The description of the database. |
| UnitNum | integer | no | The number of resource distribution nodes in the tenant. The number is determined by the deployment mode of the cluster. If the cluster is… |
| ReadOnlyZoneList | string | no | Specifies to create a read-only zone. Separate the names of multiple zones with commas (,). At present, this parameter is unavailable.> |
| LogDisk | integer | no | The size of the log disk allocated to the tenant, in GB |
| CreateParams | string | no | The initialization parameters (JSON-encoded) |
| UserVpcOwnerId | string | no | The ID of the VPC owner |

### You can call this operation to create a read-only address for a specified tenant.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-tenant-read-only-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | Tenant ID |
| InstanceId | string | yes | OceanBase cluster ID |
| ZoneId | string | yes | Zone ID of the zone. For details, see AvailableZones in DescribeInstance |
| VpcId | string | no | Virtual private cloud (VPC) ID |
| VSwitchId | string | yes | Virtual switch (vSwitch) ID |

### You can call this operation to create the security whitelist for the tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-tenant-security-ip-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | yes | The ID of the tenant. |
| SecurityIpGroupName | string | yes | The group name of the whitelist group of IP addresses. It starts with lowercase letters and ends with lowercase letters or numbers. It can… |
| SecurityIps | string | yes | The list of IP addresses in the whitelist group. It is a JSON array. Each object in the array is an IP address or a CIDR block. You can… |

### Creates a database account under a specified tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/create-tenant-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The tenant ID |
| UserName | string | yes | The name of the database account. Certain reserved keywords such as SYS and root cannot be used |
| UserType | string | yes | The type of the user. Valid values: Normal: standard account. Admin: superuser account. ReadonlyAccount: read-only account. Only MySQL… |
| UserPassword | string | yes | The password of the database account. The password must contain at least three of the following character types: uppercase letters,… |
| Roles | string | no | The role information of the user. For standard users, specify the account information as a JSON-formatted character string. The value is… |
| Description | string | no | The description of the database |
| EncryptionType | string | no | The encryption method |
| GlobalPermissions | string | no | The global permission information |

### Deletes a data source
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data source |

### Delete one or more created databases
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | Tenant ID |
| DatabaseNames | string | yes | List of database names. It is a JSON-formatted array, where each element is a string representing a database name |
| InstanceId | string | no | OceanBase cluster ID |

### You can call this operation to release an OceanBase cluster.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceIds | string | yes | The ID of the cluster to be deleted. The value is a string in the JSON format. |
| BackupRetainMode | string | no | The backup retention strategy for cluster deletion. Valid values: receive_all: retains all backup sets. delete_all: deletes all backup… |
| DryRun | string | no | Specifies whether to perform only a dry run for the request. Default value: false. Valid values: true: Only a dry-run request is sent and… |

### Deletes a data migration or data synchronization task
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data migration or synchronization task |

### The ID of the OceanBase cluster.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-security-ip-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The name of the IP address whitelist group. It must be 2 to 32 characters in length, start with a lowercase letter, end with a lowercase… |
| SecurityIpGroupName | string | yes | The information of the deleted IP whitelist group. |

### You can call this operation to delete a tag group
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Key | string | yes | The name of the tag group |

### You can call this operation to delete a tag from a tag group
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-tag-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Key | string | yes | The name of the tag group |
| Value | string | yes | The name of the tag |

### You can call this operation to delete the information on the whitelist group of the tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-tenant-security-ip-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | yes | The ID of the tenant. |
| SecurityIpGroupName | string | yes | The group name of the whitelist group of IP addresses. It starts with lowercase letters and ends with lowercase letters or numbers. It can… |

### You can call this operation to delete one or more database accounts.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-tenant-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The ID of the tenant. |
| Users | string | yes | A list of usernames |
| InstanceId | string | yes | The ID of the OceanBase cluster. |

### The request ID.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/delete-tenants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantIds | string | yes | ``` http(s)://[Endpoint]/?Action=DeleteTenants &TenantIds=["ob2mr3oae0****", "ob2mr3oae1****"] &InstanceId=ob317v4uif**** &Common request… |
| InstanceId | string | yes | You can call this operation to delete one or more tenants from an OceanBase cluster. |

### Queries the list of SQL statements that the diagnostic system identifies as potentially having performance…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-anomaly-sqllist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | OceanBase cluster ID |
| TenantId | string | yes | Tenant ID |
| StartTime | string | yes | The start time for querying suspicious SQL parameters. The time supports only UTC time in the format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time for querying suspicious SQL parameters. The time supports only UTC time in the format: YYYY-MM-DDThh:mm:ssZ |
| DbName | string | no | Database name |
| SearchKeyWord | string | no | Keyword query |
| SearchParameter | string | no | Parameter query |
| SearchRule | string | no | Query rule. Valid values of this parameter: “=”, “>”, “>=”, “<”, “<=” |
| SearchValue | string | no | Query value |
| SQLId | string | no | SQL ID |
| NodeIp | string | no | Node IP |
| PageSize | integer | no | The number of rows per page for paginated queries. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The page number for paginated queries. Starting value: 1. Default value: 1 |
| FilterCondition | string | no | Filter condition. - All fields of OceanBase support filtering. - Write the key-value pairs of the parameter in JSON format within a JSON… |
| SortColumn | string | no | Sort column |
| SortOrder | string | no | Sort order |
| AcceptLanguage | string | no | Supported language. Valid values: Chinese: zh-CN English: en-US |

### The ID of the tenant.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-available-cpu-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The CPU resources available. |
| TenantId | string | no | The operation that you want to perform. Set the value to DescribeAvailableCpuResource. |
| ModifyType | string | no | ``` http(s)://[Endpoint]/?Action=DescribeAvailableCpuResource &InstanceId=ob317v4uif**** &TenantId=ob2mr3oae0**** &ModifyType=update… |

### You can call this operation to query the available memory resource of an OceanBase Database tenant.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-available-mem-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | no | The ID of the tenant. |
| UnitNum | integer | yes | The number of resource distribution nodes in the tenant. The number is determined by the deployment mode of the cluster. If the cluster is… |
| CpuNum | integer | yes | The number of CPU cores. |

### Queries the available configurations for specification changes of an OceanBase cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-available-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| UpgradeType | string | yes | The type of specification change |
| Spec | string | no | The node specifications |

### Queries the available configurations on the purchase page for an OceanBase cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-available-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceType | string | yes | The instance type |
| Series | string | no | The series |
| DeployType | string | no | The deployment plan |
| Spec | string | no | The node plan |
| ObVersion | string | no | The OceanBase version number |
| CpuArch | string | no | The CPU architecture |

### DescribeBackupEncryptedString
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-backup-encrypted-string` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The ID of the tenant. |

### You can call this operation to query the link for downloading a backup set of OceanBase Database
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-backup-set-download-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| DownloadTaskId | string | yes | The ID of the download task corresponding to the target backup set |

### Queries the character set information of an OceanBase tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-charset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantMode | string | yes | The tenant mode. Valid values: Oracle and MySQL. For more information, see DescribeInstanceTenantModes |
| Series | string | no | The edition of the instance. Valid values: - normal (default): Cluster Edition (cloud disk) - normal_ssd: Cluster Edition (local disk) -… |
| InstanceId | string | no | The ID of the OceanBase cluster |

### Queries OceanBase backup set information
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-data-backup-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| Status | string | no | The status of the backup set |
| BackupObjectType | string | no | The backup object type |
| StartTime | string | no | The start time. Format: yyyy-MM-dd T HH:mm:ss Z (UTC) |
| EndTime | string | no | The end time of the backup set |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Queries the databases in a tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | no | The tenant ID |
| PageNumber | integer | no | The page number for paging in a paged query. Starting value: 1. Default value: 1 |
| PageSize | integer | no | The Settings for the number of entries per page for paging in a paged query. Maximum value: 100. Default value: 10 |
| DatabaseName | string | no | The database name. You cannot use certain reserved keywords, such as test and mysql |
| SearchKey | string | no | The keyword used to filter the list |
| WithTables | string | no | Specifies whether to return the table information in the databases. Default value: false. If the number of tables is excessively large,… |
| InstanceId | string | no | The cluster ID |

### Queries the details of an OceanBase cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| PageNumber | integer | no | The page number for paging. Starting value: 1. Default value: 1 |

### You can call this operation to query the zones of a cluster that can be set as the primary zone
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-available-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |

### It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-creatable-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the zone. |

### Queries the SSL details of an OceanBase cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The OceanBase cluster ID |
| TenantId | string | no | The OceanBase tenant ID |

### Checks the security configurations of a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-security-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The OceanBase cluster ID |
| CheckId | string | no | The unique identifier of the check |

### Retrieves the overview of OceanBase instances
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The page number for paging in a paged query. Starting value: 1. Default value: 1 |

### You can call this operation to query the tags of clusters
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceIds | string | no | The list of cluster IDs |
| Tags | string | no | The tags |

### The return result of the request.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-tenant-modes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The operation that you want to perform. Set the value to DescribeInstanceTenantModes. |

### Queries the topology of an OceanBase cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instance-topology` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The OceanBase cluster ID |

### Queries the list of OceanBase clusters
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the OceanBase cluster |
| ResourceGroupId | string | no | The ID of the resource group. If you do not specify this parameter, all resources are returned |
| PageSize | integer | no | The Settings for the number of entries per page during paging in a paged query. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The page number for paging in a paged query. Starting value: 1. Default value: 1 |
| InstanceName | string | no | The name of the OceanBase cluster. The name must be 1 to 20 characters in length and can contain English or Chinese characters. If you do… |
| SearchKey | string | no | The keyword used to perform a fuzzy search based on the instance ID, instance name, tenant ID, and tenant name |

### This API retrieves single- or multi-dimensional monitoring metrics for an OceanBase cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-metrics-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| StartTime | string | yes | The start time for the query. The time must be in UTC and use the YYYY-MM-DDThh:mm:ssZ format |
| EndTime | string | yes | The end time for the query. The time must be in UTC and use the YYYY-MM-DDThh:mm:ssZ format |
| Metrics | string | yes | The monitoring metrics to query. Separate multiple metrics with a comma. For example, "sql_all_count,sql_all_rt...". |
| Labels | string | yes | A string of key-value pairs. Use a colon (:) to separate keys from values, and a comma (,) to separate key-value pairs. For example:… |
| GroupByLabels | string | yes | The fields by which to group the results. Separate multiple fields with a comma. For example: "app,clusterId,tenantId" |
| SortMetricKey | string | no | The metric key by which to sort the results |
| SortOrder | string | no | The sort order. ASC: ascending order. DESC: descending order |
| Limit | string | no | The maximum number of items to return |
| ReplicaType | string | no | The replica type. In OceanBase cluster monitoring, this parameter filters nodes by replica type. Default (unspecified): Retrieves… |

### You can call this operation to return metric data
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-metrics-data-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| Metrics | string | yes | The metrics. Separate multiple metrics with commas (,). Example: "sql_all_count,sql_all_rt..." |
| StartTime | string | yes | The start time, in the format of YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time, in the format of YYYY-MM-DDThh:mm:ssZ |
| Labels | string | yes | A string of key-value pairs separated with commas (,). Each key and its value are separated with a colon (\:). Multiple values of a key… |
| GroupByLabels | string | yes | The one or more keys used for grouping. Separate multiple keys with commas (,). Example: "clusterId,tenantId" |
| SortMetricKey | string | no | The sort column |
| SortOrder | string | no | The sorting rule. Valid values: ASC: in ascending order DESC: in descending order |
| Limit | string | no | The length of the data array returned after sorting |
| ReplicaType | string | no | The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the… |

### The operation that you want to perform. Set the value to DescribeNodeMetrics.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-node-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The list of nodes. |
| PageSize | integer | no | The ID of the tenant. |
| PageNumber | integer | no | $.parameters[6].schema.description |
| TenantId | string | no | $.parameters[6].schema.enumValueTitles |
| StartTime | string | yes | $.parameters[9].schema.example |
| EndTime | string | yes | $.parameters[7].schema.description |
| Metrics | string | yes | $.parameters[7].schema.enumValueTitles |
| NodeName | string | no | $.parameters[8].schema.example |
| NodeIdList | string | no | $.parameters[10].schema.description |

### This API returns a list of SQL statements flagged by the diagnostic system for potential performance issues
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-oas-anomaly-sqllist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase instance |
| TenantId | string | yes | The tenant ID |
| StartTime | string | yes | The beginning of the query period. The time must be in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`. |
| EndTime | string | yes | The end of the query period. The time must be in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`. |
| DbName | string | no | The database name |
| SearchKeyWord | string | no | The search keyword |
| SearchParam | string | no | The performance metric to search by |
| SearchRule | string | no | The search operator. Valid values: `=`, `>`, `>=`, ` |
| SearchValue | string | no | The search value |
| SqlId | string | no | The SQL ID |
| NodeIp | string | no | The IP address of the node |
| FilterCondition | string | no | Use the at sign (@) to reference fields. For a list of available fields, see all columns returned by the Query performance statistics for… |
| AcceptLanguage | string | no | The language of the response. Defaults to `zh-CN` for services in Chinese mainland and `en-US` for other regions. |
| SqlTextLength | integer | no | The maximum length of the returned SQL text |
| Current | integer | no | The page number to return |
| PageSize | integer | no | The number of entries to return on each page. Minimum value: 1. Default value: 10 |
| DynamicSql | string | no | Indicates if the SQL statement specified by `SqlId` is dynamic SQL. |
| MergeDynamicSql | string | no | Whether to merge the results of dynamic SQL statements. This option aggregates SQL statements that are identical except for the values in… |

### Query detailed SQL information, such as the SQL text and the names of tables involved
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-oas-sqldetails` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | yes | The ID of the tenant. |
| SqlId | string | yes | SQL ID |
| DbName | string | yes | The name of the database. |
| StartTime | string | yes | The start time of querying the SQL execution plan. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time of querying the SQL execution plan. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ |
| DynamicSql | string | no | Indicates whether the SQL is dynamic |
| ParseTable | string | no | Indicates whether to parse the table schema |

### You can call this API to view the SQL execution history
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-oas-sqlhistory-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | yes | The ID of the tenant. |
| StartTime | string | yes | The start time of querying the execution history of the SQL statement. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time of querying the execution history of the SQL statement. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ |
| DbName | string | no | The name of the database. |
| SqlId | string | yes | SQL ID |
| NodeIp | string | no | The IP address of the node. |
| AcceptLanguage | string | no | The language of the response. Valid values: zh: Chinese en: English |
| DynamicSql | string | no | Specifies whether the SQL statement is a dynamic SQL statement |

### Retrieves SQL execution plans from the diagnosis system by SQLID
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-oas-sqlplans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The ID of the tenant |
| StartTime | string | yes | The start of the time range to query SQL execution plans. The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format |
| EndTime | string | yes | The end of the time range to query SQL execution plans. The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format. |
| DbName | string | yes | The name of the database |
| SqlId | string | yes | The SQL ID |
| AcceptLanguage | string | no | The language of the response. Valid values: `zh-CN`: Chinese `en-US`: English |
| DynamicSql | string | no | Specifies whether the SQL statement is a dynamic SQL |
| PlanUnionHash | string | no | The unique identifier of the execution plan |
| ReturnBriefInfo | string | no | Specifies whether to return brief information about the execution plan |

### This operation retrieves a list of slow SQL statements
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-oas-slow-sqllist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | OceanBase cluster ID |
| TenantId | string | yes | Tenant ID |
| StartTime | string | yes | Start time for querying historical slow SQL data. This time must be in UTC format: YYYY-MM-DDThh:mm:ssZ. |
| EndTime | string | yes | End time for querying slow SQL data. This time must be in UTC format: YYYY-MM-DDThh:mm:ssZ. |
| DbName | string | no | Database name |
| SearchKeyWord | string | no | Search keyword |
| SearchParam | string | no | Query parameter |
| SearchRule | string | no | Query rule |
| SearchValue | string | no | Query value |
| SqlId | string | no | SQL ID |
| NodeIp | string | no | Database node IP address |
| FilterCondition | string | no | Reference all fields using the at sign (@). For available fields, see the columns returned by the Query SQL performance statistics… |
| AcceptLanguage | string | no | Language for returned data |
| SqlTextLength | integer | no | Maximum length of the returned SQL text |
| DynamicSql | string | no | Indicates whether the SQL is dynamic. Specifies whether the provided SQL ID belongs to a dynamic SQL statement. |
| MergeDynamicSql | string | no | Indicates whether to merge dynamic SQL statements in the response. Specifies whether to aggregate results for SQL statements with IN… |

### Queries the list of SQL execution performance data collected by the diagnostic system
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-oas-top-sqllist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | OceanBase cluster ID |
| TenantId | string | yes | Tenant ID |
| StartTime | string | yes | Start time for querying TOPSQL parameters. Use UTC time in the format YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | End time for querying TOPSQL parameters. Use UTC time in the format YYYY-MM-DDThh:mm:ssZ. This time supports only UTC in the format:… |
| DbName | string | no | Database name |
| SearchKeyWord | string | no | Keyword query |
| SearchParam | string | no | Parameter query |
| SearchRule | string | no | Query rule |
| SearchValue | string | no | Query value |
| SqlId | string | no | SQL ID |
| NodeIp | string | no | Node IP |
| FilterCondition | string | no | Reference all fields using the @ symbol. For available fields, see the columns returned by the Query SQL performance statistics… |
| AcceptLanguage | string | no | Language for returned information: zh: Chinese en: English |
| SqlTextLength | integer | no | Maximum length of the returned SQL text |
| DynamicSql | string | no | Indicates whether the SQL is dynamic. Specifies whether the provided SQL ID belongs to a dynamic SQL statement. |
| MergeDynamicSql | string | no | Indicates whether to merge dynamic SQL statements in the response. Specifies whether to aggregate results for SQL statements containing IN… |

### Queries the bound Outline or throttling information for a SQL statement by its SQL ID
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-outline-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The tenant ID |
| TableName | string | yes | The tenant name. Note: Although this parameter is named TableName, it specifies the tenant name. The name must be 2–20 characters long,… |
| DatabaseName | string | yes | The database name |
| SQLId | string | yes | The SQL ID |
| IsConcurrentLimit | string | no | Set to `true` to query the throttling information. Set to `false` to query the bound index or bound execution plan |
| InstanceId | string | no | The OceanBase instance ID |

### Queries the list of parameter information
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| Dimension | string | yes | The parameter type. Valid values: CLUSTER and TENANT |
| DimensionValue | string | no | The resource identifier of the parameter type. You can leave this parameter empty for cluster parameters. For tenant parameters, specify… |

### You can call this operation to query the modification history of cluster or tenant parameters.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-parameters-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| Dimension | string | yes | The type of the parameter. Valid values: CLUSTER and TENANT. |
| DimensionValue | string | no | The resource ID of the parameter type. You can leave this parameter unspecified when you call this operation to query cluster parameters.… |
| StartTime | string | yes | The start time of querying the slow query execution. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time of the time range for querying the SQL execution history. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. |
| PageSize | integer | yes | The number of rows to return on each page. Maximum value: 100. Default value: 10 |
| PageNumber | integer | yes | The number of the page to return. Start value: 1 Default value: 1 |

### DescribeProcessStatsComposition
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-process-stats-composition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| UId | string | no | The user identifier (UID) of the OceanBase database |
| TenantId | string | no | The ID of the tenant. |
| SqlText | string | no | The SQL statement, which can contain LIKE clauses. You can specify only part of the clauses in the SQL statement |
| ClientIp | string | no | The IP address of the client |
| ServerIp | string | no | The IP address of the server |
| Users | string | no | The username of the database |
| Status | string | no | The status of the session |

### This API retrieves the details of a data migration or data synchronization task
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data migration or data synchronization task |

### This API retrieves component information for data migration or data synchronization tasks
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-project-components` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data migration or data synchronization task |

### This API retrieves the progress details of a data migration or data synchronization task
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-project-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data migration or data synchronization task |

### This API retrieves step-level metrics for a data migration or data synchronization task
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-project-step-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| ProjectId | string | yes | The ID of the data migration or data synchronization project |
| StepName | string | yes | The name of the task step. You can specify one of the following values: `FULL_TRANSFER` for full transfer, `INCR_TRANSFER` for incremental… |
| MetricType | string | yes | Specifies the metric to query for the task step. The available options depend on the value of `StepName`. For the `FULL_TRANSFER` step,… |
| Aggregator | string | yes | The aggregation method for the metric data. Specify `AVG` to return the average value or `NONE` to return the instantaneous value. The… |
| BeginTimestamp | integer | yes | The start of the query time range, as a Unix timestamp in seconds. The total time range must be at least one hour |
| EndTimestamp | integer | yes | The end of the query time range, as a Unix timestamp in seconds. This value cannot be in the future |
| MaxPointNum | integer | no | The maximum number of data points to return. The value must be between 5 and 7**24\60. For optimal results, the value should meet the… |

### Queries the details of the execution steps for a data migration or data synchronization task
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-project-steps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data migration or data synchronization task |

### You can call this operation to query proxy service information of OceanBase Database
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-proxy-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |

### It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-recommend-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The index recommended for the SQL statement after calculation by the diagnostic system. If the recommended index is the primary key,… |
| InstanceId | string | yes | The return result of the request. |
| SQLId | string | yes | The ID of the OceanBase cluster. |

### Queries recoverable OceanBase tenants
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-restorable-tenants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The OceanBase cluster ID |
| IsRemote | string | no | Reserved for compatibility with legacy versions. This parameter can be left empty |
| SetId | string | no | The backup set ID |
| RestoreMode | string | no | The restore mode. This parameter is optional, but required when IsRemote is set to true |
| Method | string | no | The backup type |
| IsOnline | string | no | Indicates whether the target parsing cluster is online. This parameter is optional for compatibility with legacy versions. If not… |
| RestoreObjectType | string | no | The restore object type |

### The ID of the tenant.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-sqldetails` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | SQLID |
| SQLId | string | yes | The SQL text. |

### You can call this operation to query the execution history of an SQL statement in a specified period based…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-sqlhistory-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The ID of the tenant. |
| StartTime | string | yes | The start time of the time range for querying the SQL execution history. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. |
| EndTime | string | yes | The end time of the time range for querying the SQL execution history. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. |
| SQLId | string | yes | SQLID |
| PageNumber | integer | no | The page number. |
| PageSize | integer | no | The number of entries returned on each page. Default value: 10. |

### You can call this operation to query the information about the SQL execution plans stored in the diagnostic…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-sqlplans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The ID of the tenant. |
| SQLId | string | yes | SQLID |

### Query sampled data for slow SQL execution details
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-sqlsamples` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the OceanBase cluster |
| TenantId | string | no | The ID of the tenant |
| StartTime | string | yes | The start time to query for slow SQL executions. The time must be in UTC format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time to query for slow SQL executions. The time must be in UTC format: YYYY-MM-DDThh:mm:ssZ |
| DbName | string | yes | The name of the database |
| SqlId | string | yes | The SQL ID |
| ReturnSqlText | string | no | Specifies whether to return the SQL text |

### You can call this operation to query SQL optimization suggestions for two purposes: creating indexes and…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-sqltuning-advices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | yes | The ID of the tenant. |
| DbName | string | yes | The name of the database. |
| SqlId | string | yes | The ID of the SQL statement |
| StartTime | string | yes | The start time |
| EndTime | string | yes | The end time |
| AcceptLanguage | string | no | The supported language. Valid values: zh-CN en-US |

### You can call this operation to query the original text of a sampled SQL statement
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-sample-sql-raw-texts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the OceanBase cluster |
| TenantId | string | no | The ID of the tenant |
| StartTime | string | yes | The start time. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ |
| DbName | string | yes | The name of the database |
| SqlId | string | yes | The ID of the SQL statement |
| TraceId | string | no | The trace ID of the executed query, which is the value of TraceId returned by DescribeSQLSamples. Note Not all trace IDs of slow SQL… |
| Limit | string | no | The number of returned rows of the SQL statement |
| DynamicSql | string | no | Specifies whether the SQL statement is an aggregation statement |

### Alibaba Cloud CLI
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-security-ip-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |

### You can call this operation to query sessions between the ApsaraDB for OceanBase and the application
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-session-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | yes | The ID of the tenant. |

### You can call this operation to query the execution history of an SQL statement by SQL ID that is determined…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-slow-sqlhistory-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The ID of the tenant. |
| StartTime | string | yes | The start time of the time range for querying the execution history of the slow SQL statement. The value must be UTC time in the format of… |
| EndTime | string | yes | The end time of the time range for querying the execution history of the slow SQL statement. The value must be UTC time in the format of… |
| SQLId | string | yes | The SQL ID, which uniquely identifies an SQL statement. |
| PageNumber | integer | no | The number of the page to return. Start value: 1 Default value: 1 |
| PageSize | integer | no | The number of rows to return on each page. Maximum value: 100 Default value: 10 |

### You can call this operation to query the list of slow SQL statements
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-slow-sqllist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The ID of the tenant. |
| StartTime | string | yes | The start time of the time range for querying slow SQL statements. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. |
| EndTime | string | yes | The end time of the time range for querying slow SQL statements. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ. |
| DbName | string | no | The name of the database. |
| SearchKeyWord | string | no | The search keyword. |
| SearchParameter | string | no | The search parameter. |
| SearchRule | string | no | The search rule. |
| SearchValue | string | no | The search value. |
| SQLId | string | no | The SQL ID, which uniquely identifies an SQL statement. |
| NodeIp | string | no | The IP address of the database node. |
| PageNumber | integer | no | The number of rows to return on each page. Maximum value: 100 Default value: 10 |
| PageSize | integer | no | The number of the page to return. Start value: 1 Default value: 1 |
| FilterCondition | string | no | The filter condition. (JSON-encoded) |
| SortColumn | string | no | The sorted column. |
| SortOrder | string | no | The sorting rule. |

### DescribeStandbyCreateMode
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-standby-create-mode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The ID of the tenant. |

### You can call this operation to query tags
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tag-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| ResourceType | string | yes | The type of the resource |

### Queries the information about a specified tenant in a specified cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The ID of the tenant |

### You can call this operation to query the address proxy service information about a tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-address-proxy-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | no | The ID of the tenant. |

### You can call this operation to query the encryption information of a tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-encryption` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | no | The ID of the tenant. |
| TenantName | string | no | The name of the tenant. It must start with a letter or an underscore (), and contain 2 to 20 characters, which can be uppercase letters,… |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of rows to return on each page. Maximum value: 100. Default value: 10 |

### The monitoring metrics. For more information about supported metrics, see…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | 2021-06-13T15:40:43Z |
| PageSize | integer | no | tfafd34fs**** |
| PageNumber | integer | no | The ID of the OceanBase cluster. |
| TenantName | string | no | 2021-06-13T15:45:43Z |
| StartTime | string | yes | Example 1 |
| EndTime | string | yes | End time of monitoring data. This time supports only UTC, in the format: YYYY-MM-DDThh:mm:ssZ |
| Metrics | string | yes | {"name":"DescribeTenantMetrics","product":"OceanBasePro","version":"2019-09-01","path":"/","deprecated":0,"method":"POST/GET","protocol":"H… |
| TenantId | string | no | Tenant ID. This parameter will be deprecated in the future. We recommend that you use TenantIdList instead |
| TenantIdList | string | no | List of tenant IDs. |

### You can call this operation to query the maximum readable timestamp of a tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-readable-scn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The ID of the tenant |

### You can call this operation to query security check items of an OceanBase Database tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-security-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | no | The ID of the tenant |
| CheckId | string | no | The unique identifier of the security check |

### You can call this operation to view the list of whitelist groups of the tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-security-ip-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantId | string | yes | The ID of the tenant. |

### You can call this operation to query the tags of tenants in a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| TenantIds | string | yes | The JSON string of the tenant ID |
| Tags | string | no | The tags |

### You can call this operation to obtain the account authorization information of the tenant.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-user-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | no | The ID of the tenant. If you specify the ID of a tenant in MySQL mode, the privilege configuration of the regular user in MySQL mode is… |
| InstanceId | string | no | The ID of the OceanBase cluster |

### Queries the list of database access accounts under a tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The tenant ID |
| SearchKey | string | no | The filter keyword for fuzzy match when querying the list |
| PageNumber | integer | no | The page number of the paged query. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of rows per page for the paged query. Maximum value: 100. Default value: 10 |
| UserName | string | no | The database account name. Certain reserved keywords such as SYS and root cannot be used |

### It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenant-zones-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The zone information of the tenant. |
| TenantId | string | yes | The return result of the request. |

### Lists tenant information for the specified OceanBase clusters
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-tenants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| TenantName | string | no | The tenant name. The name must be 2 to 20 characters long, start with a letter or an underscore, and consist of letters, digits, and… |
| PageSize | integer | no | The number of items to return per page. Maximum value: 100 Default value: 10 |
| PageNumber | integer | no | The page number to return. Minimum value: 1 Default value: 1 |
| TenantId | string | no | The ID of the tenant |
| SearchKey | string | no | The keyword to filter query results |

### It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-time-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |

### The number of executions
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-top-sqllist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The average CPU time, in ms. |
| StartTime | string | yes | The maximum response time, in ms. |
| EndTime | string | yes | The SQL type. |
| DbName | string | no | The number of block index cache hits. |
| SearchKeyWord | string | no | The number of retries. |
| SearchParameter | string | no | SQLID |
| SearchRule | string | no | The IP address of the client |
| SearchValue | string | no | The number of Bloom filter cache hits |
| SQLId | string | no | The I/O wait time, in ms. |
| NodeIp | string | no | The number of failures. |
| PageNumber | integer | no | The queuing time, in ms. |
| PageSize | integer | no | The number of row cache hits. |
| FilterCondition | string | no | The average number of logical reads of the SQL statement during the specified period of time. The value covers the numbers of reads of… |
| SortColumn | string | no | The number of rows read from the disk. |
| SortOrder | string | no | The list of top SQL statements |

### The deployment type of the cluster. Valid values: multiple: multi-IDC deployment single: single-IDC…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/describe-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Series | string | no | The deployment mode. |
| DeployType | string | no | The operation that you want to perform. Set the value to DescribeZones. |
| CpuArch | string | no | CPU architecture |

### Retrieves a temporary upload URL for uploading files to OSS in the public cloud
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/get-upload-oss-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Type | string | yes | The action type (CREATE_PROJECT) |
| EffectiveTimeMinutes | integer | no | The validity period. By default, the URL is valid for 10 minutes. Valid values: 1 to 30 |

### You can call this operation to close a session
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/kill-process-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| SessionList | string | yes | The list of the sessions that need to be closed |
| TenantId | string | yes | The ID of the tenant. |

### This API lists your tags
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/list-all-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |

### Queries the list of created data sources
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/list-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| SearchKey | string | no | The name or ID of the data source |
| Types | string | no | The collection of data source types (JSON-encoded) |
| SortField | string | no | The field by which to sort data sources. Valid values: gmtCreate (default) and gmtModified |
| Order | string | no | The sort order for data sources. Valid values: `asc` (ascending) and `descend` (descending) |
| PageNumber | string | no | The ordinal number of the page. This parameter takes effect only when paging is enabled for a paged query |
| PageSize | string | no | The number of entries per page. This parameter takes effect only when paging is enabled for a paged query |

### This API queries the full validation results of a data migration task
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/list-project-full-verify-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| ProjectId | string | yes | The ID of the data migration task |
| SourceSchemas | string | no | A list of source databases (JSON-encoded) |
| DestSchemas | string | no | A list of target databases (JSON-encoded) |
| Status | string | no | The status of the data migration task |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### You can use this operation to query modification records of a data migration or data synchronization task by…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/list-project-modify-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the data migration or data synchronization task |

### This API retrieves a paginated list of data migration or data synchronization tasks
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/list-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| SearchKey | string | no | The name or ID of the data migration or data synchronization task |
| Type | string | no | The task type. Valid values are `MIGRATION` for data migration and `SYNC` for data synchronization. The Type parameter is required.> |
| Status | string | no | A collection of task statuses. Valid values include \`INIT\`, \`RUNNING\`, \`SUSPEND\`, \`FAILED\`, \`FINISHED\`, \`RELEASING\`,… |
| LabelIds | string | no | A collection of label IDs. A maximum of five IDs can be specified (JSON-encoded) |
| SourceEndpointTypes | string | no | A collection of source data source types (JSON-encoded) |
| SinkEndpointTypes | string | no | A collection of destination data source types (JSON-encoded) |
| VisibleSubProject | string | no | Specifies whether to display subtasks |
| SortField | string | no | The field to sort by. Valid values are `gmtCreate` and `gmtModified`. The default value is `gmtCreate` |
| Order | string | no | The sort order. Valid values are `asc` (ascending) and `descend` (descending). The default value is `descend` |
| NeedRelatedInfo | string | no | Specifies whether to query related task information, such as data source connections, transfer instances, and task steps. The default… |
| PageNumber | integer | no | The page number for paged queries |
| PageSize | integer | no | The number of entries per page for paged queries |

### Returns a list of migration instances
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/list-worker-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Specs | string | no | An array of instance specifications (JSON-encoded) |
| InstanceName | string | no | The name of the worker instance |
| SourceType | string | no | The type of the source. Valid values are `OCEANBASE` for OceanBase, `KAFKA` for Kafka, `ROCKETMQ` for RocketMQ, `POLARDB_X_1` or… |
| DestType | string | no | The type of the destination. Valid values are `OCEANBASE` for OceanBase, `KAFKA` for Kafka, `ROCKETMQ` for RocketMQ, `POLARDB_X_1` or… |
| OnlyBindable | string | no | Specifies whether to list only bindable instances. The default value is `true` |
| PageNumber | integer | no | The page number to return for paginated queries |
| PageSize | integer | no | The number of entries to return per page for paginated queries |

### The return result of the request.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-database-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The description of the database. |
| TenantId | string | yes | The operation that you want to perform. Set the value to ModifyDatabaseDescription. |
| DatabaseName | string | yes | Example 1 |
| Description | string | yes | Database description |

### Alibaba Cloud CLI
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-database-user-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| DatabaseName | string | yes | The ID of the tenant. |
| TenantId | string | yes | A list of usernames and their respective roles. |
| Users | string | yes | The ID of the OceanBase cluster. |
| InstanceId | string | no | The account information. |

### You can call this operation to change the name of an OceanBase cluster.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by… |
| InstanceName | string | yes | The ID of the OceanBase cluster. |

### Modifies the number of nodes in a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-instance-node-num` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| NodeNum | string | yes | The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n × 3 |
| DryRun | string | no | Specifies whether to perform only a dry run for this request. Default value: false. Valid values: true: performs a dry run without… |

### Modifies the SSL configuration of an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-instance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase instance |
| EnableSSL | string | yes | The action to perform on the SSL configuration. Valid values: `open`: Enable SSL encryption. `update`: Update the CA certificate. `close`:… |
| TenantId | string | no | The TenantId |

### Modify the cluster specifications and storage space
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-instance-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| InstanceClass | string | no | The specifications of the cluster. You can specify one of the following four plans: 8C32GB: indicates 8 CPU cores and 32 GB of memory.… |
| DiskSize | integer | no | The size of the storage space, in GB. The required storage space varies based on the cluster specifications: 8C32G: 100 GB to 10 TB.… |
| DryRun | string | no | Specifies whether to perform only a dry run for the request. Default value: false. Valid values: true: Only a dry-run request is sent and… |
| DiskType | string | no | Disk type |
| UpgradeSpecNative | string | no | Whether to perform an in-place upgrade/downgrade |

### You can call this operation to modify the tags of a cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-instance-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| Tags | string | yes | The tags |

### Updates the temporary capacity of an OceanBase cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-instance-temporary-capacity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| Spec | string | yes | The specifications |
| DiskSize | string | no | The disk size. Unit: GB |
| AcceptLanguage | string | no | The supported language. Valid values: zh-CN: Chinese. en-US: English |

### Alibaba Cloud provides SDKs in different languages to help you quickly integrate Alibaba Cloud products and…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Alibaba Cloud CLI |
| DimensionValue | string | no | The cause of the modification failure. |
| Dimension | string | yes | The ID of the OceanBase cluster. |
| Parameters | string | yes | The resource ID of the parameter type. You can leave this parameter unspecified when you call this operation to modify cluster parameters.… |

### It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba…
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-security-ips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster. |
| SecurityIps | string | no | The list of IP addresses and CIDR blocks in the whitelist. It is a JSON array. Each object in the array is an IP address or CIDR block.… |
| SecurityIpGroupName | string | no | The information of the IP address whitelist group. |

### This API is used to modify the name of a tag group.
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-tag-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Key | string | yes | The name of the tag group |
| NewKey | string | yes | The new name of the tag group |

### Updates the name of a tag
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-tag-value-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| Key | string | yes | The tag group name |
| Value | string | yes | The tag name |
| NewValue | string | yes | The new tag name |

### You can call this operation to enable transparent encryption for a tenant
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-tenant-encryption` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the OceanBase cluster |
| TenantId | string | yes | The ID of the tenant. |
| EncryptionType | string | yes | The encryption type. Valid values: INTERNAL: a service key (automatically generated by the cloud service) USER_KMS: a custom key (Alibaba… |
| EncryptionKeyId | string | no | The ID of the key |

### Alibaba Cloud CLI
`POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/modify-tenant-primary-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://oceanbasepro.ap-southeast-1.aliyuncs.com |
| TenantId | string | yes | The return result of the request. |
| InstanceId | string | yes | The primary zone of the tenant. It is one of the zones in which the cluster is deployed. |
| PrimaryZone | string | no | The ID of the vSwitch. |
| UserVSwitchId | string | no | The request ID. |
| MasterIntranetAddressZone | string | no | ``` http(s)://[Endpoint]/?Action=ModifyTenantPrimaryZone &TenantId=ob2mr3oae0**** &InstanceId=ob317v4uif**** &PrimaryZone=cn-hangzhou-h… |
| TenantEndpointId | string | no | Tenant endpoint ID |
| TenantEndpointDirectId | string | no | Tenant direct connection endpoint ID |
| UserDirectVSwitchId | string | no | The vSwitch ID for the tenant direct connection address |
| VpcId | string | no | Virtual private cloud (VPC) ID |
| UserVpcOwnerId | string | no | Owner ID of the user VPC |

…and 20 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/batch-kill-process-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for OceanBase API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-oceanbasepro/batch-kill-process-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraDB for OceanBase API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ApsaraDB for OceanBase itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ApsaraDB for OceanBase API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-oceanbasepro.

### What is the status of the Alibaba Cloud ApsaraDB for OceanBase API?
Needs your own provider key (bring your own key)