Querying All Instance Specifications

Description

This API is used to query all instance specifications in a specified region.

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Querying Database Specifications) before then.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/flavors?region={region}&engine_name={engine_name}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/flavors?region=ap-southeast-1&engine_name=DDS-Community

Requests

Parameter description

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
project_id	string	path	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
region	string	query	No	The region where the DB instance is deployed. The region where the DB instance is deployed. Valid value: The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.
engine_name	string	query	No	Database type The value is DDS-Community.

Responses

Parameter description

**Table 2** Parameter description
Name	Type	Description
flavors	Array of objects	DB instance specification list. For more information, see Table 3.

**Table 3** flavors field data structure description
Name	Type	Description
engine_name	String	Engine name
type	String	Node type. DDS supports the following types of nodes: mongos shard config replica single
vcpus	String	Number of vCPUs
ram	String	Memory size in GB
spec_code	String	Resource specification code Example: dds.mongodb.c6.xlarge.2.shard NOTE: dds: indicates the DDS service. dds.mongodb: indicates the DDS service. c6.xlarge.2: indicates the node specification. It is a high-memory type. shard: indicates the node type. When querying the specifications, check whether the specifications are of the same series. The specification series includes general-purpose (s6), enhanced (c3), and enhanced II (c6). Example: dds.mongodb.s6.large.4.mongos and dds.mongodb.s6.large.4.config belong to the same specification series. dds.mongodb.s6.large.4.mongos and dds.mongodb.c3.large.4.config are not of the same specification series.
az_status	Object	The status of specifications in an AZ. Its value can be any of the following: normal: indicates that the specification is on sale. unsupported: indicates that the specification is not supported. sellout: indicates that the specification is sold out.

In the example response, az1, az2, and az3 in the az_status field are example values.

Response example

{
    "flavors": [
        {
            "engine_name": "DDS-Community",
            "type": "mongos",
            "vcpus": "1",
            "ram": "4",
            "spec_code": "dds.mongodb.c6.medium.4.mongos",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        },
{
            "engine_name": "DDS-Community",
            "type": "shard",
            "vcpus": "4",
            "ram": "8",
            "spec_code": "dds.mongodb.c6.xlarge.2.shard",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        },
{
            "engine_name": "DDS-Community",
            "type": "config",
            "vcpus": "2",
            "ram": "4",
            "spec_code": "dds.mongodb.c6.large.2.config",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        },
{
            "engine_name": "DDS-Community",
            "type": "replica",
            "vcpus": "1",
            "ram": "4",
            "spec_code": "dds.mongodb.c6.medium.4.repset",
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        }
    ]
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.