機能説明
このインターフェースは、データ移行/検証プロジェクトの詳細を照会するために使用されます。CommonProjectController.describeProjectに対応します。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/oms/project
リクエストパラメータ
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 |
| code | String | エラーコード | null |
| message | String | エラーの説明 | null |
| advice | String | 対処の推奨事項 | null |
| requestId | String | リクエストID | req-xxx-xxx |
| cost | String | 所要時間 | 123ms |
| data | ProjectDetailResponse | プロジェクト詳細オブジェクト |
dataフィールドの説明
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| id | String | プロジェクトID | np_7befdmp08juo |
| type | String | プロジェクトタイプ：MIGRATION（データ移行）/ VERIFY（データ検証） |
MIGRATION |
| name | String | プロジェクト名 | データ移行プロジェクト |
| tradeInstanceId | String | 転送インスタンス仕様ID | trade-xxx |
| owner | String | プロジェクト所有者 | 200006001999 |
| status | String | プロジェクト状態。列挙値：INIT、RUNNING、SUSPEND、FAILED、FINISHED、RELEASING、RELEASED |
RUNNING |
| gmtCreate | String | 作成時間（UTC） | 2026-02-25T15:40:43Z |
| gmtModified | String | 変更時間（UTC） | 2026-02-25T15:40:43Z |
| gmtStart | String | 開始時間（UTC） | 2026-02-25T15:41:00Z |
| gmtFinish | String | 完了時間（UTC） | |
| sourceDatasourceId | String | ソース側データソースID | resource-123456 |
| sinkDatasourceId | String | ターゲット側データソースID | resource-123456 |
| sourceEndpointType | String | ソース側データソースタイプ | MYSQL |
| sinkEndpointType | String | ターゲット側データソースタイプ | OB_MYSQL |
| isMerging | Boolean | 現在マージ中かどうか | false |
| isModifying | Boolean | 現在変更中かどうか | false |
| isQuotaChanging | Boolean | 現在リソース構成を変更中かどうか | false |
| commonTransferConfig | Object | 汎用転送設定 | |
| enableStructTransfer | Boolean | 構造転送を有効にするかどうか | true |
| structTransferConfig | Object | 構造転送設定 | |
| enableFullTransfer | Boolean | 全量転送を有効にするかどうか | true |
| fullTransferConfig | Object | 全量転送設定 | |
| enableFullVerify | Boolean | 全量検証を有効にするかどうか | false |
| fullVerifyConfig | Object | 全量検証設定 | |
| enableIncrTransfer | Boolean | 増分転送を有効にするかどうか | true |
| incrTransferConfig | Object | 増分転送設定 | |
| enableIncrVerify | Boolean | 増分検証を有効にするかどうか | false |
| incrVerifyConfig | Object | 増分検証設定 | |
| countVerifyConfig | Object | 行数検証設定 | |
| extraInfo | Object | 拡張情報（runningStep、エラー情報などを含む） |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project?id=np_7befdmp08juo' \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'X-Ob-Org-Id: <Organization ID>'
戻り値の例
{
"success": true,
"code": null,
"message": null,
"requestId": "req-xxx-xxx",
"cost": "123ms",
"data": {
"id": "np_7befdmp08juo",
"type": "MIGRATION",
"name": "データ移行プロジェクト",
"tradeInstanceId": "trade-xxx",
"owner": "200006001999",
"status": "RUNNING",
"gmtCreate": "2026-02-25T15:40:43Z",
"gmtModified": "2026-02-25T15:40:43Z",
"gmtStart": "2026-02-25T15:41:00Z",
"gmtFinish": null,
"sourceDatasourceId": "resource-123456",
"sinkDatasourceId": "resource-123456",
"sourceEndpointType": "MYSQL",
"sinkEndpointType": "OB_MYSQL",
"isMerging": false,
"isModifying": false,
"isQuotaChanging": false,
"enableStructTransfer": true,
"enableFullTransfer": true,
"enableIncrTransfer": true,
"enableFullVerify": false,
"enableIncrVerify": false,
"extraInfo": {}
}
}