GetCrawler - 查询元数据采集器详情 - 大数据开发治理平台 DataWorks

查询指定元数据采集器的配置、状态和最近一次运行信息。

接口说明

使用场景

查询指定元数据采集器的配置、可用状态和最近一次运行信息。

版本要求

需要购买 DataWorks 基础版及以上版本才能使用。

注意事项

采集器尚未运行时，最近运行状态和任务实例 ID 可能为空。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	元数据采集器 ID。您可以通过 ListCrawlers 查询。	1234

Id 可通过 ListCrawlers 查询。

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	请求是否成功。
Crawler	object	元数据采集器详情。
Id	integer	采集器 ID	1234
Name	string	采集器名称	example_crawler
DataSourceId	integer	数据源 ID	12345
Type	string	采集器类型	starrocks
Status	string	采集器状态。采集器配置有效且关联数据源存在时为 VALID，否则为 INVALID	VALID
MetaEntityId	string	采集器关联的元实体 ID，可用于衔接元数据查询 API	starrocks:example-instance
ProjectId	integer	DataWorks 工作空间 ID	100
EnvType	string	DataWorks 环境类型。取值：Dev、Prod	Prod
ResourceGroupId	string	运行采集任务使用的 Serverless 2.0 资源组 ID。	Serverless_res_group_1234567890123456_1234567890
ScheduleConfig	object	调度配置
Type	string	调度类型。取值：MANUAL、NORMAL	NORMAL
CronExpress	string	Cron 表达式	0 0 2 ? * *
LastRunStatus	string	最近一次运行状态。取值：WAITING、RUNNING、SUCCESS、ERROR、SHUTDOWN。采集器尚未运行时可能为空。	SUCCESS
Owner	string	采集器负责人的 DataWorks 用户 ID。	1000
CreateTime	integer	创建时间，毫秒级 Unix 时间戳	1710239005403
ModifyTime	integer	修改时间，毫秒级 Unix 时间戳	1710239005403
Scope	object	采集范围配置
Unit	string	采集范围粒度。取值：PROJECT、DATABASE、INSTANCE、CATALOG	DATABASE
Items	array	采集范围条目
	string	单个采集范围条目。	example_database
ExcludeRegex	string	采集范围排除正则	^tmp_.*
EnableAiComment	boolean	是否启用 AI 元数据描述
Options	object	采集器类型扩展配置
	string	单个采集器扩展配置项的值。	true
LastRunTaskInstanceId	integer	最近一次运行关联的 DataWorks 任务实例 ID。采集器尚未运行时可能为空。	1234
TaskId	integer	采集器关联的 DataWorks 调度任务 ID，可用于调用 GetTask 查询任务定义	1234

Crawler 返回采集器配置、可用状态和最近一次运行信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": true,
  "Crawler": {
    "Id": 1234,
    "Name": "example_crawler",
    "DataSourceId": 12345,
    "Type": "starrocks",
    "Status": "VALID",
    "MetaEntityId": "starrocks:example-instance",
    "ProjectId": 100,
    "EnvType": "Prod",
    "ResourceGroupId": "Serverless_res_group_1234567890123456_1234567890",
    "ScheduleConfig": {
      "Type": "NORMAL",
      "CronExpress": "0 0 2 ? * *"
    },
    "LastRunStatus": "SUCCESS",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "Scope": {
      "Unit": "DATABASE",
      "Items": [
        "example_database"
      ],
      "ExcludeRegex": "^tmp_.*"
    },
    "EnableAiComment": true,
    "Options": {
      "key": "true"
    },
    "LastRunTaskInstanceId": 1234,
    "TaskId": 1234
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

大数据开发治理平台 DataWorks：GetCrawler - 查询元数据采集器详情