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.
URI
GET /v2/{project_id}/flavors
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
spec_code |
No |
String |
Product flavor. |
cache_mode |
No |
String |
DCS instance type. The options are as follows:
|
engine |
No |
String |
Cache engine. The options are as follows:
|
engine_version |
No |
String |
Cache engine version. If the cache engine is Redis, the options are as follows:
|
cpu_type |
No |
String |
CPU architecture. The options are as follows:
Enumeration values:
|
capacity |
No |
String |
Cache capacity (GB).
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
flavors |
Array of FlavorsItems objects |
Product flavor details. |
Parameter |
Type |
Description |
---|---|---|
spec_code |
String |
Product flavor. |
cloud_service_type_code |
String |
Code of the cloud service type. |
cloud_resource_type_code |
String |
Code of the cloud resource type. |
cache_mode |
String |
DCS instance type. The options are as follows:
|
engine |
String |
Cache engine. |
engine_version |
String |
Cache engine version. If the cache engine is Redis, the value can be 4.0, or 5.0. |
product_type |
String |
Edition of DCS for Redis. Currently, only the following value is supported: generic: standard |
cpu_type |
String |
CPU architecture. The options are as follows:
|
storage_type |
String |
Storage type. Currently, only the following value is supported: DRAM: in-memory storage |
capacity |
Array of strings |
Cache capacity (GB). |
billing_mode |
Array of strings |
Billing mode. The value can be:
|
tenant_ip_count |
Integer |
Number of tenant IP addresses. |
pricing_type |
String |
Pricing type. The options are as follows:
|
is_dec |
Boolean |
Whether Dedicated Cloud (DeC) is supported. |
attrs |
Array of AttrsObject objects |
Other information about the flavor. |
flavors_available_zones |
Array of FlavorAzObject objects |
AZs where there are available resources. |
Parameter |
Type |
Description |
---|---|---|
capacity |
String |
Cache capacity (GB). |
name |
String |
Additional information items. The options are as follows:
|
value |
String |
Additional information value. |
Parameter |
Type |
Description |
---|---|---|
capacity |
String |
Cache capacity (GB). |
az_codes |
Array of strings |
AZs where there are available resources. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
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" ], "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, "az_code" : [ "cn-north-7c" ] } ] } ] }
Status code: 400
Invalid request.
{ "error_code" : "DCS.1004", "error_msg" : "Project ID does not match the token." }
Status code: 401
Invalid authentication information.
{ "error_code" : "DCS.1001", "error_msg" : "Invalid token." }
Status code: 403
The request is rejected.
{ "error_code" : "DCS.2003", "error_msg" : "This role does not have the permission to perform this operation." }
Status code: 404
The requested resource is not found.
{ "error_code" : "DCS.4001", "error_msg" : "The requested URL does not exist." }
Status code: 500
Internal service error.
{ "error_code" : "DCS.5000", "error_msg" : "Internal service error." }
Status Codes
Status Code |
Description |
---|---|
200 |
Product flavors queried successfully. |
400 |
Invalid request. |
401 |
Invalid authentication information. |
403 |
The request is rejected. |
404 |
The requested resource is not found. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.