機能の概要
このAPIは、プロジェクトの各ステップの状態と進捗状況を照会するために使用されます。CommonProjectController.describeProjectStepsに対応しています。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/oms/project/steps
リクエストパラメータ
Header
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | proj-xxxxxxxx |
| X-Ob-Org-Id | String | はい | 組織ID | org-xxxxxxxx |
Query
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | いいえ | リクエストID | d04eabba-acef-4f4b-96f1-c657******** |
| id | String | はい | プロジェクトID | np_7befdmp08juo |
戻り値
パラメータ名 |
パラメータタイプ |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| requestId | String | リクエストID | req-xxx-xxx |
| cost | String | 所要時間 | 123ms |
| data | List<ProjectStepVO> |
プロジェクトステップリスト |
ProjectStepVO フィールド説明
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| id | String | ステップID | step-xxx |
| name | String | ステップ名。プロジェクトの段階に応じて返されます。列挙値：TRANSFER_PRECHECK（事前チェック）、STRUCT_TRANSFER（構造移行）、FULL_TRANSFER（全量移行）、FULL_VERIFIER（全量検証）、COUNT_VERIFIER（行数検証）、INCR_TRANSFER（増分移行）、TRANSFER_INCR_LOG_PULL（増分ログ取得。増分移行の設定に従って分割して返す）、INDEX_TRANSFER（インデックス移行）、INCR_VERIFIER（増分検証） |
FULL_TRANSFER |
| status | String | ステップの状態：INIT/RUNNING/FAILED/FINISHED/SUSPEND/MONITORING |
RUNNING |
| extraInfo | Object | ステップの拡張情報 | |
| startTime | String | 開始時間（UTC） | 2026-02-25T15:40:43Z |
| finishTime | String | 終了時間（UTC） | |
| progress | Integer | 進捗率 | 50 |
| stepInfo | Object | ステップの詳細。型はnameに応じて異なります。詳細は下記を参照してください。 |
stepInfoの型説明
ステップ name |
stepInfoの型 |
主要メトリクスフィールド |
|---|---|---|
FULL_TRANSFER |
FullTransferStepInfoVO | processedRecords（処理済み行数）、estimatedTotalRows（推定総行数） |
INCR_TRANSFER |
IncrTransferStepInfoVO | incrCheckpoint（増分チェックポイント、Unix秒）、checkpointSampleTime（チェックポイント取得日時） |
FULL_VERIFIER |
FullVerifierStepInfoVO | consistentTableCount、inconsistentTableCount、notSupportedTableCount、exceptionTableCount、processingTableCount |
COUNT_VERIFIER |
CountVerifierStepInfoVO | consistentTableCount、inconsistentTableCount、notSupportedTableCount、exceptionTableCount、processingTableCount、processedTableCount |
INCR_VERIFIER |
IncrVerifierStepInfoVO | consistentCount、initialInconsistentCount、finalInconsistentCount、startCheckpoint、endCheckpoint、sourceCheckpoint、destCheckpoint、checkpointSampleTime |
上記の表に記載されていないステップ（例：
TRANSFER_PRECHECK、STRUCT_TRANSFER、INDEX_TRANSFER、TRANSFER_INCR_LOG_PULLなど）では、stepInfoはnullを返します。
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/steps?id=np_7befdmp08juo' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'X-Ob-Org-Id: <Organization ID>'
レスポンス例
{
"success": true,
"requestId": "req-xxx-xxx",
"cost": "123ms",
"data": [
{
"id": "step-xxx",
"name": "FULL_TRANSFER",
"status": "RUNNING",
"progress": 50,
"stepInfo": {
"processedRecords": 50000,
"estimatedTotalRows": 100000
},
"startTime": "2026-02-25T15:40:43Z"
}
]
}