機能説明
このAPIは、指定されたOceanBaseクラスタのテナントにあるリアルタイムのセッション情報を取得します。アクティブなセッションまたはすべてのセッションの詳細な統計情報を返します。セッションの状態、SQLテキスト、クライアントIP、サーバーIP、ユーザーなどの複数の条件でフィルタリングでき、セッション監視とパフォーマンス分析に役立ちます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/sessions
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID。 |
| tenantId | String | はい | テナントID。 |
Query
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| requestId | String | はい | リクエストID。リクエストの追跡に使用されます。 |
| status | String | いいえ | セッションの状態。特定の状態のセッションをフィルタリングするために使用されます。 |
| sqlText | String | いいえ | SQLステートメントのテキスト。特定のSQLを含むセッションをフィルタリングするために使用されます。 |
| clientIp | String | いいえ | クライアントIPアドレス。特定のクライアントからのセッションをフィルタリングするために使用されます。 |
| serverIp | String | いいえ | サーバーIPアドレス。特定のサーバー上にあるセッションをフィルタリングするために使用されます。 |
| users | String | いいえ | ユーザー名。特定のユーザーのセッションをフィルタリングするために使用されます。 |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | Object | セッションプロセス統計データ。 |
| requestId | String | リクエストID。 |
| success | Boolean | リクエストが成功したかどうか。 |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/sessions?requestId={requestId}&status={status}&sqlText={sqlText}&clientIp={clientIp}&serverIp={serverIp}&users={users}'
レスポンス例
JSON 形式
{
"data": {},
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"success": true
}