機能説明
このインターフェースは、特定のOceanBaseクラスタのログバックアップタスクを照会するために使用されます。
呼び出し説明
インターフェース制約
呼び出し元は、少なくともそのクラスタのバックアップ・リストアに関する読み取り専用権限を持っている必要があります。
呼び出し元は、OCPアプリケーションサービスの認証を通過している必要があります。
リクエストパス
GET /api/v2/ob/clusters/{id}/backup/task/logBackupTasks
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| id | Long | はい | 1 | クラスタID。 |
| startTime | OffsetDateTime | いいえ | 2021-09-16T15:14:51.397+08:00 | 時間範囲の開始時刻 |
| endTime | OffsetDateTime | いいえ | 2021-09-16T15:20:51.397+08:00 | 時間範囲の終了時刻 |
| page | Long | はい | 1 | 照会するページ番号。 |
| size | Long | はい | 10 | 1ページあたりのタスク数。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| data | Object | リクエストされたデータ。 |
| ├─ contents | Array | LogBackupWrapperTaskの配列。詳細なデータ構造については、LogBackupWrapperTaskのデータ構造を参照してください。 |
| ├─ page | Object | ページ情報。 |
| ├─ totalElements | Integer | 総レコード数。 |
| ├─ totalPages | Integer | 総ページ数。 |
| ├─ number | Integer | 現在のページ番号。 |
| ├─ size | Integer | 現在のページサイズ。 |
| successful | Boolean | リクエストが成功したかどうか。 |
| timestamp | Datetime | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | Integer | サーバーがリクエストを処理した時間(ミリ秒)。 |
| status | Integer | HTTPステータスコード。 |
| traceId | String | リクエストのTrace Id。問題の調査に使用されます。 |
| server | String | リクエストに応答したアプリケーションサービスのアドレス。 |
LogBackupWrapperTaskのデータ構造
パラメータ |
型 |
説明 |
|---|---|---|
| createTime | Timestamp | 作成時間。 |
| modifyTime | Timestamp | 変更時間。 |
| clusterName | String | クラスタ名。 |
| clusterId | Long | クラスタID。 |
| obClusterId | Long | OceanBaseクラスタID。 |
| obTenantId | Long | OceanBase側テナントID。 |
| clusterType | String | クラスタタイプ。PRIMARY、STANDBYを含む。 |
| tenantId | Long | テナントID。 |
| tenantName | String | テナント名。 |
| status | String | ステータス。 |
| errorMsg | String | エラーメッセージ。 |
| backupUri | String | バックアップパス。 |
| checkpoint | Timestamp | 最新チェックポイント。 |
| backupMode | String | バックアップモード。 |
| delay | Long | ログ遅延時間。単位は秒。 |
例
リクエスト例
GET api/v2/ob/clusters/1000005/backup/task/logBackupTasks?page=1&size=10
レスポンス例
{
"data": {
"contents": [
{
"agentServerIp": "xxx.xxx.xxx.xxx",
"backupMode": "PHYSICAL_BACKUP",
"backupUri": "file:///obbackup/",
"checkpoint": "2021-09-23T14:33:17.357+0800",
"clusterId": 1000005,
"clusterName": "yc0820_17",
"clusterType": "PRIMARY",
"createTime": "2021-09-09T16:19:47.405+0800",
"delay": 77.6421,
"obClusterId": 5,
"status": "RUNNING"
}
],
"page": {
"number": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
},
"duration": 112,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-23T14:34:35.149+08:00",
"traceId": "0e74add7846c479c"
}