CreateAPSJob - 创建APS任务

更新时间:

创建APS任务。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:CreateAPSJobnone
*DBClusterLakeVersion
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

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

地域 ID。

说明 您可以调用 DescribeRegions 接口查看地域 ID。
cn-shanghai
SourceEndpointInstanceIDstring

源数据库实例 ID。

pc-xxxxx
SourceEndpointRegionstring

源数据库地域。

cn-beijing
SourceEndpointUserNamestring

源端用户名。

xxxx
SourceEndpointPasswordstring

源端密码。

******
DestinationEndpointInstanceIDstring

目标端数据库实例 ID。

amv-xxxxx
DestinationEndpointPasswordstring

目标端实例密码。

******
DestinationEndpointUserNamestring

目标端实例用户名。

******
DbListstring

同步对象列表。

{"EntireInstance":true}
ApsJobNamestring

任务名称。

aps-xxxxx
PartitionListstring

分区列表。

{}
TargetTableModestring

目标表模式。

1

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 请求返回的响应状态码,200 表示请求发送成功。

200
ApsJobIdstring

任务 ID。

aps-bj1xxxxxx
RequestIdstring

请求 ID。

D1B8ED33-5E9B-512D-B188-1579ED6xxx
Successboolean

调用是否成功,取值说明:

  • true:成功。
  • false:失败。
True
Codestring

接口状态或 POP 错误码。

InvalidInput
Messagestring

调用结果的附加信息。取值说明:

  • 请求正常,返回 OK
  • 请求异常,返回具体异常错误码。
OK

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ApsJobId": "aps-bj1xxxxxx",
  "RequestId": "D1B8ED33-5E9B-512D-B188-1579ED6xxx",
  "Success": true,
  "Code": "InvalidInput",
  "Message": "OK"
}

错误码

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