Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Metadata Migration/ Deleting a Metadata Migration Task
Updated on 2026-01-23 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Metadata Migration Task

Function

This API is used to delete a metadata migration task.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/instances/{instance_id}/metadata

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

task_ids

Yes

Array of strings

Definition

Tasks to be deleted.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success_task_list

Array of strings

Definition

List of tasks that are successfully deleted.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

This API is used to delete a metadata migration task.

DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/metadata

{
  "task_ids" : [ "1b8f2c93-8057-4bdd-9be5-5b6883737099", "fa89699b-61b9-497d-b1ac-972623f3c0ce" ]
}

Example Responses

Status code: 200

Metadata migration task deleted.

{
  "success_task_list" : [ "1b8f2c93-8057-4bdd-9be5-5b6883737099", "fa89699b-61b9-497d-b1ac-972623f3c0ce" ]
}

Status Codes

Status Code

Description

200

Metadata migration task deleted.

Error Codes

See Error Codes.

Parent Topic: Metadata Migration