DescribeProject - Query project details|OceanBase Cloud |docs|OceanBase Documentations

DescribeProject - Query project details

Last Updated：2026-09-22 12:03:29 Updated

Overview

Queries details of a data migration or validation project. Corresponds to CommonProjectController.describeProject.

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

Request parameters

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
code	String	Error code.	null
message	String	Error description.	null
advice	String	Suggested action.	null
requestId	String	Request ID.	req-xxx-xxx
cost	String	Time taken.	123ms
data	ProjectDetailResponse	Project details object.

data fields

Field	Type	Description	Example value
id	String	Project ID.	np_7befdmp08juo
type	String	Project type: `MIGRATION` (data migration) or `VERIFY` (data validation).	MIGRATION
name	String	Project name.	Data migration project
tradeInstanceId	String	Transfer instance specification ID.	trade-xxx
owner	String	Project owner.	200006001999
status	String	Project status. Valid values: `INIT`, `RUNNING`, `SUSPEND`, `FAILED`, `FINISHED`, `RELEASING`, and `RELEASED`.	RUNNING
gmtCreate	String	Creation time (UTC).	2026-02-25T15:40:43Z
gmtModified	String	Modification time (UTC).	2026-02-25T15:40:43Z
gmtStart	String	Start time (UTC).	2026-02-25T15:41:00Z
gmtFinish	String	Completion time (UTC).
sourceDatasourceId	String	Source data source ID.	resource-123456
sinkDatasourceId	String	Destination data source ID.	resource-123456
sourceEndpointType	String	Source data source type.	MYSQL
sinkEndpointType	String	Destination data source type.	OB_MYSQL
isMerging	Boolean	Whether a merge is in progress.	false
isModifying	Boolean	Whether a modification is in progress.	false
isQuotaChanging	Boolean	Whether a specification change is in progress.	false
commonTransferConfig	Object	General transfer settings.
enableStructTransfer	Boolean	Whether schema transfer is enabled.	true
structTransferConfig	Object	Schema transfer settings.
enableFullTransfer	Boolean	Whether full data transfer is enabled.	true
fullTransferConfig	Object	Full data transfer settings.
enableFullVerify	Boolean	Whether full validation is enabled.	false
fullVerifyConfig	Object	Full validation settings.
enableIncrTransfer	Boolean	Whether incremental data transfer is enabled.	true
incrTransferConfig	Object	Incremental data transfer settings.
enableIncrVerify	Boolean	Whether incremental validation is enabled.	false
incrVerifyConfig	Object	Incremental validation settings.
countVerifyConfig	Object	Row count validation settings.
extraInfo	Object	Additional information, including runningStep and error information.

Examples

Request example

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>'

Response example

{
  "success": true,
  "code": null,
  "message": null,
  "requestId": "req-xxx-xxx",
  "cost": "123ms",
  "data": {
    "id": "np_7befdmp08juo",
    "type": "MIGRATION",
    "name": "Data migration project",
    "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": {}
  }
}

OceanBase

Customer Stories

Documentation