网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

批量查询任务详情

更新时间:2025-01-23 GMT+08:00
分享

功能介绍

根据任务ID批量查询任务详情。

调试

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

接口约束

为保证接口调用性能,建议批量调用数量不超过10个。

URI

POST /v3/{project_id}/jobs/batch-detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目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参数

参数

是否必选

参数类型

描述

jobs

Array of strings

批量查询任务详情。

page_req

Object

分页信息。

详情请参见表4

表4 page_req字段数据结构说明

参数

是否必选

参数类型

描述

cur_page

Integer

当前页, 不能超过传入jobID数量除每页任务数量的最大页。

  • 最小值:1
  • 缺省值:1

per_page

Integer

每页item数量,填0获取全部item。

  • 最小值:0
  • 最大值:100
  • 缺省值:5

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

count

Integer

任务数量。

results

Array of objects

任务详细信息。

详情请参见表6

表6 results字段数据结构说明

参数

参数类型

描述

id

String

任务ID。

parent_id

String

父任务ID。

name

String

任务名称。

status

String

任务状态。

  • CREATING:创建中。
  • CREATE_FAILED:创建失败。
  • CONFIGURATION:配置中。
  • STARTJOBING:启动中。
  • WAITING_FOR_START:等待启动中。
  • START_JOB_FAILED:启动失败。
  • PAUSING:已暂停。
  • FULL_TRANSFER_STARTED:全量开始,灾备场景下为初始化。
  • FULL_TRANSFER_FAILED:全量失败,灾备场景下为初始化失败。
  • FULL_TRANSFER_COMPLETE:全量完成,灾备场景下为初始化完成。
  • INCRE_TRANSFER_STARTED:增量开始,灾备场景下为灾备中。
  • INCRE_TRANSFER_FAILED:增量失败,灾备场景下为灾备异常。
  • RELEASE_RESOURCE_STARTED:结束任务中。
  • RELEASE_RESOURCE_FAILED:结束任务失败。
  • RELEASE_RESOURCE_COMPLETE:已结束。
  • REBUILD_NODE_STARTED:故障恢复中。
  • REBUILD_NODE_FAILED:故障恢复失败。
  • CHANGE_JOB_STARTED:任务变更中。
  • CHANGE_JOB_FAILED:任务变更失败。
  • DELETED:已删除。
  • CHILD_TRANSFER_STARTING:再编辑子任务启动中。
  • CHILD_TRANSFER_STARTED:再编辑子任务迁移中。
  • CHILD_TRANSFER_COMPLETE:再编辑子任务迁移完成。
  • CHILD_TRANSFER_FAILED:再编辑子任务迁移失败。
  • RELEASE_CHILD_TRANSFER_STARTED:再编辑子任务结束中。
  • RELEASE_CHILD_TRANSFER_COMPLETE:再编辑子任务已结束。
  • NODE_UPGRADE_START:升级开始。
  • NODE_UPGRADE_COMPLETE:升级完成。
  • NODE_UPGRADE_FAILED:升级失败。

枚举值:

  • CREATING
  • CREATE_FAILED
  • CONFIGURATION
  • STARTJOBING
  • WAITING_FOR_START
  • START_JOB_FAILED
  • PAUSING
  • FULL_TRANSFER_STARTED
  • FULL_TRANSFER_FAILED
  • FULL_TRANSFER_COMPLETE
  • INCRE_TRANSFER_STARTED
  • INCRE_TRANSFER_FAILED
  • RELEASE_RESOURCE_STARTED
  • RELEASE_RESOURCE_FAILED
  • RELEASE_RESOURCE_COMPLETE
  • REBUILD_NODE_STARTED
  • REBUILD_NODE_FAILED
  • CHANGE_JOB_STARTED
  • CHANGE_JOB_FAILED
  • DELETED
  • CHILD_TRANSFER_STARTING
  • CHILD_TRANSFER_STARTED
  • CHILD_TRANSFER_COMPLETE
  • CHILD_TRANSFER_FAILED
  • RELEASE_CHILD_TRANSFER_STARTED
  • RELEASE_CHILD_TRANSFER_COMPLETE
  • NODE_UPGRADE_START
  • NODE_UPGRADE_COMPLETE
  • NODE_UPGRADE_FAILED

description

String

描述信息。

create_time

String

创建时间,时间戳格式。

task_type

String

任务模式。取值:

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

source_endpoint

Object

源库信息体。

详情请参见表7

dmq_endpoint

Object

DMQ信息体。

详情请参见表7

source_sharding

Array of objects

物理源库信息。

详情请参见表7

target_endpoint

Object

目标库信息体。

详情请参见表7

net_type

String

网络类型。取值:

  • vpn
  • vpc
  • eip

failed_reason

String

失败原因。

inst_info

Object

迁移实例信息。

详情请参见表9

actual_start_time

String

实际启动时间,时间戳格式。

full_transfer_complete_time

String

全量完成时间,时间戳格式。

update_time

String

更新时间,时间戳格式。

job_direction

String

任务方向。取值:

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

db_use_type

String

迁移场景。取值:

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

need_restart

Boolean

是否需要重启。

is_target_readonly

Boolean

指定目标实例是否限制为只读。

conflict_policy

String

冲突忽略策略。取值:

  • stop:冲突失败。
  • overwrite:冲突覆盖。
  • ignore:冲突忽略。

filter_ddl_policy

String

过滤DDL策略。取值:

  • drop_database:过滤。
  • drop_databasefilter_all:过滤所有DLL。
  • "":不过滤。

speed_limit

Array of objects

迁移速度限制。

详情请参见表10

schema_type

String

迁移方案。取值:

  • Replication:主从复制。
  • Tungsten:日志解析。
  • PGBaseBackup:-PG备份。

node_num

String

节点个数。

object_switch

Boolean

对象选择开关

master_job_id

String

主任务ID。

full_mode

String

全量快照模式。

struct_trans

Boolean

是否迁移结构。

index_trans

Boolean

否迁移索引。

replace_definer

Boolean

是否使用目标库的用户替换掉definer。

migrate_user

Boolean

是否迁移用户。

sync_database

Boolean

是否库级同步。

error_code

String

错误码。

error_message

String

错误信息。

target_root_db

Object

目标实例根节点库信息。

详情请参见表11

az_code

String

node所在AZ。

vpc_id

String

node所在VPC。

subnet_id

String

node所在子网。

security_group_id

String

node所在安全组。

multi_write

Boolean

是否多主灾备任务,双主灾备时有值为true。

support_ip_v6

Boolean

是否支持IPV6。

inherit_id

String

继承的任务ID。

gtid

String

断点的GTID集合。

alarm_notify

Object

异常通知设置信息。

详情请参见表12

is_multi_az

Boolean

是否是主备任务。

az_name

String

node所在节点AZ名称。

master_az

String

主备任务主AZ。

slave_az

String

主备任务备AZ。

node_role

String

任务主备角色。

incre_start_position

String

增量任务启动位点。

period_order

Object

包年/包月信息。

详情请参见表14

说明:

包年/包月任务才会返回该参数。

object_infos

Array of objects

已同步对象信息。

详情请参见表15

original_job_direction

String

任务创建时的direction。取值:

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

data_transformation

Object

数据过滤配置信息。

详情请参见表16

tags

Array of objects

任务标签。

详情请参见表21

public_ip_list

Array of objects

指定公网IP的信息。

详情请参见表22

bind_public_ip_state

String

是否成功绑定公网IP。

children

Array of objects

多任务时,存在子任务绑定失败时,返回子任务的信息。

详情请参见表23

is_open_fast_clean

Boolean

是否开启云数据库RDS for MySQL或MariaDB的Binlog快速清理。

表7 source_endpoint、dmq_endpoint、source_sharding和target_endpoint字段数据结构说明

参数

参数类型

描述

db_type

String

数据库类型。取值:

  • mysql:MySQL
  • mongodb:MongoDB
  • gaussdbv5:GaussDB分布式版
  • taurusTaurusDB
  • gaussdbv5ha:GaussDB集中式版
  • kafka:Kafka
  • postgresql:PostgreSQL
  • oracle:Oracle

az_code

String

数据库所在可用区azCode。

region

String

数据库实例所在region,数据库为云上实例时,比如RDS实例时必填。

inst_id

String

数据库实例id,数据库为云上实例时,比如RDS实例时必填。

vpc_id

String

数据库所在的虚拟私有云ID。

subnet_id

String

数据库所在的子网ID。

security_group_id

String

数据库所在的安全组ID。

project_id

String

数据库实例所在的Project ID。

db_name

String

服务名serviceName,源库为Oracle场景时必填。约束:不能超过128位,不能包含!<>&'"\特殊字符。

db_password

String

数据库密码。

db_port

Integer

数据库端口。约束:输入范围为1-65535之间的整数。

db_user

String

数据库用户。

inst_name

String

RDS实例名称。

ip

String

数据库IP。

mongo_ha_mode

String

mongo ha模式。

safe_mode

Integer

MRS集群运行模式,取值:

  • 0:普通集群
  • 1:安全集群

ssl_cert_password

String

SSL证书密码,证书文件后缀为.p12。

ssl_cert_check_sum

String

SSL证书内容checksum值,后端校验,源库安全连接必选。

ssl_cert_key

String

SSL证书内容,用base64加密。

ssl_cert_name

String

SSL证书名字。

ssl_link

Boolean

是否SSL安全连接。

topic

String

kafka topic名称。

cluster_mode

String

MongDB集群4.0及以上版本,当集群实例无法获取到分片节点的IP时,source_endpoint中需要填写,值为:Sharding4.0+。

缺省值:Sharding4.0+

枚举值:Sharding4.0+

kafka_security_config

Object

Kafka安全认证相关,非安全认证不需要此参数。

详情请参见表8

表8 kafka_security_config字段数据结构说明

参数

参数类型

描述

type

String

安全协议,安全认证时必填,对应Kafka字段:security.protocol。

  • PLAINTEXT:无安全认证方式,仅需输入IP和端口进行连接。
  • SASL_PLAINTEXT:使用SASL机制连接Kafka,需要设置SASL相关配置。
  • SSL:使用SSL加密方式连接Kafka,需要设置SSL相关配置。
  • SASL_SSL:使用SASL及SSL加密认证方式,需要设置SSL及SASL相关参数配置信息。

枚举值:

  • PLAINTEXT
  • SASL_PLAINTEXT
  • SASL_SSL
  • SSL

trust_store_key_name

String

证书名称,安全协议为SSL、SASL_SSL时必填。

trust_store_key

String

安全证书base64转码后的值,安全协议为SSL、SASL_SSL时必填。

trust_store_password

String

证书密码,证书设置了密码时必填。

endpoint_algorithm

String

主机名端点识别算法,指定通过服务端证书验证服务端主机名的端点识别算法,不填表示禁用主机名验证。对应Kafka字段:ssl.endpoint.identification.algorithm

sasl_mechanism

String

SASL机制,用于客户端连接的SASL机制,对应Kafka字段:sasl.mechanism,支持以下四项,取值:

  • GSSAPI
  • PLAIN
  • SCRAM-SHA-256
  • SCRAM-SHA-512

delegation_tokens

Boolean

是否为委托令牌鉴权,安全协议为SASL_SSL和SASL_PLAINTEXT时,SASL机制选择“SCRAM-SHA-256”或者“SCRAM-SHA-512”时生效。

enable_key_store

Boolean

是否开启SSL双向认证。

key_store_key

String

Keystore证书,开启SSL双向认证时需要。

key_store_key_name

String

Keystore证书名称,开启SSL双向认证时需要。

key_store_password

String

Keystore证书密码,证书设置了密码时需要。对应Kafka字段:ssl.keystore.password

set_private_key_password

Boolean

是否设置Keystore私钥密码,默认为false。

key_password

String

Keystore私钥密码,开启SSL双向认证时,set_private_key_password为true时必填。对应Kafka字段:ssl.key.password。

表9 inst_info字段数据结构说明

参数

参数类型

描述

engine_type

String

DRS任务引擎类型。取值:

  • mysql:MySQL到MySQL迁移,MySQL到MySQL同步
  • mongodb:MongoDB到DDS迁移
  • cloudDataGuard-mysql:MySQL到MySQL灾备
  • gaussdbv5GaussDB同步
  • mysql-to-kafka:MySQL到Kafka同步
  • taurus-to-kafkaTaurusDB到Kafka同步
  • gaussdbv5ha-to-kafka:GaussDB集中式版到Kafka同步
  • postgresql:PostgreSQL到PostgreSQL同步
  • oracle-to-gaussdbv5:Oracle-GaussDB 分布式版
  • oracle-to-gaussdbv5ha:Oracle-GaussDB 集中式版
  • gaussdbv5-to-oracle:GaussDB 分布式版-Oracle
  • gaussdbv5ha-to-oracle:GaussDB 集中式版-Oracle
  • gaussdbv5-to-kafka:GaussDB 分布式版-Kafka

详细取值可参考引擎类型说明

inst_type

String

实例类型。取值:high

ip

String

迁移实例所在的私有IP。

public_ip

String

迁移实例所在的公网IP。

start_time

String

迁移实例任务定时启动时间。

status

String

迁移实例的状态。取值:

  • active
  • deleted

volume_size

Integer

迁移实例的磁盘大小。

表10 speed_limit字段数据结构说明

参数

参数类型

描述

begin

String

开始限速时间。

end

String

结束时间。

is_utc

Boolean

是否为UTC时间。

speed

String

限速。

表11 target_root_db字段数据结构说明

参数

参数类型

描述

db_name

String

库名。

db_encoding

String

编码格式。

表12 alarm_notify字段数据结构说明

参数

参数类型

描述

subscriptions

Array of objects

SMN信息。

详情请参见表13

topic_name

String

主题名称。

delay_time

Long

订阅延迟时间。

rto_delay

Long

RTO延迟时间。

rpo_delay

Long

RPO延迟时间。

alarm_to_user

Boolean

异常告警是否通知用户。

表13 subscriptions字段数据结构说明

参数

参数类型

描述

endpoints

Array of strings

短信或者邮件列表

protocol

String

收件方式,sms:短信,email:邮件。

枚举值:

  • sms
  • email
表14 period_order字段数据结构说明

参数

参数类型

描述

status

String

订单状态。

order_id

String

订单ID。

charging_mode

Integer

计费模式。

取值范围:

  • 0:包年包月。
  • 1:按需计费。

period_type

Integer

订购周期类型。

取值范围:

  • 2:周期类型为月。
  • 3:周期类型为年。

period_num

Integer

订购周期数。

取值范围:

  • period_type=2(周期类型为月)时,取值为[1,9]。
  • period_type=3(周期类型为年)时,取值为[1,3]。

is_auto_renew

Integer

是否自动续订。

取值范围:

  • 0:不自动续订。
  • 1:自动续订。

eff_time

String

资源生效时间(即资源创建时间);UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ(2016-06-28T00:00:00Z)。

exp_time

String

资源失效时间(包周期资源:即资源到期时间,如果已经进行了续费,即为续费后的到期时间),UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ(2016-03-28T00:00:00Z)。

表15 object_infos字段数据结构说明

参数

参数类型

描述

id

String

type为database时,为库名;type为table或者view时,字段值参考示例。

parent_id

String

type为table或view时为库名。

type

String

类型。取值:

  • database
  • table
  • schema
  • view

name

String

数据库对象名称,库名、表名、视图名。

alias_name

String

别名,映射的新名称。

表16 data_transformation字段数据结构说明

参数

参数类型

描述

total_count

Long

数据过滤条件总数。

filter_conditions

Array of objects

数据过滤配置信息。

约束:最大支持返回10000条数据过滤条件。

详情请参见表17

表17 filter_conditions字段数据结构说明

参数

参数类型

描述

transformation_info

Object

普通行过滤数据加工配置。

详情请参见表19

config_transformation

Object

行过滤高级配置信息。

详情请参见表20

data_transformation_object_infos

Array of objects

数据过滤对象信息。

详情请参见表18

表18 data_transformation_object_infos字段数据结构说明

参数

是否必选

参数类型

描述

id

String

数据库对象、数据库表名称和过滤类型名称,例如格式为db1-*-*-tb1-*-*---conditionFilter--。

data_transformation_type

String

  • 生成加工规则值为contentConditionalFilter。
  • 生成配置规则值为configConditionalFilter。

    取值:

    • contentConditionalFilter
    • configConditionalFilter

schema_name

String

数据加工选择的schema名称。

table_name

String

数据加工选择的表名称。

表19 transformation_info字段数据结构说明

参数

是否必选

参数类型

描述

transformation_type

String

  • 生成加工规则值为contentConditionalFilter。
  • 生成配置规则值为configConditionalFilter。

    取值:

    • contentConditionalFilter
    • configConditionalFilter

value

String

过滤条件,生成加工规则值为sql条件语句,生成配置规则值为config。长度限制256。

表20 config_transformation字段数据结构说明

参数

是否必选

参数类型

描述

db_table_name

String

库名.表名,例如格式为lxl_test1.test_1,其中lxl_test1为库名,test_1为表名。

db_name

String

库名。长度限制256。

table_name

String

表名。长度限制256。

col_names

String

列名。长度限制256。

prim_key_or_index

String

主键或唯一索引。长度限制256。

indexs

String

优化查询所需的索引。长度限制256。

values

String

过滤条件。长度限制256。

表21 tags字段数据结构说明

参数

是否必选

参数类型

描述

key

String

标签key。

value

String

标签value。

表22 public_ip_list字段数据结构说明

参数

参数类型

描述

id

String

指定公网IP的ID。

public_ip

String

指定公网IP。

type

String

指定公网IP绑定任务的类型:

  • 主备任务:主是master,备是slave。
  • 其他固定为master。

枚举值:

  • master
  • slave
表23 children字段数据结构说明

参数

参数类型

描述

id

String

子任务ID。

name

String

子任务名称。

请求示例

查询任务详情请求示例:

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-detail

{
  "jobs" : [ "24834eb6-be30-464e-a299-f7aa730jb101", "140b5236-88ad-43c8-811c-1268453jb101" ],
  "page_req" : {
    "cur_page" : 1,
    "per_page" : 10
  }
}

响应示例

状态码: 200

OK

{
  "count" : 2,
  "results" : [ {
    "id" : "24834eb6-be30-464e-a299-f7aa730jb101",
    "name" : "DRS-3999-lws",
    "status" : "STARTJOBING",
    "description" : "",
    "create_time" : "1608519469412",
    "task_type" : "FULL_INCR_TRANS",
    "source_endpoint" : {
      "ip" : "172.22.74.56",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "db_user" : "root"
    },
    "target_endpoint" : {
      "ip" : "172.21.176.219",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "inst_id" : "3ef57dbcc8db478a9e346d26ef2575bfin01",
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "inst_name" : "rds-lws-target",
      "db_user" : "root",
      "vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4",
      "subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c"
    },
    "inst_info" : {
      "ip" : "172.16.213.101",
      "inst_type" : "high",
      "engine_type" : "mysql",
      "volume_size" : 100,
      "public_ip" : "******",
      "start_time" : "0"
    },
    "actual_start_time" : "1608520069393",
    "update_time" : "1608520068979",
    "job_direction" : "up",
    "db_use_type" : "migration",
    "need_restart" : false,
    "is_target_readonly" : true,
    "speed_limit" : [ ],
    "schema_type" : "Tungsten",
    "object_switch" : true,
    "replace_definer" : true,
    "migrate_user" : false,
    "az_code" : "az2xahz",
    "vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4",
    "subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c",
    "security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd",
    "support_ip_v6" : false,
    "original_job_direction": "up",
    "is_open_fast_clean": true,
    "object_infos":[{
      "id":"test",
      "type":"database",
      "name":"test",
      "select":"true"
      },{
      "id":"test-*-*-table01",
      "type":"table",
      "name":"table01",
      "select":"true",
      "parent_id":"test"
      }]
  }, {
    "id" : "140b5236-88ad-43c8-811c-1268453jb101",
    "name" : "DRS-0042-linxiaolu",
    "status" : "CONFIGURATION",
    "description" : "",
    "create_time" : "1608366204171",
    "task_type" : "FULL_INCR_TRANS",
    "source_endpoint" : {
      "ip" : "192.168.0.27",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "db_user" : "root"
    },
    "target_endpoint" : {
      "ip" : "192.168.0.131",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01",
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "inst_name" : "rds-1417-lxl",
      "db_user" : "root",
      "vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1",
      "subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417"
    },
    "inst_info" : {
      "ip" : "192.168.0.229",
      "status" : "ACTIVE",
      "inst_type" : "high",
      "engine_type" : "mysql",
      "volume_size" : 100,
      "public_ip" : "10.154.219.72",
      "start_time" : "0"
    },
    "actual_start_time" : "1608369232412",
    "full_transfer_complete_time" : "1608369510202",
    "update_time" : "1608517066434",
    "job_direction" : "up",
    "db_use_type" : "migration",
    "need_restart" : false,
    "is_target_readonly" : true,
    "speed_limit" : [ ],
    "schema_type" : "Tungsten",
    "object_switch" : false,
    "replace_definer" : true,
    "migrate_user" : false,
    "tags": [{
       "key1" : "value1",
       "key2" : "value2"
     }],
    "az_code" : "az2xahz",
    "vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1",
    "subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417",
    "security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd",
    "support_ip_v6" : false,
    "original_job_direction": "up",
    "object_infos":[{
      "id":"test2",
      "type":"database",
      "name":"test2",
      "select":"true"
      },{
      "id":"test2-*-*-table02",
      "type":"table",
      "name":"table02",
      "select":"true",
      "parent_id":"test2"
      }]
  } ],
    "data_transformation": {
      "total_count": 2,
        "filter_conditions": [
          {
            "data_transformation_object_infos": [
              {
                "id": "test02-*-*-table02-*-*---conditionFilter--",
                  "db_name": "test02",
                  "table_name": "table02",
                  "data_transformation_type": "contentConditionalFilter"
               }
             ],
             "transformation_info": {
               "value": "id1<1",
                 "transformation_type": "contentConditionalFilter"
             }
           },
           {
             "data_transformation_object_infos": [
               {
                 "id": "test02-*-*-table01-*-*---configConditionFilter--",
                 "db_name": "test02",
                 "table_name": "test01",
                 "data_transformation_type": "configConditionalFilter"
                }
              ],
              "transformation_info": {
                "value": "config",
                "transformation_type": "configConditionalFilter"
              },
              "config_transformation": {
                "indexs": "id",
                "values": "id <= 6",
                "db_table_name": "test02.table01",
                "db_name": "test02",
                "table_name": "table01",
                "col_names": "id",
                "prim_key_or_index": "id"
               }
            }
         ]
     }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容