CreateConstraints|OceanBase Cloud| docs|Distributed Database

CreateConstraints

Last Updated：2025-11-26 03:33:16 Updated

Overview

You can call this API to configure constraints for a tenant in an OceanBase cluster.

API details

Constraints

The caller must have an AccessKey for accessing APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.

Request path

GET /api/v2/instances/{instanceId}/tenantCreateConstraints

Request parameters

Query

Parameter	Type	Required	Description	Example value
instanceId	String	Yes	The ID of the OceanBase cluster.	ob317v4uif****
tenantId	String	Yes	The ID of the tenant.	t33h8y08k****
tenantMode	String	Yes	The mode of the tenant. Valid values: Oracle and MySQL.	Oracle

Response parameters

Parameter	Type	Description	Example value
data	Object	The information about the tenant.
charsetList	String	The list of character sets supported. The utf8mb4 and gbk character sets are supported in the MySQL compatible mode. The utf8 and gbk character sets are supported in the Oracle compatible mode.	utf8
tenantModeList	String	The compatibility mode of the tenant. Valid values: Oracle and MySQL.	Oracle
defaultTimeZone	String	The default time zone.	Shanghai
timeZoneList	String	The list of time zones of the tenant. timeZone: the time zone. description: the description of the time zone.	timeZone: Africa/Addis_Ababa description: (GMT+3:00) Africa/Addis_Ababa
zoneList	String	The list of zones of the tenant. name: the name of the zone. replicaType: the replica type of the zone.	name: cn-hangzhou-h replicaType: FULL

Examples

Request example

--digest   -u 'xxx:xxx' \
  --request GET \
  --url   https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenantCreateConstraints
  -H 'X-Ob-Project-Id: <Project ID>'

Note

A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.

Response example

JSON format

{
   "data":{
      "charsetList":[
         "utf8mb4",
         "gbk"
      ],
      "defaultTimeZone":"Asia/Shanghai",
      "tenantModeList":[
         "Oracle",
         "MySQL"
      ],
      "timeZoneList":[
         {
            "description":"(GMT0:00) Africa/Abidjan",
            "timeZone":"Africa/Abidjan"
         },
         {
            "description":"(GMT0:00) Africa/Accra",
            "timeZone":"Africa/Accra"
         },
         {
            "description":"(GMT+3:00) Africa/Addis_Ababa",
            "timeZone":"Africa/Addis_Ababa"
         }
      ],
      "zoneList":[
         {
            "name":"cn-hangzhou-h",
            "replicaType":"FULL"
         }
      ]
   },
   "requestId":"d17468e6-acb5-481f-924b-5b7705899221",
   "success":true
}