Updated on 2026-01-13 GMT+08:00

Managing Metadata Tasks

Function

This API is used to manage metadata tasks, such as starting, stopping, or pausing tasks. You can manage tasks by specifying operation requests to flexibly control the task execution status.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/metadata/task-templates/{template_id}/operate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.

template_id

Yes

Long

Task ID, which is used to identify a specific task template.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

No

String

Operation type. Values: ENABLE: enabled. DISABLE: disabled. START: started.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Task ID.

msg

String

Operation status message.

status

String

Operation status.

Status code: 201

Resource being created.

Example Requests

POST /v1/{project_id}/metadata/task-templates/{template_id}/operate

{
  "action" : "string"
}

Example Responses

None

Status Codes

Status Code

Description

200

Operation succeeded.

201

Resource being created.

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified project or template does not exist.

Error Codes

See Error Codes.