Querying Product Flavors

Function

This API is used to query the product flavor (parameter spec_code) required for configuring a new DCS instance. If no search criterion is specified, all product specifications will be queried by default.

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/{project_id}/flavors

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
instance_id	No	String	Parameter description: DCS instance ID, which can be viewed on the instance details page on the DCS console. You can use this field to query the specifications that the instance can use. Constraints: N/A. Value range: N/A. Default value: N/A.
spec_code	No	String	Parameter description: Product flavor. To obtain it, do as follows: Method 1: Log in to the DCS console, go to the instance creation page, and check the instance flavor. Method 2: Call the API used to query product flavors. Constraints: N/A. Value range: N/A. Default value: N/A.
cache_mode	No	String	Definition DCS instance type. Constraints N/A Range single: single-node ha: master/standby cluster: Redis Cluster proxy: Proxy Cluster ha_rw_split: read/write splitting Default Value N/A
engine	No	String	Definition Cache engine. Constraints N/A Range Redis Memcached Default Value N/A
engine_version	No	String	Definition Cache version. Constraints N/A Range The engine version of a DCS Redis instance can be: 3.0 4.0 5.0 6.0 7.0 If the cache engine is Memcached, this parameter is blank. Default Value N/A
cpu_type	No	String	Parameter description: CPU architecture. Constraints: N/A. Value range: x86_64: x86 architecture aarch64: Arm architecture Default value: N/A.
capacity	No	String	Definition Cache capacity (GB). Constraints N/A Range For a single-node or master/standby DCS Redis 4.0/5.0/6.0/7.0 instance, the value can be 1, 2, 4, 8, 16, 24, 32, 48, or 64. For a cluster DCS Redis 4.0 or later instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or 1024. For read/write splitting Redis instances, the value can be 1, 2, 4, 8, 16, 32, or 64. For a single-node or master/standby DCS Memcached instance, the value can be 2, 4, 8, 16, 32, or 64. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
flavors	Array of FlavorsItems objects	Parameter description: Product flavor details. Value range: N/A.

**Table 4** FlavorsItems
Parameter	Type	Description
spec_code	String	Parameter description: Product flavor code. Value range: N/A.
cloud_service_type_code	String	Parameter description: Cloud service type code. Value range: N/A.
cloud_resource_type_code	String	Parameter description: Cloud resource type code. Value range: N/A.
cache_mode	String	Definition DCS instance type. Range single: single-node ha: master/standby cluster: Redis Cluster proxy: Proxy Cluster ha_rw_split: read/write splitting
engine	String	Parameter description: Cache engine. Value range: Redis Memcached
engine_version	String	Definition Cache version. Range The engine version of a DCS Redis instance can be: 3.0 4.0 5.0 6.0 7.0 If the cache engine is Memcached, this parameter is blank.
product_type	String	Parameter description: Edition of DCS for Redis. Value range: The value can only be generic, which means the standard edition.
cpu_type	String	Parameter description: CPU architecture. Value range: x86_64: x86 architecture aarch64: Arm architecture
storage_type	String	Parameter description: Storage type. Value range: The value can only be DRAM, which means memory storage.
capacity	Array of strings	Parameter description: Cache capacity (GB). Value range: 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, 1024, 2048
billing_mode	Array of strings	Definition Billing mode. Range Hourly: pay-per-use Monthly: monthly billing Yearly: yearly billing
tenant_ip_count	Integer	Parameter description: Number of tenant IP addresses. Value range: N/A.
pricing_type	String	Parameter description: Pricing type. Value range: tier: Tiered pricing. One flavor corresponds to multiple capacity options. normal: One flavor corresponds to one capacity option.
is_dec	Boolean	Parameter description: Whether to support Dedicated Cloud (DeC). Value range: true false
attrs	Array of AttrsObject objects	Parameter description: Other information about the flavor. Value range: N/A.
flavors_available_zones	Array of FlavorAzObject objects	Parameter description: AZs where there are available resources. Value range: N/A.
replica_count	Integer	Parameter description: Number of replicas. Value range: N/A.
inquery_spec_code	String	Parameter description: Product flavor code. This parameter is an internal parameter of the service and does not need to be concerned. Value range: N/A
billing_factor	String	Parameter description: Billing mode. This parameter is an internal parameter of the service and does not need to be concerned. Value range: N/A

**Table 5** AttrsObject
Parameter	Type	Description
capacity	String	Parameter description: Cache capacity (GB). Value range: 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, 1024, 2048
name	String	Parameter description: Additional information items. Value range: sharding_num: Number of shards supported by the flavor. proxy_num: Number of proxies supported by Proxy Cluster instances of the specified flavor. If the instance is not a Proxy Cluster instance, the value of this parameter is 0. db_number: Number of DBs of the flavor. max_memory: Maximum available memory. max_connections: Maximum number of connections supported by the flavor. max_clients: Maximum number of clients supported by the flavor, which is usually equal to the maximum number of connections. max_bandwidth: Maximum bandwidth supported by the flavor. max_in_bandwidth: Maximum inbound bandwidth supported by the flavor, which is usually equal to the maximum bandwidth.
value	String	Parameter description: Additional information value. Value range: N/A.

**Table 6** FlavorAzObject
Parameter	Type	Description
capacity	String	Parameter description: Cache capacity (value). Value range: 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, 1024, 2048
unit	String	Parameter description: Cache capacity (unit). Value range: GB
available_zones	Array of strings	Parameter description: AZ information. Value range: N/A.
az_codes	Array of strings	Parameter description: Codes of AZs where there are available resources. Value range: N/A.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Example Requests

GET https://{dcs_endpoint}/v2/flavors?cache_mode={cache_mode}&engine={engine}&engine_version={engine_version}&cpu_type={cpu_type}&capacity={capacity}

Example Responses

Status code: 200

Product flavors queried successfully.

{
  "flavors" : [ {
    "spec_code" : "redis.single.au1.large.1",
    "cloud_service_type_code" : "hws.resource.type.dcs3",
    "cloud_resource_type_code" : "hws.resource.type.dcs3",
    "cache_mode" : "single",
    "engine" : "redis",
    "engine_version" : "4.0;5.0",
    "product_type" : "generic",
    "cpu_type" : "aarch64",
    "storage_type" : "DRAM",
    "capacity" : [ 1 ],
    "billing_mode" : [ "Hourly", "Monthly", "Yearly" ],
    "tenant_ip_count" : 1,
    "pricing_type" : "normal",
    "is_dec" : false,
    "attrs" : [ {
      "capacity" : "1",
      "name" : "max_memory",
      "value" : "1"
    }, {
      "capacity" : "1",
      "name" : "max_connections",
      "value" : "10000"
    }, {
      "capacity" : "1",
      "name" : "sharding_num",
      "value" : "1"
    }, {
      "capacity" : "1",
      "name" : "proxy_num",
      "value" : "0"
    }, {
      "capacity" : "1",
      "name" : "db_number",
      "value" : "256"
    }, {
      "capacity" : "1",
      "name" : "max_clients",
      "value" : "10000"
    }, {
      "capacity" : "1",
      "name" : "max_bandwidth",
      "value" : "80"
    } ],
    "flavors_available_zones" : [ {
      "capacity" : "1",
      "unit" : "GB",
      "available_zones" : [ "d539378ec1314c85b76fefa3f7071458" ],
      "az_codes" : [ "region01" ]
    } ],
    "replica_count" : 1,
    "inquery_spec_code" : "redis.single.au1.large.1",
    "billing_factor" : "Duration"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;


public class ListFlavorsSolution {

    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");
        String projectId = "{project_id}";

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

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListFlavorsRequest request = new ListFlavorsRequest();
        try {
            ListFlavorsResponse response = client.listFlavors(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ListFlavorsRequest()
        response = client.list_flavors(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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")
    projectId := "{project_id}"

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

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListFlavorsRequest{}
	response, err := client.ListFlavors(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	Product flavors queried successfully.
400	Invalid request.
401	Invalid authentication information.
403	Request rejected.
404	The requested resource could not be found.
500	Internal service error.