Overview
You can call this API to query the transparent data encryption (TDE) status and details of all tenants in the specified OceanBase cluster. You can also filter the tenants by name and perform pagination.
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
GET /api/v2/instances/{instanceId}/security/tde
Request parameters
Path
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | obcluster-***** |
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| pageNumber | int | No | The page number of the returned results. | 1 |
| pageSize | int | No | The number of entries returned per page. | 10 |
| tenantName | string | No | The name of the tenant. | pay_core |
| requestId | string | Yes | The ID of the request, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | object | The data returned. | - |
| tenantEncryptionList | array | The list of tenant encryption details. | - |
| enableEncryption | boolean | Indicates whether encryption is enabled for the tenant. | true |
| status | string | The encryption status of the tenant.
|
OPEN |
| tenantId | string | The ID of the tenant. | txxx |
| tenantMode | string | The mode of the tenant. Valid values: MySQL and Oracle. | Oracle |
| tenantName | string | The name of the tenant. | test_mysql |
| tenantStatus | string | The status of the tenant. | ONLINE |
| totalCount | integer | The total number of entries. | 1 |
| requestId | string | The ID of the request. | 77e6179d-861e-41bf-9c45-aebf14c32fa6 |
| success | boolean | Indicates whether the request was successful. | true |
Examples
Request example
curl --digest -u '<Your ak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/tde?requestId={requestId}&pageNumber=1&pageSize=10&tenantName=pay_core'
Response example
JSON format
{
"data":{
"tenantEncryptionList":[
{
"enableEncryption":false,
"status":"CLOSE",
"tenantId":"txxx",
"tenantMode":"MySQL",
"tenantName":"test_mysql",
"tenantStatus":"ONLINE"
}
],
"totalCount":1
},
"requestId":"77e6179d-861e-41bf-9c45-aebf14c32fa6",
"success":true
}