機能の概要
指定されたOceanBase CloudインスタンスのSQL監査サービス設定の詳細を取得します。返される情報には、SQL監査サービスの状態、データ保持ポリシー、ストレージ容量設定、アクセスアドレスタイプ、関連するテナントレベルのフィルタールールなどが含まれます。このAPIでは、SQL監査機能の現在の実行状態とリソース設定を確認でき、監査サービスの把握と管理に役立ちます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/sqlaudit/info
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| openRequest | String | はい | Open requestパラメータ | None |
戻り値
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功したかどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Array | 業務データ(object) | None |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーアドレス、通常はOBServerノードのIP | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
data[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| status | String | タスクまたはリソースの現在の状態 | ONLINE |
| retentionTime | Integer | データ保持期間。 | 30 |
| hotDays | Integer | ホットデータ保持日数。 | 7 |
| serviceType | String | アドレスタイプ | PRIVATE |
| hotStorageSize | Integer | ホットデータストレージ容量。 | 200 |
| coldStorageSize | Integer | コールドデータストレージ容量。 | 200 |
| tenantName | String | テナント名 | xxxxxx |
| filterRule | Object | フィルタールール | None |
| filterRule.allUsers | Boolean | all Users | true |
| filterRule.users | Array | ユーザーリスト。 | ['admin'] |
| filterRule.auditResult | String | 監査結果 | example-value |
| filterRule.sqlTypes | Array | SQLの種類 | [{'id': 'resource-123456'}] |
| supported | Boolean | テナントの機密フィールド保護ルール機能をサポートするかどうか | true |
| disabledReason | String | 無効になっている理由 | example-value |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/sqlaudit/info?openRequest=open'
レスポンス例
JSON形式
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": [
{
"tenantId": "t4louaeei****",
"status": "ONLINE",
"retentionTime": 30,
"hotDays": 7,
"serviceType": "PRIVATE",
"hotStorageSize": 200,
"coldStorageSize": 200,
"tenantName": "xxxxxx",
"filterRule": {
"allUsers": true,
"users": "---\n- \"admin\"",
"auditResult": "example-value",
"sqlTypes": [
{}
]
},
"supported": true,
"disabledReason": "example-value"
}
],
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}