文档首页/ 数据安全中心 DSC/ API参考/ API/ API数据安全网关/ 添加或者更新作业 - StartTask
更新时间:2026-10-09 GMT+08:00
分享

添加或者更新作业 - StartTask

功能介绍

功能介绍:添加或者更新job

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/sdg/server/task/start

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

db_type

否

String

参数解释:

数据库类型

约束限制:

不涉及

取值范围:

  • "OBS" 对象存储服务

  • "MSSQL" SQLServer数据库

  • "MYSQL" MySQL数据库

  • "ES" Elasticsearch搜索引擎

  • "PG" PostgreSQL数据库

  • "GREENPLUM" Greenplum数据库

  • "ORACLE" Oracle数据库

  • "MRS_HIVE" MRS Hive数据仓库

  • "HBASE" HBase数据库

  • "DWS" 数据仓库服务

  • "KINGBASE" 人大金仓数据库

  • "OPENGAUSS" 高斯数据库

  • "DMDBMS" 达梦数据库

  • "Hive" Hive数据仓库

  • "MARIADB" MariaDB数据库

  • "TAURUS_DB" TaurusDB数据库

  • "TDSQL" TDSQL数据库

  • "HIVE_ONLY" 仅自建Hive

  • "DLI" 数据湖探索

  • "MONGODB" MongoDB数据库

  • "LTS" 日志服务

默认取值:

不涉及

connect_info

否

ConnectInfo object

参数解释:

数据库连接信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

db_version

否

String

参数解释:

数据库版本号

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

job_name

否

String

参数解释:

扫描任务名称

约束限制:

最大长度128字符

取值范围:

不涉及

默认取值:

不涉及

schemas

否

Array of strings

参数解释:

待扫描的Schema列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

scan_settings

否

ScanSettings object

参数解释:

扫描配置信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

max_connections

否

Integer

参数解释:

最大连接数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 ConnectInfo

参数

是否必选

参数类型

描述

use_db_url

否

Boolean

参数解释:

是否使用数据库URL

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

db_url

否

String

参数解释:

数据库连接URL

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

id

否

String

参数解释:

资源ID,唯一标识

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

ins_type

否

String

参数解释:

连接信息类型

约束限制:

最大长度65535字符

取值范围:

  • PUB-普通

  • RDS-关系型数据库

  • ECS-弹性云服务器

  • CCE-云容器引擎

  • CSS-云搜索服务

  • OUTSIDE-外部

  • OBS-对象存储

  • MRS-MapReduce服务

  • MRS_HWS-MRS华为

  • DWS-数据仓库服务

  • DLI-数据湖探索

  • LTS-日志服务

  • GAUSSDB-GaussDB数据库

  • EXTERNAL-外部

  • DDS-文档数据库

  • CLOUDDB-云数据库

默认取值:

不涉及

region

否

String

参数解释:

连接区域

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

ds_name

否

String

参数解释:

数据源名称

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

ds_type

否

String

参数解释:

数据源类型

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

ds_address

否

String

参数解释:

数据源IP地址

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

ds_port

否

Integer

参数解释:

数据源端口

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

ds_user

否

String

参数解释:

数据源用户名

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

ds_version

否

String

参数解释:

数据源版本

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

表5 ScanSettings

参数

是否必选

参数类型

描述

settings

否

String

参数解释:

设置信息

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

扫描任务ID

取值范围:

不涉及

请求示例

添加或者更新作业请求体

{
  "db_type" : "MYSQL",
  "connect_info" : {
    "use_db_url" : true,
    "db_url" : "jdbc:mysql://192.168.1.100:3306/customer_db?useSSL=false",
    "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "ins_type" : "RDS",
    "region" : "cn-north-4",
    "ds_name" : "customer-mysql-rds",
    "ds_type" : "MYSQL",
    "ds_address" : "192.168.1.100",
    "ds_port" : 3306,
    "ds_user" : "dsc_scan_user",
    "ds_version" : "8.0"
  },
  "db_version" : "8.0",
  "job_name" : "customer-db-scan-01",
  "schemas" : [ "customer_schema" ],
  "scan_settings" : {
    "settings" : "{}"
  },
  "max_connections" : 10
}

响应示例

状态码:200

{
  "job_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e"
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码。

相关文档