Overview
You can call this API to query the schema of a specified table in a specified tenant of a specified OceanBase Cloud instance. You can specify the table name, database name, and time range to obtain the detailed schema definition.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/schema
Request parameters
Path parameters
Query parameters
Request body parameters
Response parameters
Examples
Request example
curl -X POST \
-H "Content-Type: application/json" \
-u '<your ak:sk>' \
"https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/schema?requestId={requestId}" \
-d '{
"startTime": "2023-10-01 00:00:00",
"endTime": "2023-10-31 23:59:59",
"sqlType": "SELECT",
"sqlId": "8D6E84B0E0A7976E",
"requestId": "{requestId}",
"instanceId": "{instanceId}",
"tenantId": "{tenantId}",
"dbName": "test_db",
"tableNames": ["table1", "table2"]
}'
Response example
{
"code": "200",
"data": {
"tableSchemaList": [
{
"tableName": "table1",
"columns": [
{
"columnName": "id",
"dataType": "int",
"isNullable": "NO",
"columnDefault": null,
"extra": "auto_increment"
},
{
"columnName": "name",
"dataType": "varchar(255)",
"isNullable": "YES",
"columnDefault": null,
"extra": ""
}
]
}
]
},
"message": "success",
"requestId": "xxxxxx",
"server": "xxx.xxx.x.xxx:xxxx",
"success": true
}