Overview
Queries modification records by project ID. Corresponds to CommonModifyProjectController.listProjectModifyRecords.
API details
Constraints
The caller must have an AccessKey to access the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey Secret, see Manage AccessKeys.
Request path
GET /api/v2/oms/project/modifyRecords
Request parameters
Header
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| X-Ob-Project-Id | String | Yes | Project ID. | proj-xxxxxxxx |
| X-Ob-Org-Id | String | Yes | Organization ID. | org-xxxxxxxx |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | No | Request ID. | d04eabba-acef-4f4b-96f1-c657******** |
| id | String | Yes | Project ID. | np_7befdmp08juo |
Response parameters
Field |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request succeeded. | true |
| requestId | String | Request ID. | req-xxx-xxx |
| cost | String | Time taken. | 123ms |
| data | List<DescribeModifyRecordResponse> |
List of modification records. |
Fields of each item in data
Field |
Type |
Description |
Example value |
|---|---|---|---|
| id | Long | Modification record ID. | 123456789 |
| subProjectId | String | Subproject ID (when adding tables). | np_xxx |
| type | String | Modification type. Valid values: INCREASE_OBJECT, DECREASE_OBJECT, MODIFY_OBJECT, MODIFY_ETL, MODIFY_VERIFICATION_OBJECT, and MODIFY_SUB_OBJECT. |
INCREASE_OBJECT |
| status | String | Modification record status. Valid values: PENDING, MODIFYING, RUNNING, MERGING, TERMINATING, TERMINATED, SUCCESS, FAILED, and CANCEL. |
RUNNING |
| errorDetail | Object | Error details. | |
| gmtModified | String | Modification time (UTC). | 2026-02-26T10:40:43Z |
Examples
Request example
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>'
Response example
{
"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"
}
]
}