Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda> Document Database Service> Referencia de la API> APIs V3.0 (recomendado)> Consulta de especificaciones de base de datos

Actualización más reciente 2022-11-07 GMT+08:00

Consulta de especificaciones de base de datos

Descripción de la API

Esta API se utiliza para consultar todas las especificaciones de instancia bajo una condición especificada.

Depuración

Puede depurar esta API en Explorador de API.

URI

Formato URI
GET https://{Endpoint}/v3.1/{project_id}/flavors?engine_name={engine_name}&engine_version={engine_version}&offset={offset}&limit={limit}
Ejemplo de URI
https://dds.ap-southeast-1.myhuaweicloud.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/flavors?engine_name=DDS-Community&engine_version=3.4&offset=1&limit=20

Solicitudes

Parámetros de solicitud

**Tabla 1** Descripción del parámetro
Nombre	Tipo	IN	Obligatorio	Descripción
x-auth-token	string	header	Sí	Token de usuario
project_id	string	path	Sí	Especifique el ID de proyecto de un inquilino en una región. Para obtener un ID de proyecto, consulte Obtención de un ID de proyecto.
engine_name	string	query	No	Especifica el tipo de base de datos. El valor es DDS-Community. Para obtener este valor, consulte Consulta de información de la versión de la base de datos.
engine_version	string	query	No	Número de versión de la base de datos.
offset	Integer	query	No	Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor predeterminado es 0, que indica que la consulta comienza desde el primer dato. El valor debe ser un número positivo.
limit	Integer	query	No	Máximo pedazos de información de especificaciones que se pueden consultar El valor varía de 1 a 100. Si este parámetro no se transfiere, las primeras 100 piezas de información de especificación pueden consultarse por defecto.

Respuestas

Descripción del parámetro

**Tabla 2** Descripción del parámetro
Nombre	Tipo	Obligatorio	Descripción
flavors	Array of objects	Sí	Indica la lista de información de especificaciones de instancia de base de datos. Para obtener más información, consulte Tabla 3.
total_count	Integer	Sí	Número total de registros

**Tabla 3** descripción de la estructura de datos de campo de variante
Nombre	Tipo	Obligatorio	Descripción
engine_name	String	Sí	Indica el nombre del motor.
type	String	Sí	Indica el tipo de nodo. DDS contiene los siguientes tipos de nodos: mongos shard config replica single readonly
vcpus	String	Sí	Indica el número de vCPU.
ram	String	Sí	Indica el tamaño de memoria en gigabyte (GB).
spec_code	String	Sí	Indica el código de especificación de recurso. Ejemplo: dds.mongodb.c6.xlarge.2.shard NOTA: dds: indica el servicio DDS. dds.mongodb: indica el servicio DDS. c6.xlarge.2: indica la especificación del nodo. Es un tipo de memoria alta. shard: indica el tipo de nodo. Cuando consulte las especificaciones, compruebe si las especificaciones son de la misma serie. La serie de especificaciones incluye el propósito general (s6), mejorado (c3) y mejorado II (c6). Ejemplo: dds.mongodb.s6.large.4.mongos y dds.mongodb.s6.large.4.config tienen las mismas especificaciones. dds.mongodb.s6.large.4.mongos y dds.mongodb.c3.large.4.config no tienen las mismas especificaciones.
az_status	Map<String,String>	Sí	key indica el ID de zona de disponibilidad, y value indica el estado de la especificación en el zona de disponibilidad. Su valor puede ser cualquiera de los siguientes: normal: La especificación está a la venta. unsupported: esta especificación no es compatible. sellout: La especificación está agotada.
engine_versions	Array of strings	Sí	Versiones de base de datos Por ejemplo, DDS mongos node, {"3.4", "4.0"}

En la respuesta de ejemplo, az1, az2,y az3 en el campo az_status son valores de ejemplo.

Ejemplo de respuesta

{
    "total_count":4,
    "flavors": [
        {
            "engine_name": "DDS-Community",
            "type": "mongos",
            "vcpus": "1",
            "ram": "4",
            "spec_code": "dds.mongodb.c6.medium.4.mongos",
            "engine_versions":["3.4","4.0"],
            "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",
            "engine_versions":["3.4","4.0"],
            "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",
            "engine_versions":["3.4","4.0"],
            "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",
            "engine_versions":["3.4","4.0"],
            "az_status": {
                "az1": "normal",
                "az2": "normal",
                "az3": "normal"
            }
        }
    ]
}

SDK

Haga clic en Document Database Service DDS SDK para descargar el SDK o ver el documento del SDK. Para saber cómo instalar y autenticar un SDK, lea la sección Usage.