Querying Details About a Metadata Collection Task

Function

Query details about a collection task.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/metadata/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.
task_id	Yes	String	Task ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Task ID
name	String	Task name
description	String	Task description.
user_id	String	User ID.
create_time	String	Creation time.
project_id	String	Product ID.
dir_id	String	Directory ID
schedule_config	SchedulerInfo object	Scheduling information
parameter_config	Array of CustomMetadata objects	User-defined metadata information.
update_time	String	Modification time.
user_name	String	User name.
path	String	Path
last_run_time	String	Last execution time.
start_time	String	Start time
end_time	String	End time
next_run_time	String	Next execution time.
duty_person	String	Owner
update_type	String	Modification type
data_source_type	String	Data source type
task_config	Object	Task information, which is Map(String, Object) The key is the attribute name, and value is the attribute value.
data_source_workspace_id	String	Workspace ID of the data source

**Table 4** SchedulerInfo
Parameter	Type	Description
cron_expression	String	Expression
end_time	String	End time
max_time_out	Integer	Maximum timeout interval
interval	String	Interval
schedule_type	String	Scheduling type
start_time	String	Start time
job_id	Integer	Job ID
enabled	Integer	Enabled

**Table 5** CustomMetadata
Parameter	Type	Description
description	String	Description
type	String	Type
task_id	String	Task ID

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

None

Example Responses

Status code: 200

OK.

{
  "create_time" : "1663573720930",
  "data_source_type" : "HIVE",
  "data_source_workspace_id" : null,
  "description" : "",
  "dir_id" : "0",
  "duty_person" : "user_demo",
  "end_time" : "0",
  "id" : "8a9480ed8353e491018354b87f63009e",
  "last_run_time" : "1663574072000",
  "name" : "Collect and verify FAW-Volkswagen requirements.",
  "next_run_time" : "0",
  "parameter_config" : [ ],
  "path" : "",
  "project_id" : null,
  "schedule_config" : [ {
    "cron_expression" : null,
    "enabled" : 4,
    "end_time" : null,
    "interval" : null,
    "job_id" : 261593,
    "max_time_out" : 60,
    "schedule_type" : "RUN_ONCE",
    "start_time" : null
  } ],
  "start_time" : "0",
  "task_config" : [ ],
  "update_time" : "1663573720930",
  "update_type" : null,
  "user_id" : "0833a573fe80d5401f6dc010a775569a",
  "user_name" : "user_demo"
}