Upgrading an Instance

This API is used to upgrading the kernel of an instance.

For details, see Calling APIs.

POST /v2/{project_id}/kafka/instances/{instance_id}/upgrade

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
is_schedule	No	Boolean	Whether the task is scheduled. If no, is_schedule and execute_at can be left blank. If yes, is_schedule is true and execute_at must be specified.
execute_at	No	Long	Schedule time. The value is a UNIX timestamp, in ms.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	String	ID of the submitted upgrade task.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Upgrading an instance whose ID is instance_id

POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/upgrade

{
  "is_schedule" : true,
  "execute_at" : 1695796358970
}

Status code: 200

Successful

93b94287-728d-4bb1-a158-cb66cb0854e7

Status Code	Description
200	Successful
400	Failed

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.