機能説明
このインターフェースは、指定されたOceanBaseクラスタ内のすべてのテナントの透過的データ暗号化（TDE）の状態と詳細を照会するために使用されます。テナント名でのフィルタリングとページネーション検索をサポートしています。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/security/tde
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| pageNumber | int | いいえ | ページ番号 | 1 |
| pageSize | int | いいえ | ページサイズ | 10 |
| tenantName | string | いいえ | テナント名 | pay_core |
| requestId | string | はい | リクエストID（追跡用） | dc302d76-66b5-48d8-ab53-a035******** |
戻り結果
名前 |
型 |
説明 |
示例値 |
|---|---|---|---|
| data | object | データ | - |
| tenantEncryptionList | array | テナント暗号化詳細リスト | - |
| enableEncryption | boolean | テナントの暗号化が有効かどうか | true |
| status | string | テナント暗号化状態
|
OPEN |
| tenantId | string | テナントID | txxx |
| tenantMode | string | テナントモード。MySQLまたはOracleをサポートします | Oracle |
| tenantName | string | テナント名 | test_mysql |
| tenantStatus | string | 現在のテナントステータス | ONLINE |
| totalCount | integer | 総件数 | 1 |
| requestId | string | リクエストID | 77e6179d-861e-41bf-9c45-aebf14c32fa6 |
| success | boolean | 成功かどうか | true |
例
リクエスト例
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'
レスポンス例
JSON形式
{
"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
}