查询作业表引用详情 - ListTaskTableReferenceDetail
功能介绍
查询表被作业(调度中)引用详情。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/factory/task-table-references
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方法请参见项目ID和账号ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 分页列表的页数,默认值为0。取值范围大于等于0。 |
| limit | 否 | Integer | 分页返回结果,指定每页最大记录数。范围[1,100] 默认值:20 |
| db_type | 是 | String | 数据库类型,仅支持DLI,HIVE,SPARK。 |
| data_base_name | 否 | String | 数据库名称。 |
| table_name | 是 | String | 数据库表名。 |
| cluster_name | 否 | String | 集群名称。 |
| io_type | 否 | Integer | 作业和表的关系,0(读表)/1(写表)。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 引用的作业数量。 |
| task_table_detail_list | Array of TaskTableReferenceDetailResponse objects | 引用作业的详情。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | Long | 作业id。 |
| job_name | String | 作业名。 |
| db_type | String | 数据库类型。 |
| data_base | String | 数据库名。 |
| table_name | String | 数据表名。 |
| cluster_name | String | 集群名称。 |
| workspace_name | String | 作业的工作空间名。 |
| workspace_id | String | 作业的工作空间Id。 |
| owner | String | 作业责任人。 |
| last_submit_time | String | 作业最后提交时间。 |
| io_type | Integer | 作业和表的关系,0表示作业是读表,1表示作业写表。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
查询HIVE表hive_test_11的作业引用详情。
GET /v2/{project_id}/factory/task-table-references?db_type=HIVE&table_name=hive_test_11 响应示例
状态码:200
查询成功,返回表被作业(调度中)引用情况。
{
"task_table_detail_list" : [ {
"cluster_name" : "mrs_60071036-faq",
"data_base" : "default",
"db_type" : "HIVE",
"io_type" : 1,
"job_id" : 5639,
"job_name" : "job_1150",
"last_submit_time" : 1770167498000,
"owner" : "ei_dlf_l00341563",
"table_name" : "hive_test_11",
"workspace_id" : "bc5f1e9ddd9648e1bed59a35ec76b0a0",
"workspace_name" : "yzx_test123"
}, {
"cluster_name" : "mrs_60071036-faq",
"data_base" : "default",
"db_type" : "HIVE",
"io_type" : 1,
"job_id" : 5643,
"job_name" : "job_1294",
"last_submit_time" : 1770253080000,
"owner" : "ei_dlf_l00341563",
"table_name" : "hive_test_11",
"workspace_id" : "bc5f1e9ddd9648e1bed59a35ec76b0a0",
"workspace_name" : "yzx_test123"
} ],
"total" : 2
} 状态码:400
查询数据表引用失败。
{
"error_code" : "DLF.50060",
"error_msg" : "Check dbTypes failed: [table: hudi_bugtest_001 has invalid dbTypes: [HIV]]."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功,返回表被作业(调度中)引用情况。 |
| 400 | 查询数据表引用失败。 |