DescribeApsJobs - 查询APS任务列表

更新时间:

查询APS任务列表。

调试

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

授权信息

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

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

请求参数

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

页数。

1
PageSizeinteger

每页大小。

30
RegionIdstring

地域 ID。

cn-beijing
CreateTimeStartstring

起始创建时间。

2022-03-23T01:10Z
CreateTimeEndstring

截止创建时间。

2022-04-23T01:10Z
ApsJobNamestring

任务名称。

aps-xxxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

******-7F9D-5DBD-993E-******
PageNumberstring

页码。

1
PageSizestring

每页记录数。

30
TotalCountstring

总记录数。

0
APSJobsarray<object>

任务列表。

-
oneStationVOsobject
Statusstring

任务状态。

-
ApsJobNamestring

任务名称。

data-sync-******
DestinationInstanceIDstring

目标端实例 ID。

amv-*******
SourceInstanceIDstring

源端实例 ID。

pc-******
Delaylong

同步延迟时间。

0
CreateTimestring

创建时间。

2022-06-28 15:00:04
Projressstring

进展。

30 :进度 30%
ApsJobIdstring

任务 ID。

aps-******
SubStatusstring

子任务状态。

-
ErrMessagestring

错误信息。

OK
Successboolean

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

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

后端错误码。

ok
Messagestring

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

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

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

ok

示例

正常返回示例

JSON格式

{
  "RequestId": "******-7F9D-5DBD-993E-******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 0,
  "APSJobs": [
    {
      "Status": "-",
      "ApsJobName": "data-sync-******",
      "DestinationInstanceID": "amv-*******",
      "SourceInstanceID": "pc-******",
      "Delay": 0,
      "CreateTime": "2022-06-28 15:00:04",
      "Projress": "30 :进度 30%",
      "ApsJobId": "aps-******",
      "SubStatus": "-",
      "ErrMessage": "OK"
    }
  ],
  "Success": true,
  "Code": "ok",
  "Message": "OK",
  "HttpStatusCode": 0
}

错误码

HTTP status code错误码错误信息
400InvalidInputThe specified parameter is invalid.

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