文档

UpdateProjectConfig - 更新项目配置

更新时间:

本接口用于更新数据迁移或数据同步项目的配置。

接口说明

本接口使用全量替换式更新:

  • 全部覆盖:当您调用本接口时,需要传入一整套完整的配置信息。
  • 未传即删:在新的配置集中未包含的任何旧配置项,都将被删除。
  • 差异更新:只有与系统当前记录不一致的配置项会被更新至您传入的新值。

调试

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

授权信息

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

请求参数

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

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

np_fe****
FullTransferConfigobject

全量传输配置。

WriteWorkerNuminteger

写入并发数。

64
ReadWorkerNuminteger

读取并发数。

64
ThrottleRpsinteger

全量传输阶段限制能达到的最大传输速率,单位为记录数/秒。输入 null 时,表示不限制 RPS。

null
ThrottleIOPSinteger

全量传输阶段限制能达到的最大传输流量,单位为字节/秒。输入 null 时,表示不限制 IOPS。

null
IncrTransferConfigobject

增量传输配置。

IncrSyncThreadCountinteger

增量传输的线程数。

64
ThrottleRpsinteger

增量传输阶段限制能达到的最大传输速率,单位为记录数/秒。输入 null 时,表示不限制 RPS。

null
ThrottleIOPSinteger

增量传输阶段限制能达到的最大传输流量,单位为字节/秒。输入 null 时,表示不限制 IOPS。

null
RecordTypeWhiteListarray

有增量同步阶段时,同步的增量数据类型。

string

有增量同步阶段时,同步的增量数据类型。

INSERT
SupportDDLTypesarray

支持的 DDL 类型。

string

增量传输阶段支持的 DDL 类型。

CREATE_TABLE
ReverseIncrTransferConfigobject

反向增量传输配置。

IncrSyncThreadCountinteger

反向增量传输的线程数。

64
ThrottleRpsinteger

反向增量传输阶段限制能达到的最大传输速率,单位为记录数/秒。输入 null 时,表示不限制 RPS。

null
ThrottleIOPSinteger

反向增量传输阶段限制能达到的最大传输流量,单位为字节/秒。输入 null 时,表示不限制 IOPS。

null
RecordTypeWhiteListarray

有增量同步阶段时,同步的增量数据类型。

string

有反向增量同步阶段时,同步的增量数据类型。

INSERT
SupportDDLTypesarray

反向增量传输阶段支持的 DDL 类型。

string

反向增量传输阶段支持的 DDL 类型。

CREATE_TABLE

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码。

CM-RESOAT1111
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

WARN
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

建议(新)。

请联系管理员
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

请求耗时,单位为秒。

1
Datastring

返回的数据。

null

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111\n",
    "Level": "WARN",
    "Message": "A system error occurred.",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "请联系管理员",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator. ",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "Cost": "1",
  "Data": "null"
}

错误码

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

  • 本页导读 (0)