Help Center/ Distributed Message Service for Kafka/ API Reference/ Out-of-Date APIs/ API V2/ Specification Modification Management/ Increasing Instance Specifications
Updated on 2025-05-21 GMT+08:00
View PDF

Increasing Instance Specifications

Function

This API is used to modify instance specifications.

This API is out-of-date and may not be maintained in the future. Please use the API described in Increasing Instance Specifications.

URI

POST /v2/{engine}/{project_id}/instances/{instance_id}/extend

Table 1 URI parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Indicates the message engine.

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

oper_type

Yes

String

Operation type.

Values:

  • storage: Expand the storage space without adding brokers.
  • horizontal: Add brokers without resizing the storage space of each broker.
  • vertical: Modify the underlying flavor of brokers without adding brokers or storage space.

new_storage_space

No

Integer

New storage space.

This parameter is valid and mandatory when oper_type is set to storage or horizontal.

Instance storage space = Number of brokers × Storage space of each broker.

If oper_type is set to storage, the number of brokers remains unchanged, and the storage space of each broker must be expanded by at least 100 GB.

If oper_type is set to horizontal, the storage space of each broker remains unchanged.

new_broker_num

No

Integer

This parameter is valid only when oper_type is set to horizontal.

new_product_id

No

String

New product ID for scale-up.

This parameter is valid and mandatory when oper_type is set to vertical.

You can obtain the product ID from Querying Product Specifications.

publicip_id

No

String

ID of the elastic IP address (EIP) bound to an instance.

Use commas (,) to separate multiple EIP IDs.

This parameter is mandatory when oper_type is set to horizontal.

tenant_ips

No

Array of strings

Specified private IP address. Only IPv4.

The number of specified IP addresses must be less than or equal to the number of new nodes.

If the number of specified IP addresses is less than the number of nodes, private IP addresses are randomly allocated to the nodes that are not specified.

second_tenant_subnet_id

No

String

To increase instance specifications, new brokers use the ID of the subnet.

This value is transferred when a standby subnet is used in instance expansion.

Contact customer service to use the value.

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

job_id

String

ID of the specification modification task.

Example Request

  • Increasing the storage space (pay-per-use instance) 
    POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend

{
  "oper_type" : "storage",
  "new_storage_space" : 600
}
  • Increasing brokers (pay-per-use instance) 
    POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend

{
  "oper_type" : "horizontal",
  "new_storage_space" : 1600,
  "new_broker_num" : 4,
  "tenant_ips" : [ "127.0.0.1", "127.0.0.2", "127.0.0.3" ]
}
  • Increasing the broker flavor (pay-per-use instance) 
    POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/extend

{
  "oper_type" : "vertical",
  "new_product_id" : "c6.4u8g.cluster"
}

Example Response

Status code: 200

Instance scaled.

{
  "job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7"
}

Status Code

Status Code

Description

200

Instance scaled.

Error Codes

See Error Codes.

Parent Topic: Specification Modification Management