機能の概要
このAPIは、指定されたOceanBaseクラスタ内のテナントの透過的データ暗号化（TDE）を有効にするために使用します。有効になると、テナントのデータは保存時に自動的に暗号化され、データのセキュリティが向上します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/security/tde
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Body
パラメータ名 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| encryptionType | String | はい | 暗号化タイプ
|
INTERNAL |
| encryptionKeyId | String | いいえ | キーID
|
xxx |
実行結果
名称 |
型 |
説明 |
示例値 |
|---|---|---|---|
| data | object | 戻り値 | - |
| instanceId | string | インスタンスID | obxxx |
| tenantId | string | テナントID | txxx |
| encryptionType | string | 暗号化タイプ | INTERNAL |
| requestId | string | リクエストID | xxx |
| success | bool | 成功かどうか | true |
例
リクエスト例
curl --digest -u '<あなたのak:sk>' \
--request POST \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/security/tde?requestId={requestId}' \
--header 'Content-Type: application/json' \
--data '{
"encryptionType": "INTERNAL"
}'
戻り値例
JSON形式
{
"data":{
"instanceId":"obcluster-*****",
"tenantId":"t4louaeei****",
"encryptionType":"INTERNAL"
},
"requestId":"dc302d76-66b5-48d8-ab53-a035********",
"success":true
}