文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API(V2)/ 作业开发API/ 查询表的作业引用数 - ListTaskTableReferenceCount
更新时间:2026-06-04 GMT+08:00
分享

查询表的作业引用数 - ListTaskTableReferenceCount

功能介绍

查询表的作业作业(调度中)引用数量。

调用方法

请参见如何调用API

授权信息

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

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

URI

POST /v2/{project_id}/factory/task-table-references/count

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值),使用Token认证时必选,最小长度:0,最大长度:4096。

X-Project-Id

String

project_id,项目编号。获取方法请参见项目ID和账号ID

多project场景采用AK/SK认证的接口请求,则该字段必选。

Content-Type

String

默认值:application/json;charset=UTF-8

可选,有Body体的情况下必选,没有Body体则无需填写和校验。

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

表3 请求Body参数

参数

是否必选

参数类型

描述

task_table_references

Array of TaskTableReferenceDTO objects

待查询表的信息,一次最多查询20个表。

表4 TaskTableReferenceDTO

参数

是否必选

参数类型

描述

db_type

String

数据库类型,仅支持DLI,HIVE,SPARK。

data_base_name

String

数据库名称。

table_name

String

数据库表名。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

task_table_count_list

Array of TaskTableReferenceCountResponseV2DTO objects

表的引用数详情。

表6 TaskTableReferenceCountResponseV2DTO

参数

参数类型

描述

db_type

String

数据连接类型。

data_base_name

String

数据库名称。

table_name

String

数据表名称。

cluster_name

String

集群名称。

job_count

Integer

引用的作业数。

workspace_id

String

工作空间ID。

workspace_name

String

工作空间名称。

workspace_job_counts

Array of WorkspaceJobCountDTO objects

各工作空间作业数列表。

表7 WorkspaceJobCountDTO

参数

参数类型

描述

workspace_id

String

工作空间ID。

workspace_name

String

工作空间名称。

job_count

Integer

该工作空间下的作业数。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询HIVE表hive_test_11,SPARK表employee_456,DLI表a_08的作业引用数。

POST /v2/{project_id}/factory/task-table-references/count

{
  "task_table_references" : [ {
    "db_type" : "HIVE",
    "table_name" : "hive_test_11"
  }, {
    "db_type" : "SPARK",
    "table_name" : "employee_456"
  }, {
    "db_type" : "DLI",
    "table_name" : "a_08"
  } ]
}

响应示例

状态码:200

查询成功。

{
  "task_table_count_list" : [ {
    "data_base_name" : "1_database",
    "db_type" : "DLI",
    "job_count" : 1,
    "table_name" : "a_08",
    "workspace_job_counts" : [ {
      "workspace_id" : "ws_001",
      "workspace_name" : "工作空间1",
      "job_count" : 1
    } ]
  }, {
    "cluster_name" : "mrs_60071036-faq",
    "data_base_name" : "default",
    "db_type" : "HIVE",
    "job_count" : 2,
    "table_name" : "hive_test_11",
    "workspace_job_counts" : [ {
      "workspace_id" : "ws_001",
      "workspace_name" : "工作空间1",
      "job_count" : 1
    }, {
      "workspace_id" : "ws_002",
      "workspace_name" : "工作空间2",
      "job_count" : 1
    } ]
  }, {
    "cluster_name" : "mrs_30026478",
    "data_base_name" : "default",
    "db_type" : "SPARK",
    "job_count" : 3,
    "table_name" : "employee_456",
    "workspace_job_counts" : [ {
      "workspace_id" : "ws_001",
      "workspace_name" : "工作空间1",
      "job_count" : 2
    }, {
      "workspace_id" : "ws_003",
      "workspace_name" : "工作空间3",
      "job_count" : 1
    } ]
  } ]
}

状态码:400

查询失败。

{
  "error_code" : "DLF.50060",
  "error_msg" : "Check dbTypes failed: [table: hive_test_11 has invalid dbType: HIVEE]."
}

状态码

状态码

描述

200

查询成功。

400

查询失败。

相关文档