CreateRplInspectionTask - 复制链路健康检查 - 云原生数据库 PolarDB

接口说明

数据同步阶段，主动发起对复制链路的诊断任务，检查是否存在延迟、中断、数据不一致等异常问题

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:CreateRplInspectionTask

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SlinkTaskId	string	是	切换任务 id。	etx-szr2rr6i*****
RegionId	string	是	地域 id。>您可以调用 describeregions 接口查看 polardb-x 支持的地域详情，包括地域 id。	cn-hangzhou
SrcUserName	string	否	源实例（源数据库）的连接用户名	bbt_ump
SrcPassword	string	否	源 rds 实例的用户密码。>您可以调用 describedbinstances 接口查看目标地域下所有实例的详情，包括用户密码。	******
DstResId	string	否	目标任务 id。	pxc-zkrc1****l54rc
DstDb	string	否	目标实例中迁移对象所属的 rds 实例 id。>您可以调用 describedbinstances 接口查看目标地域下所有 rds 实例的详情，包括实例 id。	transfer_test3
DstUserName	string	否	目标实例的连接用户名	bbt_item
DstPassword	string	否	目标 rds 实例高权限账号的密码。>长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的任意三种组成。特殊字符为!@#$&%^()_+-=	******

返回参数

名称	类型	描述	示例值
	object
Message	string	任务错误信息。>仅当任务状态为 stop 时返回该参数。	success
RequestId	string	请求 id。	9B2F3840-5C98-475C-B269-2D5C3A31797C
Success	boolean	请求是否成功。	true
Data	object	任务详情。
SlinkTaskId	string	slink 任务 id。	etx-szr2rr6i*****

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Success": true,
  "Data": {
    "SlinkTaskId": "etx-szr2rr6i*****"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。