Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Metadata Collection Tasks/ This API is used to query the metadata collection task list.
Updated on 2025-11-17 GMT+08:00
View PDF

This API is used to query the metadata collection task list.

Function

This API is used to query collection tasks.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/metadata/tasks/search

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.

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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user_name

No

String

Creator

name

No

String

Task name

data_source_type

No

String

Data source type

data_connection_id

No

String

Data connection ID

start_time

No

String

Start time

end_time

No

String

End time

directory_id

No

String

Directory ID

bucket_name

No

String

Bucket name

limit

No

Integer

Pagination parameter limit. The default value is 10.

offset

No

Integer

Indicates the pagination parameter offset. The default value is 0.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Querying the number of collection tasks

total_records

Integer

Number of collection tasks created under the same project ID.

max_records

Integer

Maximum number of collection tasks that can be created under the same project ID.

resources

Array of MetadataCollectionTask objects

List of collection tasks.
Table 5 MetadataCollectionTask

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 6 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 7 CustomMetadata

Parameter

Type

Description

description

String

Description

type

String

Type

task_id

String

Task ID

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "user_name" : "userName",
  "name" : null,
  "data_source_type" : null,
  "data_connection_id" : null,
  "start_time" : null,
  "end_time" : null,
  "directory_id" : "e4248d66-c376-4f1b-a576-e4d1c6838d83",
  "bucket_name" : null,
  "limit" : 10,
  "offset" : 1
}

Example Responses

Status code: 200

OK.

{
  "count" : 1,
  "total_records" : 1,
  "max_records" : 100,
  "resources" : [ {
    "create_time" : "1663722819809",
    "data_source_type" : "HIVE",
    "data_source_workspace_id" : null,
    "description" : null,
    "dir_id" : "0",
    "duty_person" : "user_demo",
    "end_time" : "0",
    "id" : "8a948047835b945101835d9b90e1010f",
    "last_run_time" : "1663723446000",
    "name" : "hive921",
    "next_run_time" : "0",
    "parameter_config" : [ ],
    "path" : null,
    "project_id" : null,
    "schedule_config" : [ {
      "cron_expression" : null,
      "enabled" : 4,
      "end_time" : null,
      "interval" : null,
      "job_id" : 262070,
      "max_time_out" : 60,
      "schedule_type" : "RUN_ONCE",
      "start_time" : null
    } ],
    "start_time" : "0",
    "task_config" : [ ],
    "update_time" : "1663722819809",
    "update_type" : null,
    "user_id" : "0833a573fe80d5401f6dc010a775569a",
    "user_name" : "user_demo"
  } ]
}

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.
Parent Topic: Metadata Collection Tasks