UpdateProjectConfig - 更新任务配置_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

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

接口说明

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

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	string	是	数据迁移或数据同步项目的 ID。	np_fe****
CommonTransferConfig	object	否	高级配置
FullTransferConfig	object	否	全量传输配置。
WriteWorkerNum	integer	否	写入并发数。	64
ReadWorkerNum	integer	否	读取并发数。	64
ThrottleRps	integer	否	全量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。	null
ThrottleIOPS	integer	否	全量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。	null
IncrTransferConfig	object	否	增量传输配置。
IncrSyncThreadCount	integer	否	增量传输的线程数。	64
ThrottleRps	integer	否	增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。	null
ThrottleIOPS	integer	否	增量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。	null
RecordTypeWhiteList	array	否	有增量同步阶段时，同步的增量数据类型。
RecordTypeWhiteList	string	否	有增量同步阶段时，同步的增量数据类型。	INSERT
SupportDDLTypes	array	否	支持的 DDL 类型。
SupportDDLType	string	否	增量传输阶段支持的 DDL 类型。	CREATE_TABLE
ReverseIncrTransferConfig	object	否	反向增量传输配置。
IncrSyncThreadCount	integer	否	反向增量传输的线程数。	64
ThrottleRps	integer	否	反向增量传输阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。	null
ThrottleIOPS	integer	否	反向增量传输阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。	null
RecordTypeWhiteList	array	否	有增量同步阶段时，同步的增量数据类型。
RecordTypeWhiteList	string	否	有反向增量同步阶段时，同步的增量数据类型。	INSERT
SupportDDLTypes	array	否	反向增量传输阶段支持的 DDL 类型。
SupportDDLType	string	否	反向增量传输阶段支持的 DDL 类型。	CREATE_TABLE

返回参数

名称	类型	描述	示例值
	object	返回结果。
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码。	CM-RESOAT1111
Level	string	包括 FATAL、ERROR、WARNING 和 CRITICAL。	WARN
Message	string	错误描述。	A system error occurred.
ExtraContext	object	用于填充 Message 中的占位符。
	any	用于填充 Message 中的占位符。	null
MessageMcmsKey	string	错误信息的 Key。	null
MessageMcmsContext	object	用于填充 MessageMcmsKey 中的占位符。
	string	用于填充 MessageMcmsKey 中的占位符。	null
Reason	string	错误原因。	null
ReasonMcmsKey	string	错误原因的 Key。	null
ReasonMcmsContext	object	错误原因的上下文。
	string	错误原因的上下文。	null
Proposal	string	建议（新）。	请联系管理员
ProposalMcmsKey	string	建议内容的 Key。	null
ProposalMcmsContext	object	建议内容的上下文。
	string	建议内容的上下文。	null
UpstreamErrorDetail	any	上游错误详情，用于处理 HTTP 请求。	null
Code	string	错误码。	INNER_ERROR
Message	string	错误描述。	A system error occurred.
Advice	string	建议。	Contact the administrator.
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	10
TotalCount	long	总数，分页查询时生效。	100
Cost	string	请求耗时，单位为秒。	1
Data	string	返回的数据。	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"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-17	API 内部配置变更，不影响调用	查看变更详情
2024-06-26	OpenAPI 入参发生变更	查看变更详情