Overview
You can call this API to query the encryption information of a tenant.
API details
Constraints
The caller must have an AccessKey for accessing the APIs of ApsaraDB for OceanBase Database. 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
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obxxx |
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| pageNumber | int | No | The number of the page to return. Default value: 1. Maximum value: 50. | 1 |
| pageSize | int | No | The number of entries to return on a page. Default value: 10. | 10 |
| tenantName | string | No | The ID of the tenant. The value cannot be sys. | txxx |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | object | The data returned. | - |
| tenantEncryptionList | array | The list of encryption details of the tenant. | - |
| enableEncryption | boolean | Indicates whether encryption is enabled for the tenant. | true |
| status | string | The encryption status of the tenant. Valid values:
|
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 current 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 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/tde'
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
}