Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Other APIs/ Querying vCPUs of a Kafka Flavor
Updated on 2025-12-31 GMT+08:00
View PDF

Querying vCPUs of a Kafka Flavor

Function

This API is used to query the number of vCPUs of a Kafka flavor.

Calling Method

For details, see Calling APIs.

URI

GET /v2/kafka/products/cores

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

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. The instance ID is optional. total_extend_storage_space is returned only when the instance ID is entered in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

product_id

Yes

String

Definition

Product ID.

Constraints

N/A

Range

  • s6.2u4g.single.small: product ID of the kafka.2u4g.single.small flavor

  • c6.2u4g.single: product ID of the kafka.2u4g.single flavor

  • s6.2u4g.cluster.small: product ID of the kafka.2u4g.cluster.small flavor

  • c6.2u4g.cluster: product ID of the kafka.2u4g.cluster flavor

  • c6.4u8g.cluster: product ID of the kafka.4u8g.cluster flavor

  • c6.8u16g.cluster: product ID of the kafka.8u16g.cluster flavor

  • c6.12u24g.cluster: product ID of the kafka.12u24g.cluster flavor

  • c6.16u32g.cluster: product ID of the kafka.16u32g.cluster flavor

Default Value

N/A

broker_num

Yes

String

Definition

Broker quantity.

Constraints

N/A

Range

  • For kafka.2u4g.single.small instances, the suggested value range is 1.

  • For kafka.2u4g.single instances, the suggested value range is 1.

  • For kafka.2u4g.cluster.small instances, the value range is 3–30.

  • For kafka.2u4g.cluster instances, the value range is 3–30.

  • For kafka.4u8g.cluster instances, the value range is 3–30.

  • For kafka.8u16g.cluster instances, the value range is 3–50.

  • For kafka.12u24g.cluster instances, the value range is 3–50.

  • For kafka.16u32g.cluster instances, the value range is 3–50.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

core_num

Integer

Definition

Number of cores.

Range

N/A

total_extend_storage_space

Integer

Definition

Estimated storage space. If the entered broker_num is less than or equal to the actual value of the current instance, the storage space of the current instance is displayed. Otherwise, the estimated storage space of the instance with the entered broker_num is displayed.

Range

N/A

Example Requests

GET https://{endpoint}/v2/kafka/products/cores?instance_id={instance_id}&product_id={product_id}&broker_num={broker_num}

Example Responses

Status code: 200

Successful

{
  "core_num" : 100,
  "total_extend_storage_space" : 300
}

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.

Parent Topic: Other APIs