v1

latestSwagger 2.02026-07-17123181472.9 KB
OBTenant

Create tenant

Create an obtenant in a specific namespace, passwords should be encrypted by AES

put/api/v1/obtenants

Request body

charsetstring
connectWhiteListstring
deletionProtectionboolean
enableSqlAnalyzerboolean
namestring required
namespacestring required
obclusterstring required
rootCredentialstring
rootPasswordstring
scenariostring required

Enum: express_oltp, express_oltp, olap, kv, htap, express_oltp_perf

secretNamespacestring
tenantNamestring required
tenantRolestring

Enum: Primary, Standby

unitNuminteger required

Example request

{
  "source": {
    "restore": {
      "until": {
        "timestamp": "2024-02-23 17:47:00"
      }
    }
  }
}

Response

OK

messagestring required
successfulboolean required