Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Metadata Collection Tasks/ Starting, Scheduling, or Stopping a Metadata Collection Task
Updated on 2025-11-17 GMT+08:00

Starting, Scheduling, or Stopping a Metadata Collection Task

Function

Starts, schedules, and stops collection tasks.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/metadata/tasks/{task_id}/action

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Start, scheduling, or stop operation

Request Parameters

Table 3 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: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.