Updated on 2025-12-18 GMT+08:00

Querying Pre-check Information Before Expanding a RocketMQ Instance

Function

This API is used to obtain pre-check information before expanding a RocketMQ instance.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/rocketmq/instances/{instance_id}/extend-check

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

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

name

String

Definition

Check item name.

Range

N/A

success

Boolean

Definition

Check item status.

Range

  • true: The check item is normal.

  • false: The check item is abnormal.

reason

String

Definition

Failure cause.

Range

N/A

risk

String

Definition

Risk level.

Range

  • low

  • medium

  • high

Example Requests

GET https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/extend-check

Example Responses

Status code: 200

Queried.

{
  "name" : "CPU",
  "success" : true,
  "reason" : "",
  "risk" : "low"
}

Status Codes

Status Code

Description

200

Queried.

Error Codes

See Error Codes.