機能の概要
このAPIは、プロジェクトIDに基づいて変更履歴のリストを取得するために使用されます。CommonModifyProjectController.listProjectModifyRecordsに対応しています。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/oms/project/modifyRecords
リクエストパラメータ
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<DescribeModifyRecordResponse> |
変更履歴のリスト |
dataリスト項目フィールド説明
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| id | Long | 変更レコードID | 123456789 |
| subProjectId | String | サブプロジェクトID（テーブル追加シナリオ） | np_xxx |
| type | String | 変更タイプ。列挙値：INCREASE_OBJECT、DECREASE_OBJECT、MODIFY_OBJECT、MODIFY_ETL、MODIFY_VERIFICATION_OBJECT、MODIFY_SUB_OBJECT |
INCREASE_OBJECT |
| status | String | 変更レコードステータス。列挙値：PENDING、MODIFYING、RUNNING、MERGING、TERMINATING、TERMINATED、SUCCESS、FAILED、CANCEL |
RUNNING |
| errorDetail | Object | エラー詳細 | |
| gmtModified | String | 変更時間（UTC） | 2026-02-26T10:40:43Z |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/oms/project/modifyRecords?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": 123456789,
"subProjectId": "np_xxx",
"type": "INCREASE_OBJECT",
"status": "RUNNING",
"errorDetail": null,
"gmtModified": "2026-02-26T10:40:43Z"
}
]
}