文档

是否屏蔽预检查告警项目

更新时间:

调用SkipPreCheck屏蔽或取消屏蔽预检查告警项目。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String SkipPreCheck

系统规定参数。取值:SkipPreCheck

JobId String b4my3zg929a****

预检查任务ID,可以调用DescribePreCheckStatus查询。

Skip Boolean true

是否屏蔽该预检查项目,取值:

  • true:屏蔽。
  • false:取消屏蔽。
SkipPreCheckItems String CHECK_SAME_OBJ

需屏蔽或取消屏蔽的预检查项目简称,取值:

  • CHECK_SAME_OBJ:同名对象存在性检查。
  • CHECK_SAME_USER:不同名账号存在性检查。
  • CHECK_SRC:源库版本检查。
  • CHECK_TOPOLOGY:拓扑版本检查。目前DTS支持的拓扑版本,请参见拓扑介绍
  • CHECK_SERVER_ID:源库server_id检查。
  • CHECK_DEST_TABLE_EMPTY:目的库对象存在性检查。
说明 多个项目名称用英文逗号(,)分隔。
SkipPreCheckNames String CHECK_SAME_OBJ_DETAIL

需屏蔽或取消屏蔽的预检查项目名称,对应参数SkipPreCheckItems,取值:

  • CHECK_SAME_OBJ_DETAIL:同名对象存在性检查。
  • CHECK_SAME_USER_DETAIL:不同名账号存在性检查。
  • CHECK_SRC_DETAIL:源库版本检查。
  • CHECK_TOPOLOGY_DETAIL:拓扑版本检查。目前DTS支持的拓扑版本,请参见拓扑介绍
  • CHECK_SERVER_ID_DETAIL:源库server_id检查。
  • CHECK_DEST_TABLE_EMPTY_DETAIL:检查目标库表是否为空。
说明 多个项目名称用英文逗号(,)分隔。
DtsJobId String c7412z57g8k****

迁移、同步或订阅任务ID。

RegionId String cn-hangzhou

DTS实例所属的地域,详情请参见支持的地域列表

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

状态码。

RequestId String 8C498360-7892-433C-847A-BA71A850****

请求ID。

ErrCode String InternalError

调用错误时返回的错误码。

Success Boolean true

请求是否成功。

ErrMessage String The Value of Input Parameter %s is not valid.

调用错误时返回的错误信息。

SkipNames String CHECK_SAME_OBJ_DETAIL

需屏蔽或取消屏蔽的预检查项目名称。

Code String 200

错误码,本参数即将下线。

ScheduleJobId String b4my3zg929a****

预检查任务ID。

DynamicMessage String JobId

动态错误信息,用于替换返回参数ErrMessage错误信息中的%s。

说明 如果ErrMessage返回The Value of Input Parameter %s is not valid,且DynamicMessage返回JobId,则代表所传入的请求参数JobId不合法。
MigrationJobId String b4my3zg929a****

预检查任务ID。

SkipItems String CHECK_SAME_OBJ

需屏蔽或取消屏蔽的预检查项目简称。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=SkipPreCheck
&JobId= b4my3zg929a****
&SkipPreCheckItems=["CHECK_SAME_OBJ","CHECK_SRC"]
&SkipPreCheckNames=["CHECK_SAME_OBJ_DETAIL","CHECK_SRC_DETAIL"]
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SkipPreCheckResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>8C498360-7892-433C-847A-BA71A850****</RequestId>
    <Success>true</Success>
    <SkipNames>CHECK_SAME_OBJ_DETAIL</SkipNames>
    <ScheduleJobId>b4my3zg929a****</ScheduleJobId>
    <MigrationJobId>b4my3zg929a****</MigrationJobId>
    <SkipItems>CHECK_SAME_OBJ</SkipItems>
</SkipPreCheckResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "8C498360-7892-433C-847A-BA71A850****",
  "Success" : true,
  "SkipNames" : "CHECK_SAME_OBJ_DETAIL",
  "ScheduleJobId" : "b4my3zg929a****",
  "MigrationJobId" : "b4my3zg929a****",
  "SkipItems" : "CHECK_SAME_OBJ"
}

错误码

HttpCode

错误码

错误信息

描述

400 Throttling.User Request was denied due to user flow control. 由于请求频次达到阈值,请求被拒绝,请稍后重试。
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由于服务端响应超时或者不可用导致请求失败,请重试,重试后仍失败请联系技术支持。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 签名已经过期,请更新签名

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