全部产品
Search
文档中心

云数据库 OceanBase:ListProjectModifyRecords - 查询项目的修改记录

更新时间:Oct 23, 2024

该接口用于根据数据迁移或数据同步项目的 ID 查询项目的修改记录。

调试

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

授权信息

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

请求参数

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

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

np_598jmu****

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码(旧)。

INNER_ERROR
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

建议(新)。

Contact the administrator.
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

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

null
Codestring

错误码(旧)。

INNER_ERROR
Messagestring

错误描述(旧)。

A system error occurred.
Advicestring

建议。

Contact the administrator.
RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumberinteger

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

1
PageSizeinteger

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

10
TotalCountlong

总数,分页查询时生效。

100
Coststring

请求耗时,单位为秒。

30
Dataarray<object>

项目修改记录的相关信息。

Dataobject
Idlong

修改记录的 ID。

344000005
SubProjectIdstring

子项目的 ID(增加表时产生)。

np_598qm***
MergeRequestIdlong

合并父子项目的工单 ID,用于增加表的场景。

id
UpdateRequestIdlong

更新父项目工单 ID,用于减表或已有表对象更新的场景。

id
Typestring

修改记录任务类型,包括 INCREASE_OBJECT(增加对象)和 DECREASE_OBJECT(减少对象)。

INCREASE_OBJECT
Statusstring

修改记录的状态,包括:

  • PENDING:待执行
  • MODIFYING:修改中(减表修改父项目工单的执行,加表创建子项目)
  • RUNNING:运行中(子项目运行中)
  • MERGING:合并中(父子项目符合合并条件)
  • TERMINATED:已终止
  • SUCCESS:成功
  • FAILED:失败
  • CANCEL:已取消
PENDING
ErrorDetailobject

错误详情。

Codestring

错误码(旧)。

INNER_ERROR
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
Databasesarray<object>

减少的对象(同步)。

Databaseobject
MappedNamestring

数据库的映射名称。

mapped_db
Namestring

数据库的名称。

db_name
Idstring

数据库的 ID。

db_id
Tablesarray<object>

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

Tableobject
MappedNamestring

表或 Topic 的映射名称。

mapped_name
Namestring

表的名称。

table_name
Idstring

表的 ID。

table_id
WhereClausestring

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

id < 1
FilterColumnsarray

过滤列集合。

FilterColumnstring

过滤列。

col
ShardColumnsarray

分片键列集合。

ShardColumnstring

分片键列。

col1
Columnsarray<object>

待传输列的列表。

Columnobject
ColumnNamestring

列的名称。

col_name
MappedNamestring

列的映射名称。

mapped_col
Positioninteger

列的位置。

null
ColumnTypestring

列的类型。

FLOAT
RecordFieldTypestring

列类型的引申(包括 INT8, INT16, INT24, INT32, INT64, BIGINT, BOOLEAN, FLOAT, DOUBLE, DECIMAL, NUMBER, SMALL_MONEY, MONEY, DEC_FLOAT, REAL, UCHAR_STRING, GRAPHIC_STRING, CHAR_STRING, NCHAR_STRING, VAR_GRAPHIC_STRING, VAR_UCHAR_STRING, VAR_STRING, VAR_CHAR_STRING, VAR_NCHAR_STRING, ROW_ID, UROWID, TEXT, NTEXT, UTEXT, TINY_TEXT, MEDIUM_TEXT, LONG_TEXT, BINARY_BYTES, VAR_BINARY_BYTES, RAW, LONG_RAW, BIT, VAR_BIT, BLOB, TINY_BLOB, MEDIUM_BLOB, LONG_BLOB, BFILE, IMAGE, JSONB, UUID, ENUM, SET, INTERVAL_DAY_TO_SECOND, INTERVAL_YEAR_TO_MONTH, INTERVAL_DATE_TIME, CLOB, NCLOB, XML, JSON, LONG_VAR_CHAR, LONG_VAR_GRAPHIC, GEOGRAPHY, GEOMETRY, POINT, LSEG, BOX, PATH, CIRCLE, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION, CIDR, INET, MACADDR, MACADDR8, TSVERCTOR, TSQUERY, YEAR, DATE, MYSQL_NEW_DATE, TIME, TIME_WITH_NANOS, TIME_WITH_TIMEZONE, SMALL_DATETIME, DATETIME, DATETIME_WITH_NONAS, TIMESTAMP_IN_LONG, TIMESTAMP_IN_LONG_WITH_NANOS, TIMESTAMP, TIMESTAMP_WITH_NANOS, TIMESTAMP_WITH_TIMEZONE, TIMESTAMP_WITH_LOCAL_TIMEZONE, ZONED_DATETIME, OID, REGCLASS, REGCOLLATION, REGCONFIG, REGDICTIONARY, REGNAMESPACE, REGOPER, REGOPERATOR, REGROLE, REGTYPE, INT4RANGE, INT8RANGE, NUMRANGE, TSRANGE, TSTZRANGE, DATERANGE, STRUCT, LIST, NULL, CUSTOM_TYPE, UNIQUEIDENTIFIER, UNSUPPORTED_TYPE)。

INT8
RawColumnTypestring

数据库记录的列类型的原始字符串。

null
ColumnKeystring

索引的类型,包括 PRI、UNI 和 MUL。

PRI
Nullableboolean

是否可以为空。

true
DefaultValuestring

默认值。

null
DataLengthlong

列的长度。

null
DataPrecisioninteger

列的精度。

64
DataScaleinteger

小数点。

null
Encodingstring

列的字符编码。

utf8
ColumnCommentstring

列的注释。

comments
IsGenerateFieldboolean

是否为隐藏列。

false
Typestring

包括 DATABASE 和 TABLE。

DATABASE
AdbTableSchemaobject

ADB 数据源的映射信息。

PrimaryKeysarray

主键列集合。

PrimaryKeystring

主键列。

pk
DistributedKeysarray

分布键列集合。

DistributedKeystring

分布键列。

col2
PartitionStatementstring

分区表达式。

PARTITION BY VALUE('id')
PartitionLifeCycleinteger

表的生命周期。

30
Viewsarray<object>

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

Viewobject
MappedNamestring

视图的映射名称。

mapped_view
Namestring

表的名称。

table_name
Idstring

表的 ID。

table_id
WhereClausestring

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

id<1
FilterColumnsarray

过滤列集合。

FilterColumnstring

过滤列。

col
ShardColumnsarray

分片键列集合。

ShardColumnstring

分片键列。

col1
Columnsarray<object>

待传输列的列表。

Columnobject
ColumnNamestring

列的名称。

col_name
MappedNamestring

列的映射名称。

mapped_name
Positioninteger

列的位置。

null
ColumnTypestring

列的类型。

FLOAT
RecordFieldTypestring

列类型的引申。

INT8
RawColumnTypestring

数据库记录的列类型的原始字符串。

null
ColumnKeystring

索引的类型,包括 PRI、UNI 和 MUL。

PRI
Nullableboolean

是否可以为空。

false
DefaultValuestring

默认值。

null
DataLengthlong

列的长度。

null
DataPrecisioninteger

列的精度。

64
DataScaleinteger

小数点。

null
Encodingstring

列的字符编码。

utf16
ColumnCommentstring

列的注释。

comments
IsGenerateFieldboolean

是否为隐藏列。

false
Typestring

包括 DATABASE 和 TABLE。

DATABASE
AdbTableSchemaobject

ADB 数据源的映射信息。

PrimaryKeysarray

主键列集合。

PrimaryKeystring

主键列。

pk
DistributedKeysarray

分布键列集合。

DistributedKeystring

分布键列。

col2
PartitionStatementstring

分区表达式。

PARTITION BY VALUE('id')
PartitionLifeCycleinteger

表的生命周期。

30
SpecificTablesarray<object>

具体表对象的配置集合。

SpecificTableobject
MappedNamestring

表或 Topic 的映射名称。

mapped_name
Namestring

表的名称。

table_name
Idstring

表的 ID。

table_id
WhereClausestring

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

id<3
FilterColumnsarray

过滤列集合。

FilterColumnstring

过滤列。

col
ShardColumnsarray

分片键列集合。

ShardColumnstring

分片键列。

col2
Columnsarray<object>

待传输列的列表。

Columnobject
ColumnNamestring

列的名称。

col_name
MappedNamestring

列的映射名称。

mapped_name
Positioninteger

列的位置。

null
ColumnTypestring

列的类型。

FLOAT
RecordFieldTypestring

列类型的引申。

INT8
RawColumnTypestring

数据库记录的列类型的原始字符串。

null
ColumnKeystring

索引的类型,包括 PRI、UNI 和 MUL。

PRI
Nullableboolean

是否可以为空。

false
DefaultValuestring

默认值。

null
DataLengthlong

列的长度。

null
DataPrecisioninteger

列的精度。

64
DataScaleinteger

小数点。

null
Encodingstring

列的字符编码。

utf16
ColumnCommentstring

列的注释。

comments
IsGenerateFieldboolean

是否为隐藏列。

false
Typestring

包括 DATABASE 和 TABLE。

DATABASE
AdbTableSchemaobject

ADB 数据源的映射信息。

PrimaryKeysarray

主键列集合。

PrimaryKeystring

主键列。

pk
DistributedKeysarray

分布键列集合。

DistributedKeystring

分布键列。

col2
PartitionStatementstring

分区表达式。

PARTITION BY VALUE('id')
PartitionLifeCycleinteger

表的生命周期。

30
SpecificViewsarray<object>

具体视图对象的配置列表。

SpecificViewobject
MappedNamestring

表或 Topic 的映射名称。

mapped_name
Namestring

表的名称。

table_name
Idstring

表的 ID。

table_id
WhereClausestring

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

id < 1
FilterColumnsarray

过滤列集合。

FilterColumnstring

过滤列。

col1
ShardColumnsarray

分片键列集合。

ShardColumnstring

分片键列。

col2
Columnsarray<object>

待传输列的列表。

Columnobject
ColumnNamestring

列的名称。

col_name
MappedNamestring

列的映射名称。

mapped_name
Positioninteger

列的位置。

null
ColumnTypestring

列的类型。

FLOAT
RecordFieldTypestring

列类型的引申。

INT8
RawColumnTypestring

数据库记录的列类型的原始字符串。

null
ColumnKeystring

索引的类型,包括 PRI、UNI 和 MUL。

PRI
Nullableboolean

是否可以为空。

true
DefaultValuestring

默认值。

null
DataLengthlong

列的长度。

null
DataPrecisioninteger

列的精度。

64
DataScaleinteger

小数点。

null
Encodingstring

列的字符编码。

utf16
ColumnCommentstring

列的注释。

comments
IsGenerateFieldboolean

是否为隐藏列。

false
Typestring

包括 DATABASE 和 TABLE。

DATABASE
AdbTableSchemaobject

ADB 数据源的映射信息。

PrimaryKeysarray

主键列集合。

PrimaryKeystring

主键列。

pk
DistributedKeysarray

分布键列集合。

DistributedKeystring

分布键列。

col2
PartitionStatementstring

分区表达式。

PARTITION BY VALUE('id')
PartitionLifeCycleinteger

表的生命周期。

30
MigrationObjectsInfoobject

减少的对象(迁移)。

WildcardModeboolean

是否为通配模式。

true
Tablesarray<object>

待迁移表的列表。

Tableobject
Schemastring

数据库的名称。

schema_name
Namestring

迁移对象的名称。

table_name
TablesBlackarray<object>

待迁移表的黑名单列表。

TablesBlackobject
Schemastring

数据库的名称。

schema_name
Namestring

对象名称。

table_name
Viewsarray<object>

待迁移视图的列表。

Viewobject
Schemastring

数据库的名称。

schema_name
Namestring

对象名称。

view_name
ViewsBlackarray<object>

待迁移视图的黑名单列表。

ViewsBlackobject
Schemastring

数据库的名称。

schema_name
Namestring

对象名称。

view_name
OmsProjectMappingInfoobject

减少对象对应的匹配规则(迁移)。

SchemaMappingsarray<object>

Schema 映射信息列表。

SchemaMappingobject
SourceNamestring

源端 Schema 的名称。

source_name
DestNamestring

Schema 的映射名称。

mapped_schema
TableMappingsarray<object>

表映射信息列表。

TableMappingobject
SourceSchemastring

源端 Schema 的名称。

source_schema
SourceNamestring

源端的对象名称。

source_name
DestNamestring

对象的映射名称。

dest_name
ColumnMappingsarray<object>

列的映射信息列表。

ColumnMappingobject
SourceSchemastring

源端 Schema 的名称。

source_schema
SourceTablestring

源端表的名称。

source_table
SourceNamestring

源端对象的名称。

source_name
DestNamestring

目标端对象的名称。

dest_name
ViewMappingsarray<object>

视图的映射信息列表。

ViewMappingobject
SourceSchemastring

源端 Schema 的名称。

schema_name
SourceNamestring

源端对象的名称。

source_name
DestNamestring

对象的映射名称。

dest_name
TableEtlListarray<object>

减少对象的 ETL 信息(迁移)。

TableEtlListobject
TenantNamestring

租户的名称。

tenant_name
Databasestring

源端数据库的名称。

db_name
DestDatabasestring

目标端数据库的名称。

dest_db
TableNamestring

源端表的名称。

table_name
DestNamestring

目标端表或 Topic 的名称。

dest_name
WhereClausestring

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

id>1
FilterColumnsarray

过滤列集合。

FilterColumnstring

过滤列。

col
ShardColumnsarray

分片键列集合。

ShardColumnstring

分片键列。

null
LogicTableIdstring

针对逻辑表下,逻辑表的 ID。

null
SourceEndpointIdstring

针对物理表下传递 endpointId。

null
GmtModifiedstring

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

2023-07-13T06:26:15

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "INNER_ERROR",
    "Level": "ERROR",
    "Message": "A system error occurred.\n",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "Contact the administrator. ",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.\n",
  "Advice": "Contact the administrator. ",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "Cost": "30",
  "Data": [
    {
      "Id": 344000005,
      "SubProjectId": "np_598qm***",
      "MergeRequestId": 0,
      "UpdateRequestId": 0,
      "Type": "INCREASE_OBJECT",
      "Status": "PENDING",
      "ErrorDetail": {
        "Code": "INNER_ERROR",
        "Level": "ERROR",
        "Message": "A system error occurred.\n",
        "ExtraContext": {
          "key": "null"
        },
        "MessageMcmsKey": "null",
        "MessageMcmsContext": {
          "key": "null"
        },
        "Reason": "null",
        "ReasonMcmsKey": "null",
        "ReasonMcmsContext": {
          "key": "null"
        },
        "Proposal": "null",
        "ProposalMcmsKey": "null",
        "ProposalMcmsContext": {
          "key": "null"
        },
        "UpstreamErrorDetail": "null"
      },
      "Databases": [
        {
          "MappedName": "mapped_db",
          "Name": "db_name",
          "Id": "db_id",
          "Tables": [
            {
              "MappedName": "mapped_name",
              "Name": "table_name",
              "Id": "table_id",
              "WhereClause": "id < 1",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col1"
              ],
              "Columns": [
                {
                  "ColumnName": "col_name",
                  "MappedName": "mapped_col",
                  "Position": 0,
                  "ColumnType": "FLOAT",
                  "RecordFieldType": "INT8",
                  "RawColumnType": "null",
                  "ColumnKey": "PRI",
                  "Nullable": true,
                  "DefaultValue": "null",
                  "DataLength": 0,
                  "DataPrecision": 64,
                  "DataScale": 0,
                  "Encoding": "utf8",
                  "ColumnComment": "comments",
                  "IsGenerateField": false,
                  "Type": "DATABASE"
                }
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col2"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')",
                "PartitionLifeCycle": 30
              }
            }
          ],
          "Views": [
            {
              "MappedName": "mapped_view",
              "Name": "table_name",
              "Id": "table_id",
              "WhereClause": "id<1",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col1"
              ],
              "Columns": [
                {
                  "ColumnName": "col_name",
                  "MappedName": "mapped_name",
                  "Position": 0,
                  "ColumnType": "FLOAT",
                  "RecordFieldType": "INT8",
                  "RawColumnType": "null",
                  "ColumnKey": "PRI",
                  "Nullable": false,
                  "DefaultValue": "null",
                  "DataLength": 0,
                  "DataPrecision": 64,
                  "DataScale": 0,
                  "Encoding": "utf16",
                  "ColumnComment": "comments",
                  "IsGenerateField": false,
                  "Type": "DATABASE"
                }
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col2"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')",
                "PartitionLifeCycle": 30
              }
            }
          ],
          "SpecificTables": [
            {
              "MappedName": "mapped_name",
              "Name": "table_name",
              "Id": "table_id",
              "WhereClause": "id<3",
              "FilterColumns": [
                "col"
              ],
              "ShardColumns": [
                "col2"
              ],
              "Columns": [
                {
                  "ColumnName": "col_name",
                  "MappedName": "mapped_name",
                  "Position": 0,
                  "ColumnType": "FLOAT",
                  "RecordFieldType": "INT8",
                  "RawColumnType": "null",
                  "ColumnKey": "PRI",
                  "Nullable": false,
                  "DefaultValue": "null",
                  "DataLength": 0,
                  "DataPrecision": 64,
                  "DataScale": 0,
                  "Encoding": "utf16",
                  "ColumnComment": "comments",
                  "IsGenerateField": false,
                  "Type": "DATABASE"
                }
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col2"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')",
                "PartitionLifeCycle": 30
              }
            }
          ],
          "SpecificViews": [
            {
              "MappedName": "mapped_name",
              "Name": "table_name",
              "Id": "table_id",
              "WhereClause": "id < 1",
              "FilterColumns": [
                "col1"
              ],
              "ShardColumns": [
                "col2"
              ],
              "Columns": [
                {
                  "ColumnName": "col_name",
                  "MappedName": "mapped_name",
                  "Position": 0,
                  "ColumnType": "FLOAT",
                  "RecordFieldType": "INT8",
                  "RawColumnType": "null",
                  "ColumnKey": "PRI",
                  "Nullable": true,
                  "DefaultValue": "null",
                  "DataLength": 0,
                  "DataPrecision": 64,
                  "DataScale": 0,
                  "Encoding": "utf16",
                  "ColumnComment": "comments",
                  "IsGenerateField": false,
                  "Type": "DATABASE"
                }
              ],
              "AdbTableSchema": {
                "PrimaryKeys": [
                  "pk"
                ],
                "DistributedKeys": [
                  "col2"
                ],
                "PartitionStatement": "PARTITION BY VALUE('id')",
                "PartitionLifeCycle": 30
              }
            }
          ]
        }
      ],
      "MigrationObjectsInfo": {
        "WildcardMode": true,
        "Tables": [
          {
            "Schema": "schema_name",
            "Name": "table_name"
          }
        ],
        "TablesBlack": [
          {
            "Schema": "schema_name",
            "Name": "table_name"
          }
        ],
        "Views": [
          {
            "Schema": "schema_name",
            "Name": "view_name"
          }
        ],
        "ViewsBlack": [
          {
            "Schema": "schema_name",
            "Name": "view_name"
          }
        ]
      },
      "OmsProjectMappingInfo": {
        "SchemaMappings": [
          {
            "SourceName": "source_name",
            "DestName": "mapped_schema"
          }
        ],
        "TableMappings": [
          {
            "SourceSchema": "source_schema",
            "SourceName": "source_name",
            "DestName": "dest_name"
          }
        ],
        "ColumnMappings": [
          {
            "SourceSchema": "source_schema",
            "SourceTable": "source_table",
            "SourceName": "source_name",
            "DestName": "dest_name"
          }
        ],
        "ViewMappings": [
          {
            "SourceSchema": "schema_name",
            "SourceName": "source_name",
            "DestName": "dest_name"
          }
        ]
      },
      "TableEtlList": [
        {
          "TenantName": "tenant_name",
          "Database": "db_name",
          "DestDatabase": "dest_db",
          "TableName": "table_name",
          "DestName": "dest_name",
          "WhereClause": "id>1",
          "FilterColumns": [
            "col"
          ],
          "ShardColumns": [
            "null"
          ],
          "LogicTableId": "null",
          "SourceEndpointId": "null"
        }
      ],
      "GmtModified": "2023-07-13T06:26:15"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史