機能の概要
このAPIは、指定されたOB Cloudデータベースインスタンスで発生した特定の異常イベントの根本原因分析結果を照会するために使用されます。イベントIDを提供することで、そのイベントの詳細な根本原因分析レポートを取得し、データベースのパフォーマンスや安定性の問題の診断および解決に役立てることができます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/rcaResult
リクエストパラメータ
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudデータベースインスタンスID。 | obcluster-***** |
| requestId | string | はい | リクエストID。リクエストの経路追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
| eventId | string | はい | 根本原因分析結果を照会するイベントID。 | {eventId} |
| httpServletRequest | unknown | はい | Http servlet requestパラメータ。 | {httpServletRequest} |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | object | 根本原因分析結果の詳細データオブジェクト。 |
| requestId | string | リクエストID。入力パラメータと一致します。 |
| server | string | リクエストを処理したサーバーアドレス。 |
| success | boolean | リクエストが成功したかどうか。 |
例
リクエスト例
curl -X GET \
-H "Content-Type: application/json" \
-u '<あなたのAK:SK>' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/rcaResult?requestId={requestId}&eventId={eventId}&httpServletRequest={httpServletRequest}'
戻り値の例
{
"data": {
"eventId": "{eventId}",
"rootCause": "スロークエリステートメントが検出され、CPU使用率が急上昇しました。",
"analysisTime": "2023-10-12T09:45:30Z",
"details": {
"metric": "cpu_usage",
"threshold": 80,
"actualValue": 95,
"suggestions": ["SQLステートメントの最適化", "インスタンス仕様のアップグレード"]
}
},
"requestId": "{requestId}",
"server": "xxx.xxx.x.xxx:xxxx",
"success": true
}