Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Diagnosing an Instance/ Deleting Instance Diagnosis Reports in Batches
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting Instance Diagnosis Reports in Batches

Function

This API is used to delete diagnosis reports of an instance in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/{engine}/instances/{instance_id}/diagnosis/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Definition

Engine.

Constraints

N/A

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

Default Value

N/A

project_id

Yes

String

Definition

Project ID. For details, 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

report_id_list

No

Array of strings

Definition:

Diagnosis report ID list.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

report_id_list

Array of strings

Definition:

Diagnosis report ID list.

Range:

N/A

Example Requests

Deleting diagnosis reports of an instance in batches

POST https://{endpoint}/v2/{project_id}/{engine}/instances/{instance_id}/diagnosis/batch-delete

{
  "report_id_list" : [ "a68bb70a-ac92-4047-b8a6-30612b521624" ]
}

Example Responses

Status code: 200

success

{
  "report_id_list" : [ "a68bb70a-ac92-4047-b8a6-30612b521624" ]
}

Status Codes

Status Code

Description

200

success

Error Codes

See Error Codes.

Parent Topic: Diagnosing an Instance