文档

DescribeProject - 查询项目的详情

更新时间:

本接口用于查询数据迁移或数据同步项目的项目详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Idstring

数据迁移或数据同步项目的 ID。

np_fe****

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码(新)。

CM-RESOAT1111
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

ERROR
Messagestring

错误描述(新)。

A system error occurred.
ExtraContextobject

用于填充 Message 中的占位符。

any

用于填充 Message 中的占位符。

null
MessageMcmsKeystring

错误信息的 Key。

null
MessageMcmsContextobject

用于填充 MessageMcmsKey 中的占位符。

string

用于填充 MessageMcmsKey 中的占位符。

null
Reasonstring

错误原因。

null
ReasonMcmsKeystring

错误原因的 Key。

null
ReasonMcmsContextobject

错误原因的上下文。

string

错误原因的上下文。

null
Proposalstring

建议(新)。

null
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

上游错误详情,用于处理 HTTP 请求。

null
Codestring

错误码(旧)。

INNER_ERROR
Messagestring

错误描述。

A system error occurred.
Advicestring

建议。

Contact the administrator.
RequestIdstring

请求 ID。

473469C7-XXXX-XXXX-B3DB-A3DC0DE3C83E
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效。

10
TotalCountlong

总数,分页查询时生效。

2
Coststring

请求耗时,单位为秒。

1
Dataobject

数据

WorkerGradeIdstring

传输实例的 ID。

g_i4wa7***
WorkerGradeInfoobject

传输实例的详情。

Idstring

传输实例的 ID。

g_i4wa7***
Namestring

传输实例的别名。

i5fuij***
Gradestring

传输实例的规格。

OMS_G2_MIGRATION_LARGE
Specstring

传输实例的规格大小。

LARGE
SpecNamestring

传输实例规格大小的名称。

LARGE
SourceTypestring

源端数据源的类型。

OB_MYSQL
SourceRegionstring

源端数据源所在的地域。

ap-southeast-1
DestTypestring

目标端数据源的类型。

OB_MYSQL
DestRegionstring

目标端数据源所在的地域。

ap-southeast-1
ChargeTypestring

数据迁移或数据同步项目的计费类型。

POSTPAY
AutoRenewalboolean

是否开启自动续费。

false
Expiredboolean

是否已到期。

false
EndTimestring

到期时间。支持 UTC 时间,格式为 YYYY-MM-DDThh:mm:ss。

2024-02-02T16:00:00
GmtCreatestring

创建时间。支持 UTC 时间,格式为 YYYY-MM-DDThh:mm:ss。

2024-01-28T14:07:44
Idstring

项目的 ID。

np_fe****
Typestring

项目的类型,包括 MIGRATION(表示数据迁移项目)和 SYNC(表示数据同步项目)。

SYNC
Namestring

项目的名称,不能包含空格。

test
Labelsobject []

标签的集合,最多支持 5 个。

Idstring

标签 ID。

l_dr****
Namestring

标签的名称。

test_tag
Ownerstring

项目的 Owner。

omsefry***
Importancestring

项目的告警等级,包括 HIGH(高保护状态)、MEDIUM(中保护状态)、LOW(低保护状态)和 IGNORE(无保护状态)。

HIGH
Statusstring

数据迁移或数据同步项目的状态,包括 INIT(未启动)、RUNNING(运行中)、SUSPEND(已暂停)、FAILED(失败)、FINISHED(已完成)、RELEASING(释放中)、RELEASED(已释放)、DELETED(已删除)、RUNNING_MODIFYING(修改中)和 RUNNING_MERGING(合并中)。

RUNNING
GmtCreatestring

项目的创建时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T06:26:15
GmtModifiedstring

项目的更新时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T06:26:15
GmtStartstring

项目的开始运行时间。

2023-07-13T07:02:27
GmtFinishstring

项目的结束运行时间。

2023-07-13T07:02:27
DestConnIdstring

目标端连接信息的 ID。

c_deg***
IsMergingboolean

是否处于合并中。

false
IsModifyingboolean

是否处于修改中。

false
IsSubProjectboolean

是否为子项目。

false
SourceEndpointTypestring

源端数据源的类型。

枚举值:
  • POLARDB_X_1POLARDB_X_1
  • MYSQLMYSQL
  • TIDBTIDB
  • OB_ORACLEOB_ORACLE
  • OB_MYSQLOB_MYSQL
  • ORACLEORACLE
  • POLARDB_X_2POLARDB_X_2
OB_MYSQL
SinkEndpointTypestring

目标端数据源的类型。

枚举值:
  • MYSQLMYSQL
  • OB_ORACLEOB_ORACLE
  • KAFKAKAFKA
  • ROCKETMQROCKETMQ
  • DATAHUBDATAHUB
  • OB_MYSQLOB_MYSQL
  • ORACLEORACLE
  • ADBADB
MYSQL
TransferMappingobject

传输对象及其映射关系。

Modestring

传输对象映射模式,包括 SPECIFIC(表示指定对象)和 WILDCARD(表示匹配规则)。

SPECIFIC
Databasesobject []

数据库对象列表。

Typestring

数据库的类型。

MYSQL
Idstring

数据库的 ID。

db_id
Namestring

数据库的名称。

db_name
MappedNamestring

数据库的映射名称。

mapped_db
TenantNamestring

映射对象租户,源端为 OceanBase 数据源时生效。

tenant_name
Tablesobject []

当前数据库中传输表对象的配置。ModeWILDCARD 时,该参数表示具体黑名单或白名单的配置,表和视图共用。

Namestring

表的名称。

table_name
MappedNamestring

表的映射名称。

mapped_table
Idstring

表的 ID。

table_id
WhereClausestring

通过标准的 SQL 语句中的 WHERE 子句,用于配置行过滤。

id > 1
FilterColumnsarray

过滤列集合。

string

过滤列。

col
ShardColumnsarray

分片键列集合。

string

分片键列。

col1
AdbTableSchemaobject

ADB 数据源的映射信息。

PrimaryKeysarray

主键列集合。

string

主键列。

pk
DistributedKeysarray

分布键列集合。

string

分布键列。

col2
PartitionStatementstring

分区表达式。

PARTITION BY VALUE('id')
PartitionLifeCyclestring

表的生命周期。

30
Viewsobject []

当前数据库中传输视图对象的配置列表。

Namestring

视图的名称。

view_name
MappedNamestring

视图的映射名称。

mapped_view
Idstring

视图的 ID。

fexdg***