Help Center/Distributed Message Service for Kafka/API Reference/APIs V2 (Recommended)/Specification Modification Management/Obtaining Pre-check Information Before Expanding a Kafka Instance
Updated on 2026-03-16 GMT+08:00
View PDF

Obtaining Pre-check Information Before Expanding a Kafka Instance

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

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: normal

  • false: 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}/kafka/instances/{instance_id}/extend-check

Example Responses

Status code: 200

Pre-check information obtained.

[ {
  "name" : "CPU",
  "success" : true,
  "reason" : "",
  "risk" : "low"
}, {
  "name" : "RAM",
  "success" : true,
  "reason" : "",
  "risk" : "low"
}, {
  "name" : "REPLICA",
  "success" : false,
  "reason" : "topic-1-1",
  "risk" : "medium"
}, {
  "name" : "ISR",
  "success" : true,
  "reason" : "",
  "risk" : "high"
}, {
  "name" : "NETWORK",
  "success" : true,
  "reason" : "",
  "risk" : "medium"
} ]

Status Codes

Status Code

Description

200

Pre-check information obtained.

Error Codes

See Error Codes.

Parent Topic: Specification Modification Management