更新时间:2024-07-11 GMT+08:00

批量操作指定ID任务

功能介绍

批量操作租户指定ID任务。

接口约束

URI

POST /v5/{project_id}/jobs/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

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

参数

是否必选

参数类型

描述

jobs

Array of objects

批量操作任务请求体。

详情请参见表4

表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

job_id

String

任务ID(对比任务相关操作,多任务场景传父任务详情返回的master_job_id),批量操作时必填。

action_name

String

操作任务动作名称。

取值:

  • network:测试连接源库/目标库。
  • precheck:执行预检查。
  • start:启动任务。
  • stop:暂停任务。
  • restart:重试任务。
  • reset:重置任务,需要先调用预检查接口并且预检查通过率为100%。
  • skip_precheck:跳过预检查。
  • create_compare:创建对比任务。
  • cancel_compare:取消对比任务。
  • column_limit:字段过滤。
  • reload_parameters:重新加载任务参数。
  • bind_eip:绑定公网IP。
  • unbind_eip:解绑公网IP。
  • set_readonly:灾备任务目标库设置只读。

枚举值:

  • network
  • precheck
  • start
  • stop
  • restart
  • reset
  • skip_precheck
  • create_compare
  • cancel_compare
  • column_limit
  • reload_parameters
  • bind_eip
  • unbind_eip
  • set_readonly

action_params

Object

操作任务动作参数。

详情请参见表5

表5 action_params字段数据结构说明

参数

是否必选

参数类型

描述

endpoints

Array of objects

测试连接数据库信息。

详情请参见表6

precheck_mode

String

预检查模式。

skip_precheck_info

Object

跳过预检查项参数。

详情请参见表13

pause_mode

String

任务暂停模式,暂停任务时填写。停止源库日志抓取:all。

默认值:target。

start_time

String

任务定时启动时间。

compare_task_param

Object

操作对比任务消息体。

详情请参见表14

is_sync_re_edit

Boolean

再编辑任务启动时取值true。

force_delete

Boolean

强制结束任务时取值true。

public_ip_config

Object

租户公网IP信息。

详情请参见表27

replay_config

Object

录制回放仿真参数信息。

详情请参见表28

表6 endpoints字段数据结构说明

参数

是否必选

参数类型

描述

db_type

String

数据库类型。取值:

  • oracle:Oracle。
  • gaussdbv5:GaussDB分布式版。
  • redis:Redis。
  • rediscluster:Redis集群版。
  • gaussredis: GeminiDB Redis。

枚举值:

  • oracle
  • gaussdbv5
  • redis
  • rediscluster
  • gaussredis

endpoint_type

String

数据库实例类型。取值:

  • offline:自建数据库。
  • ecs:华为云ECS自建数据库。
  • cloud:华为云数据库。

枚举值:

  • offline
  • ecs
  • cloud

endpoint_role

String

数据库实例角色。取值:

  • so:源库。
  • ta:目标库。

枚举值:

  • so
  • ta

endpoint

Object

数据库基本信息体。

详情请参见表7

cloud

Object

数据库实例所在Region,项目等信息。

详情请参见表8

vpc

Object

数据库实例所在VPC,子网,安全组等信息。

详情请参见表9

config

Object

数据库基本设置信息体。

详情请参见表10

ssl

Object

数据库SSL证书信息体。

详情请参见表11

customized_dns

Object

客户自定义DNS服务。

详情请参见表12

表7 endpoint和source_sharding字段数据结构说明

参数

是否必选

参数类型

描述

id

String

数据库信息ID。

endpoint_name

String

数据库场景类型。取值:

  • oracle:云下自建Oracle数据库。
  • ecs_oracle:华为云ECS自建Oracle数据库。
  • cloud_gaussdbv5:华为云数据库GaussDB分布式。
  • mysql:他云/本地自建MySQL数据库。
  • ecs_mysql:华为云ECS自建MySQL数据库。
  • cloud_mysql:华为云数据库RDS for MySQL。
  • redis:云下自建Redis数据。
  • ecs_redis:华为云ECS自建Redis数据。
  • rediscluster:云下自建Redis集群数据库。
  • ecs_rediscluster:华为云ECS自建Redis集群数据库。
  • cloud_gaussdb_redis:华为云数据库GeminiDB Redis。

枚举值:

  • oracle
  • ecs_oracle
  • cloud_gaussdbv5
  • mysql
  • ecs_mysql
  • cloud_mysql
  • redis
  • ecs_redis
  • rediscluster
  • ecs_rediscluster
  • cloud_gaussdb_redis

ip

String

数据库IP。约束:

  • 数据库为自建MongoDB时,数据库IP与端口之间用“:”英文冒号拼接,多个值之间请用“,”英文逗号隔开,最多支持填写3个IP地址或域名。
  • 数据库为DDS实例时,数据库IP与端口之间用“:”英文冒号拼接,多个IP端口之间请用“,”英文逗号分隔。
  • 数据库为Redis集群时,请填写源端Redis集群所有分片的IP地址和对应端口,数据库IP与端口之间用“:”英文冒号拼接,多个IP端口之间请用“,”英文逗号分隔,并且推荐填写集群分片的Slave节点的IP地址。最多支持填写32个IP地址或域名,多个值之间请用英文逗号隔开。

示例:

  • MongoDB:192.168.0.10:8080,192.168.0.11:8080,192.168.0.12:8080
  • DDS:192.168.205.130:8635,192.168.250.64:8635
  • Redis集群:192.168.0.1:8080,192.168.0.2:8080

db_port

String

数据库端口。

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

db_user

String

数据库用户名。

db_password

String

数据库密码。

instance_id

String

华为云数据库实例ID。

instance_name

String

华为云数据库实例名称。

db_name

String

指定数据库名称。例如:

  • oracle:serviceName.orcl。

source_sharding

Array of objects

物理源库信息。

详情请参见表7

表8 cloud字段数据结构说明

参数

是否必选

参数类型

描述

region

String

区域ID,当数据库实例类型为ecs(华为云ECS自建数据库),cloud(华为云数据库)时为必填项。获取方法请参见地区和终端节点。 注意:当该Region下存在子项目时,Region ID为区域项目ID与子项目ID,由“_”下划线拼接。

project_id

String

租户在某一Region下的Project ID。 获取方法请参见获取项目ID。

az_code

String

数据库所在可用分区(AZ)名称。

表9 vpc字段数据结构说明

参数

是否必选

参数类型

描述

vpc_id

String

数据库实例所在的虚拟私有云ID,获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表

subnet_id

String

数据库实例所在子网ID,获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

security_group_id

String

数据库实例所在的安全组ID,获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询安全组列表

表10 config字段数据结构说明

参数

是否必选

参数类型

描述

is_target_readonly

Boolean

目标实例是否设置为为只读。

MySQL迁移和灾备,且job_direction为up时设置有效。(灾备场景下,单主灾备且本云为备为必填且为true,不填默认设置为true)。

缺省值:true

node_num

Integer

Redis集群到GeminiDB Redis迁移场景填写,连接源端Redis集群的子任务个数,输入值在1到16之间,且输入值不能大于源端Redis集群的分片个数,请根据源端Redis集群的规模合理选择。建议集群的每4个分片设置1个源端分片个数,即每1个子任务连接源端集群的4个分片。

最小值:1

最大值:16

缺省值:0

表11 ssl字段数据结构说明

参数

是否必选

参数类型

描述

ssl_link

Boolean

是否SSL安全连接。如果数据库启用了SSL安全连接,参数值为true。

ssl_cert_name

String

SSL证书名字。

ssl_cert_key

String

SSL证书内容,用base64加密。

ssl_cert_check_sum

String

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

ssl_cert_password

String

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

表12 customized_dns字段数据结构说明

参数

是否必选

参数类型

描述

is_set_dns

Boolean

是否设置客户自定义DNS。

set_dns_action

String

设置客户自定义DNS的行为。

  • add:新增客户自定义DNS IP。
  • keep:保持客户自定义DNS IP。
  • update:更新客户自定义DNS IP(当DNS IP变化时更新生效)。
  • recover:还原系统默认DNS IP(还原时可能会导致域名解析失败,请谨慎操作)。

枚举值:

  • add
  • keep
  • update
  • recover

dns_ip

String

设置客户自定义DNS IP。

最小长度:0

最大长度:15

表13 skip_precheck_info字段数据结构说明

参数

是否必选

参数类型

描述

skipped_precheck_list

Array of strings

跳过的预检查项。

skip_reason

String

跳过预检查原因。

表14 compare_task_param字段数据结构说明

参数

是否必选

参数类型

描述

compare_task_id

String

取消对比任务必填。

type

String

对比任务模式。取值:

  • object:对象对比。
  • lines:行数对比。
  • contents:内容对比。

枚举值:

  • object
  • lines
  • contents

start_time

String

定时启动时间,时间戳格式。

option

Map<String,String>

对比策略。

db_object

Map<String,DatabaseObject>

对比选择对象。

详情请参见表23

data_process_info

Array of objects

更新数据加工规则请求体。

详情请参见表15

表15 data_process_info字段数据结构说明

参数

是否必选

参数类型

描述

filter_conditions

Array of objects

指定任务数据加工规则请求体。

详情请参见表16

is_batch_process

Boolean

库级、批量表级处理为true,单表操作为false。

add_columns

Array of objects

附加列,当选择附加列时必须填写。

约束:使用多对一操作时,需要使用数据加工的附加列操作来避免数据冲突。

详情请参见表17

ddl_operation

Map<String,String>

支持DDL的语法 选择增量迁移或同步的DDL操作。取值及意思如下: "table": "CREATE TABLE, ALTER TABLE,DROP TABLE,RENAME TABLE"

如该值为空,不迁移或同步DDL操作。

dml_operation

String

支持DML的语法 选择DML操作时,取值如下:

  • i:INSERT。
  • u:UPDATE。
  • d:DELETE。

如该值为空,不增量迁移或同步DML操作。

db_object_column_info

Object

列映射、过滤信息 当进行列映射、过滤信息时必须填写。

详情请参见表18

db_or_table_rename_rule

Object

库表映射规则。

详情请参见表20

db_object

Object

数据加工对象信息,当做过映射、进行数据过滤条件校验时,必须填写

详情请参见表21

is_synchronized

Boolean

表示该规则是否已同步至目标库。

source

String

对比的来源。

  • job:表示数据同步时的过滤。
  • compare:表示数据对比的过滤。

枚举值:

  • job
  • compare
表16 filter_conditions字段数据结构说明

参数

是否必选

参数类型

描述

value

String

过滤条件,当filtering_type是configConditionalFilter时,value默认填写config;当filtering_type是contentConditionalFilter时,value默认填写过滤条件。

说明:
  • 每张表仅支持添加一个校验规则。
  • 数据过滤每次最多支持500张表。
  • 过滤表达式不支持使用某种数据库引擎特有的package、函数、变量、常量等写法,须使用通用SQL标准。
  • 请直接输入SQL语句中WHERE之后的部分(不包含WHERE和分号,例如:sid > 3 and sname like "G %"),最多支持输入512个字符。
  • 过滤条件填写的SQL语句中,关键字需要用反引号,datatime类型(包含日期和时间)需要用单引号,例如:update > '2022-07-13 00:00:00' and age >10。
  • 不支持对LOB字段设置过滤条件,如CLOB、BLOB、BYTEA等大字段类型。
  • 不支持库名、表名带有换行符的对象设置过滤规则。
  • 建议不要对非精确类型字段设置过滤条件,如FLOAT、DECIMAL、DOUBLE等。
  • 建议不要对带有特殊字符的字段设置过滤条件。
  • 不建议使用非幂等表达式或函数作为数据加工条件,如SYSTIMESTAMP,SYSDATE等,因其每次调用返回的结果可能会有差异,导致达不到预期。

filtering_type

String

过滤条件类型。

  • contentConditionalFilter: 简单条件过滤。
  • configConditionalFilter: 关联表过滤。

枚举值:

  • contentConditionalFilter
  • configConditionalFilter
表17 add_columns字段数据结构说明

参数

是否必选

参数类型

描述

column_type

String

列类型。

column_name

String

列名称。

column_value

String

列填充值。

data_type

String

填充列的数据类型。

表18 db_object_column_info字段数据结构说明

参数

是否必选

参数类型

描述

db_name

String

数据库库名称。

schema_name

String

数据库schema名称。

table_name

String

数据库表名称。

column_infos

Array of objects

数据库列信息。

详情请参见表19

total_count

Integer

数据库列信息总数,与分页无关,仅作为返回体参数。

表19 column_infos字段数据结构说明

参数

是否必选

参数类型

描述

column_name

String

列名。

column_type

String

列类型。

primary_key_or_unique_index

String

主键或者唯一索引。

column_mapped_name

String

列映射后的名称。

is_filtered

Boolean

该列是否过滤。

is_partition_key

Boolean

该列是否partitionKey。

表20 db_or_table_rename_rule字段数据结构说明

参数

是否必选

参数类型

描述

prefix_name

String

前缀名称。当type为prefixAndSuffix, 填写prefix_name,库表名称仅增加前缀,若同时也填写suffix_name, 库表名称增加前后缀。

suffix_name

String

后缀名称。当type为prefixAndSuffix, 填写suffix_name,库表名称仅增加后缀,若同时也填写prefix_name, 库表名称同时增加前后缀。

type

String

库表映射类型。prefixAndSuffix:前缀、后缀或者前后缀。

枚举值:

  • prefixAndSuffix
  • manyToOne
表21 db_object字段数据结构说明

参数

是否必选

参数类型

描述

object_scope

String

数据库对象迁移或同步范围。取值:

  • all:全部迁移。
  • database:库级迁移或同步。
  • table:表级迁移或同步。

枚举值:

  • all
  • database
  • table

target_root_db

object

数据库对象迁移或同步目标库,两层到三层数据库同步需要填写。

详情请参见表22

object_info

Map<String,DatabaseObject>

数据库对象迁移或同步信息,object_scope为all时不填,为库级或表级时必填。

详情请参见表23

表22 target_root_db字段数据结构说明

参数

是否必选

参数类型

描述

db_name

String

库名。

db_encoding

String

默认编码格式是utf8。

表23 db_object字段数据结构说明

参数

是否必选

参数类型

描述

sync_type

String

该数据库在实时同步场景下的类型。取值:

config:仅当该库作为数据过滤高级设置的关联库时,需要填写,此时该库以及该库下的schemas、tables“不会”被同步到目标库,name、all属性不生效,schemas、tables需要填写被关联的相关对象。

说明:

如果需要同步该库级对象,则在下级对象中填写sync_type值为config。

枚举值:

  • config

name

String

该数据库在目标库的名称(库名映射)。

all

Boolean

是否整库迁移或同步。

说明:
  • 当该库下的模式、表、列需要做数据过滤、列过滤、列映射时,填false,否则填true。
  • 当该库下的表需要做附加列时,需要填true,并且在表级对象的columns里填写附加列信息。
  • 当该库下的表所包含的列作为数据过滤高级设置的关联列时,需要填true,并且在columns里填写关联列信息,在config_conditions填写数据过滤高级设置的配置条件。

schemas

Map<String,SchemaObject>

需要迁移或同步的模式,当整库迁移或同步为false时需要填写。

详情请参见表24

tables

Map<String,TableObject>

需要迁移或同步的表,当整库迁移或同步为false时需要填写。

详情请参见表25

total_table_num

Integer

库下的表的数量,表的数量超过阈值就不显示。

is_synchronized

Boolean

是否已经进行同步。

表24 schemas字段数据结构说明

参数

是否必选

参数类型

描述

sync_type

String

该模式在实时同步场景下的类型。取值:

config:仅当该模式作为数据过滤高级设置的关联模式时,需要填写,此时该模式以及该模式下的tables“不会”被同步到目标库,name、all属性不生效,tables需要填写被关联的相关对象。

说明:

如果需要同步该模式对象,则在下级对象中填写sync_type值为config。

name

String

该模式在目标库的名称(模式名映射)。

all

Boolean

是否整模式迁移或同步。

说明:
  • 当该模式下的表、列需要做数据过滤、列过滤、列映射时,填false,否则填true。
  • 当该模式下的表需要做附加列时,需要填true,并且在表级对象的columns里填写附加列信息。
  • 当该模式下的表所包含的列作为数据过滤高级设置的关联列时,需要填true,并且在columns里填写关联列信息、config_conditions填写数据过滤高级设置的配置条件。

tables

Map<String,TableObject>

需要迁移或同步的表,当整模式迁移或同步为false时需要填写。

详情请参见表25

表25 tables字段数据结构说明

参数

是否必选

参数类型

描述

sync_type

String

该表在实时同步场景下的类型。取值:

config:仅当该表作为数据过滤高级设置的关联表时,需要填写,此时该表以及该表下的columns“不会”被同步到目标库,name、all、filtered、filter_conditions属性不生效,columns需要填写被关联的相关对象,config_conditions需要填写数据过滤高级设置的配置条件。

说明:

如果需要同步该表级对象,则在下级对象中填写sync_type值为config。

type

String

对象类型。取值:

  • table:表。
  • view:视图。
  • procedure:存储过程。

枚举值:

  • table
  • view
  • procedure

name

String

该表在目标库的名称(表名映射)。

all

Boolean

是否整表迁移或同步。

说明:
  • 当该表不需要做列过滤、列映射时,填true,如果需要做列过滤、列映射则填false。
  • 当该表需要做附加列时,需要填true,并且在columns里填写附加列信息。
  • 当该表所包含的列作为数据过滤高级设置的关联列时,需要填true,并且在columns里填写关联列信息、config_conditions填写数据过滤高级设置的配置条件。

db_alias_name

String

一对多情况下,表级上对库名的映射。

schema_alias_name

String

一对多情况下,表级上对schema名的映射。

filtered

Boolean

该表是否进行数据过滤。

filter_conditions

Array of strings

该表数据的过滤条件,生成加工规则值为SQL条件语句,长度限制512。

最小长度:0

最大长度:512

config_conditions

Array of strings

该表数据过滤高级设置的配置条件,当该表作为联表查询时填写,生成加工规则值为SQL条件语句,长度限制512。

最小长度:0

最大长度:512

is_synchronized

Boolean

是否已经进行同步。

columns

Map<String,ColumnObject>

需要同步/映射/过滤/新增的列,当需要列过滤、列映射、附加列功能时填写,仅在实时同步任务中生效,当整表同步为false时需要填写。

详情请参见表26

表26 columns字段数据结构说明

参数

是否必选

参数类型

描述

sync_type

String

该列在实时同步场景下的类型。取值:

config:当该列作为数据过滤高级设置的关联列时,需要填写,同时如果该列是主建或优化查询所需的索引,则需要填写primary_key_for_data_filtering或index_for_data_filtering。

说明:

是否同步该列到目标库由“filtered”属性控制,与库级、模式级、表级控制方式不同。

primary_key_for_data_filtering

String

该列是否在数据过滤高级设置场景下为主键,如果是主建则填该列列名,否则不填。

index_for_data_filtering

String

优化查询所需的索引,将会为缓存数据增加索引,不会影响源表,当该列作为数据过滤高级设置的关联索引时,需要填写,否则不填。

name

String

该列在目标库的名称(列名映射),当该列为“附加列”时须与数据库表级对象中列名保持一致。

type

String

该列字段的数据类型。 列过滤:填写源列字段的数据类型。 附加列:新填充的列指定字段的数据类型,根据不同操作类型来决定取值范围与约束。取值:

  • 以默认值方式,支持:int,long,varchar(256),datetime,timestamp。
  • 以create_time为列,支持:long,datetime,timestamp。
  • 以update_time为列,支持:long,datetime,timestamp。
  • 以表达式为列,支持:varchar(256),且列值仅为:concat(__current_database, '@', __current_table)
  • 以serverName@database@table为列,支持:varchar(256)。

primary_key_for_column_filtering

String

该列是否在列映射场景下为主键,如果是主建则填PRI,否则填空。

filtered

Boolean

该列是否进列过滤,不能与附加列additional同时使用。取值:

  • true:表示同步该列。
  • false:表示过滤该列不同步。

additional

Boolean

该列是否为附加列,当该列为附加列时:name必须与表级对象中列名一致,并且不能与列过滤filtered同时使用。

operation_type

String

操作类型,以特定的操作类型填充新加的列。取值:

  • 以默认值方式:"operation_type":"ADDITIONALCOLUMN,default_value"
  • 以create_time为列:"operation_type":"ADDITIONALCOLUMN,create_time"
  • 以update_time为列:"operation_type":"ADDITIONALCOLUMN,update_time"
  • 以表达式为列:"operation_type":"ADDITIONALCOLUMN,expression"
  • 以serverName@database@table为列:"operation_type":"ADDITIONALCOLUMN,server_database_table"

value

String

附加列的值。约束:

  • 当操作类型仅“以默认值方式”,“以serverName@database@table为列”时,才支持输入对应字段类型的值。
  • 当操作类型为“以表达式为列”时,该字段为固定值"concat(__current_database, '@', __current_table)",不需要填写。
表27 public_ip_config字段数据结构说明

参数

是否必选

参数类型

描述

id

String

指定公网IP的ID。

public_ip

String

指定公网IP。

type

String

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

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

枚举值:

  • master
  • slave
表28 replay_config字段数据结构说明

参数

是否必选

参数类型

描述

db_instance_id

String

源实例ID。

cloud_type

String

云类型:

  • AWSCloud:亚马逊云。
  • TencentCloud:腾讯云。
  • AliCloud:阿里云。

枚举值:

  • AWSCloud
  • TencentCloud
  • AliCloud

ak

String

其他云AK信息。

sk

String

其他云SK信息。

db_source

String

源数据库来源。取值:

  • aws_aurora_mysql:Amazon Aurora MySQL。
  • tencent_tdsql_c:腾讯云TDSQL-C MySQL。
  • ali_rds_mysql:阿里云RDS MySQL。

枚举值:

  • aws_aurora_mysql
  • tencent_tdsql_c
  • ali_rds_mysql

region

String

其他云Region名称。

traffic_source

String

流量文件来源。

  • sdk:通过三方云API接口方式下载审计日志。

响应参数

状态码: 200

表29 响应Body参数

参数

参数类型

描述

jobs

Array of objects

批量操作任务响应体。

详情请参见表30

表30 jobs字段数据结构说明

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

id

String

任务ID。

name

String

任务名称。

status

String

操作结果。

状态码: 202

表31 响应Body参数

参数

参数类型

描述

jobs

Array of objects

批量异步操作任务响应体。

详情请参见表32

表32 jobs字段数据结构说明

参数

参数类型

描述

query_id

String

异步操作任务响应查询ID。

id

String

任务ID。

name

String

任务名称。

状态码: 400

表33 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

请求示例

批量操作租户指定ID任务。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/action

{
  "jobs" : [ {
    "job_id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r",
    "action_name" : "start"
  }, {
    "job_id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r",
    "action_name" : "stop"
  } ]
}

响应示例

状态码: 200

OK

{
  "jobs" : [ {
    "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r",
    "name" : "DRS-1234",
    "status" : "Success"
  }, {
    "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r",
    "name" : "DRS-2345",
    "status" : "Failed",
    "error_code" : "DRS.10000010",
    "error_msg" : "Job does not exist, please check job ID"
  } ]
}

状态码: 202

Accepted

{
  "jobs" : [ {
    "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r",
    "name" : "DRS-1234",
    "query_id" : "7debc9c-8e09-4a5d-8dd6-cc44f45566"
  }, {
    "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r",
    "name" : "DRS-2345",
    "query_id" : "7debc9c-8e09-4a5d-8dd6-cc44f45566"
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

状态码

状态码

描述

200

OK

202

Accepted

400

Bad Request

错误码

请参见错误码