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

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;


public class ShowKafkaProductCoresSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowKafkaProductCoresRequest request = new ShowKafkaProductCoresRequest();
        try {
            ShowKafkaProductCoresResponse response = client.showKafkaProductCores(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowKafkaProductCoresRequest()
        response = client.show_kafka_product_cores(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowKafkaProductCoresRequest{}
	response, err := client.ShowKafkaProductCores(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.