更新时间:2022-08-02 GMT+08:00
分享

查询租户任务列表

功能介绍

查询租户任务列表,可以根据引擎类型,网络类型,任务状态,任务名称,任务ID进行查询。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v3/{project_id}/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型。

缺省值:en-us

取值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

cur_page

Integer

当前页,填0获取全部item。

缺省值:1

per_page

Integer

每页记录数。

  • 默认值:10
  • 最小值:0
  • 最大值:100

db_use_type

String

迁移场景,migration:实时迁移,sync:实时同步,cloudDataGuard:实时灾备。

取值:

  • migration
  • sync
  • cloudDataGuard

engine_type

String

引擎类型。

mysql:MySQL迁移,MySQL同步使用;

mongodb:迁移使用;

cloudDataGuard-mysql:灾备使用;

gaussdbv5:GaussDB(for openGauss)同步使用;

gaussdbv5ha-to-kafka:GaussDB(for openGauss)主备版到Kafka同步使用;

postgresql:PostgreSQL同步使用;

缺省值:mysql

取值:

  • mysql
  • mongodb
  • cloudDataGuard-mysql
  • gaussdbv5
  • gaussdbv5ha-to-kafka
  • postgresql

enterprise_project_id

String

企业项目,不传值的话,设置为null,不能设置为空字符串。当企业项目开关打开时,可以传值。

name

String

Name或ID。

net_type

String

网络类型。取值:

  • vpn
  • vpc
  • eip

service_name

String

服务名称

status

String

状态,CREATING:创建中,CREATE_FAILED: 创建失败,CONFIGURATION: 配置中,

STARTJOBING: 启动中,

WAITING_FOR_START:等待启动中,

START_JOB_FAILED:任务启动失败,

FULL_TRANSFER_STARTED:全量迁移中、灾备场景为初始化,

FULL_TRANSFER_FAILED:全量迁移失败、灾备场景为初始化失败,

FULL_TRANSFER_COMPLETE:全量迁移完成、灾备场景为初始化完成,

INCRE_TRANSFER_STARTED:增量迁移中、灾备场景为灾备中,

INCRE_TRANSFER_FAILED:增量迁移失败、灾备场景为灾备异常,

RELEASE_RESOURCE_STARTED:结束任务中,

RELEASE_RESOURCE_FAILED:结束任务失败,

RELEASE_RESOURCE_COMPLETE:已结束,

CHANGE_JOB_STARTED:任务变更中,

CHANGE_JOB_FAILED:任务变更失败,

CHILD_TRANSFER_STARTING:子任务启动中,

CHILD_TRANSFER_STARTED:子任务迁移中,

CHILD_TRANSFER_COMPLETE:子任务迁移完成,

CHILD_TRANSFER_FAILED:子任务迁移失败,

RELEASE_CHILD_TRANSFER_STARTED:子任务结束中,

RELEASE_CHILD_TRANSFER_COMPLETE:子任务已结束。

取值:

  • CREATING
  • CREATE_FAILED
  • CONFIGURATION
  • STARTJOBING
  • WAITING_FOR_START
  • START_JOB_FAILED
  • FULL_TRANSFER_STARTED
  • FULL_TRANSFER_FAILED
  • FULL_TRANSFER_COMPLETE
  • INCRE_TRANSFER_STARTED
  • INCRE_TRANSFER_FAILED
  • RELEASE_RESOURCE_STARTED
  • RELEASE_RESOURCE_FAILED
  • RELEASE_RESOURCE_COMPLETE
  • CHANGE_JOB_STARTED
  • CHANGE_JOB_FAILED
  • CHILD_TRANSFER_STARTING
  • CHILD_TRANSFER_STARTED
  • CHILD_TRANSFER_COMPLETE
  • CHILD_TRANSFER_FAILED
  • RELEASE_CHILD_TRANSFER_STARTED
  • RELEASE_CHILD_TRANSFER_COMPLETE

tags

Map<String,String>

标签。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_record

Integer

任务总数。

jobs

Array of JobInfo objects

任务信息列表。

表5 JobInfo

参数

参数类型

描述

id

String

任务ID。

name

String

任务名称。

status

String

任务状态。取值:

  • CREATING:创建中。
  • CREATE_FAILED:创建失败。
  • CONFIGURATION:配置中。
  • STARTJOBING:启动中。
  • WAITING_FOR_START:等待启动中。
  • START_JOB_FAILED:任务启动失败。
  • FULL_TRANSFER_STARTED:全量迁移中 灾备场景为初始化。
  • FULL_TRANSFER_FAILED:全量迁移失败 灾备场景为初始化失败。
  • FULL_TRANSFER_COMPLETE:全量迁移完成 灾备场景为初始化完成。
  • INCRE_TRANSFER_STARTED:增量迁移中 灾备场景为灾备中。
  • INCRE_TRANSFER_FAILED:增量迁移失败 灾备场景为灾备异常。
  • RELEASE_RESOURCE_STARTED:结束任务中。
  • RELEASE_RESOURCE_FAILED:结束任务失败。
  • RELEASE_RESOURCE_COMPLETE:已结束。
  • CHANGE_JOB_STARTED:任务变更中。
  • CHANGE_JOB_FAILED:任务变更失败。
  • CHILD_TRANSFER_STARTING:子任务启动中。
  • CHILD_TRANSFER_STARTED:子任务迁移中。
  • CHILD_TRANSFER_COMPLETE:子任务迁移完成。
  • CHILD_TRANSFER_FAILED:子任务迁移失败。
  • RELEASE_CHILD_TRANSFER_STARTED:子任务结束中。
  • RELEASE_CHILD_TRANSFER_COMPLETE:子任务已结束。

description

String

任务描述。

create_time

String

任务创建时间。

engine_type

String

引擎类型。取值:

  • cloudDataGuard-cassandra
  • cloudDataGuard-ddm
  • cloudDataGuard-taurus-to-mysql
  • cloudDataGuard-mysql
  • cloudDataGuard-mysql-to-taurus

net_type

String

网络类型。取值:

  • vpn
  • vpc
  • eip

billing_tag

Boolean

计费字段。

job_direction

String

迁移方向。取值:

  • up
  • down

db_use_type

String

迁移场景。取值:

  • migration:实时迁移。
  • sync:实时同步。
  • cloudDataGuard:实时灾备。

task_type

String

迁移模式。取值:

  • FULL_TRANS :全量。
  • FULL_INCR_TRANS:全量+增量。
  • INCR_TRANS:增量。

children

Array of ChildrenJobInfo objects

子任务信息体。

node_newFramework

Boolean

是否新框架。

表6 ChildrenJobInfo

参数

参数类型

描述

billing_tag

Boolean

计费字段。

create_time

String

任务创建时间。

db_use_type

String

复制场景。取值:

  • migration:实时迁移。
  • sync:实时同步。
  • cloudDataGuard:实时灾备。

description

String

任务描述。

engine_type

String

引擎类型。取值:

  • cloudDataGuard-cassandra
  • cloudDataGuard-ddm
  • cloudDataGuard-taurus-to-mysql
  • cloudDataGuard-mysql
  • cloudDataGuard-mysql-to-taurus

error_msg

String

任务失败原因。

id

String

任务ID。

job_direction

String

迁移方向。取值:

  • up:入云,灾备场景时对应本云为备
  • down:出云,灾备场景时对应本云为主。
  • non-dbs:自建。

name

String

任务名称。

net_type

String

网络类型。取值:

  • vpc
  • vpn
  • eip

node_newFramework

Boolean

新框架。

status

String

任务状态。

task_type

String

迁移模式。取值:

  • FULL_TRANS :全量。
  • FULL_INCR_TRANS:全量+增量。
  • INCR_TRANS:增量。

请求示例

  • 查询实时同步任务列表示例:
    https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs
    {
      "cur_page" : 1,
      "db_use_type" : "sync",
      "engine_type" : "",
      "name" : "",
      "net_type" : "",
      "per_page" : 5,
      "status" : ""
    }
  • 查询实时迁移任务列表示例:
    https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs
    {
      "cur_page" : 1,
      "db_use_type" : "migration",
      "engine_type" : "",
      "name" : "",
      "net_type" : "",
      "per_page" : 5,
      "status" : ""
    }

响应示例

状态码: 200

OK

  • 示例 1:
    {
      "jobs" : [ {
        "id" : "24834eb6-be30-464e-a299-f7aa730jb101",
        "name" : "DRS-3999-lws",
        "status" : "INCRE_TRANSFER_FAILED",
        "description" : "",
        "create_time" : "2020-12-21 10:57:49",
        "error_msg" : "service LOGMANAGER failed, cause by: Unable to connect to DBMS: url=jdbc:mysql://172.22.74.56:3306?useUnicode=true&allowLoadLocalInfile=false&characterEncoding=UTF-8&connectTimeout=5000&useSSL=false&allowPublicKeyRetrieval=true&verifyServerCertificate=false&serverTimezone=UTC user=root",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "140b5236-88ad-43c8-811c-1268453jb101",
        "name" : "DRS-0042-linxiaolu",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-19 16:23:24",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "7f8e6f74-72d2-4ddd-bb8f-6c41397jb101",
        "name" : "DRS-0796",
        "status" : "RELEASE_RESOURCE_COMPLETE",
        "description" : "",
        "create_time" : "2020-12-18 10:48:11",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "non-dbs",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "14d88eeb-ee7e-4d30-a46e-a5ec8eajb101",
        "name" : "masj-mysql_migration_down-1",
        "status" : "INCRE_TRANSFER_STARTED",
        "description" : "[using] api test 2\n1. 本接口是用来配置源库/目标库信息的,选表前必须执行\n2. 配置中的任务修改描述信息成功,202 success\n3. 增量迁移中的任务修改描述信息失败,202 failed DRS.M01504\nAnother operation is being performed on the migration task or the migration task is abnormal. Try again later./",
        "create_time" : "2020-12-15 15:43:02",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : true,
        "job_direction" : "down",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "d54691d2-f105-434d-a75d-809b017jb101",
        "name" : "masj-2-mysql_migration_down",
        "status" : "CONFIGURATION",
        "description" : "[using] api test 2\n1. 本接口是用来配置源库/目标库信息的,选表前必须执行\n2. 配置中的任务修改描述信息成功,202 success\n3. 增量迁移中的任务修改描述信息失败,202 failed DRS.M01504\nAnother operation is being performed on the migration task or the migration task is abnormal. Try again later./",
        "create_time" : "2020-12-14 21:39:07",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "down",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      } ],
      "total_record" : 7
    }
  • 示例 2:
    {
      "jobs" : [ {
        "id" : "7994aac9-0a15-4fdb-bcc5-667f088jb20b",
        "name" : "DRS-8200",
        "status" : "CREATE_FAILED",
        "description" : "",
        "create_time" : "2020-12-21 18:02:36",
        "error_msg" : "system error!",
        "engine_type" : "oracle-to-mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "f463331d-e079-4689-bbef-4553202jb20b",
        "name" : "DRS-1285",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-21 17:19:38",
        "engine_type" : "oracle-to-mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "7f13c511-c35b-4f82-92ae-83bcbf0jb201",
        "name" : "DRS-9383",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-21 17:18:44",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "7686e879-46a4-4d6b-bda9-5540424jb201",
        "name" : "DRS-9272",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-21 16:53:36",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      }, {
        "id" : "5b2c2ec8-430e-4de0-937b-9d9547ajb201",
        "name" : "DRS-2899",
        "status" : "RELEASE_RESOURCE_COMPLETE",
        "description" : "",
        "create_time" : "2020-12-21 16:24:24",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
      } ],
      "total_record" : 18
    }

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

分享:

    相关文档

    相关产品

close