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)> Configuración de parámetros> Obtención de parámetros de una plantilla de parámetros especificada

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

Obtención de parámetros de una plantilla de parámetros especificada

Función

Esta API se utiliza para obtener detalles de parámetros de una plantilla de parámetros especificada.

Restricciones

Esta API solo se aplica a DDS Edición de Comunidad.

URI

Formato URI
GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}
Ejemplo
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

Descripción del parámetro

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Descripción
project_id	Sí	Especifica la ID de proyecto de un inquilino en una región.
config_id	Sí	Especifica el ID de plantilla de parámetro.

Descripción del encabezado

**Tabla 2** Descripción del encabezado
Nombre	Obligatorio	Descripción
X-Auth-Token	Sí	Especifica el token de usuario obtenido del servicio IAM. Para más detalles, consulte Autenticación.
X-Language	Sí	Especifica el tipo de idioma de solicitud, como en-us. El valor no distingue entre mayúsculas y minúsculas.
Content-Type	Sí	Especifica el tipo. El valor es application o json.

Solicitudes

Ninguna

Respuestas

Descripción del parámetro

**Tabla 3** Descripción del parámetro
Nombre	Tipo	Descripción
id	String	Indica la ID de plantilla de parámetro.
name	String	Indica el nombre de la plantilla de parámetro.
datastore_version_name	String	Indica el nombre de la versión de la base de datos.
datastore_name	String	Indica el nombre de la base de datos.
description	String	Indica la descripción de la plantilla de parámetro.
created	String	Indica la hora de creación en el formato "aaaa-MM-ddTHH:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
updated	String	Tiempo de actualización en el formato "aaaa-MM-ddTHH:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
configuration_parameters	Array of Object	Indique los parámetros definidos por los usuarios basados en las plantillas de parámetros por defecto. Para más detalles, consulte Tabla 4.

**Tabla 4** descripción de la estructura de datos del campo configuration_parameters
Nombre	Tipo	Descripción
name	String	Indica el nombre del parámetro.
value	String	Indica el valor del parámetro.
description	String	Indica la descripción del parámetro.
type	String	Indica el tipo de parámetro. El valor puede ser string, integer, boolean, list, o float.
value_range	String	Indica el rango de valores del parámetro. Si el tipo es entero, el valor es 0 o 1. Si el tipo es Boolean, el valor es true o false.
restart_required	Boolean	Indique si es necesario reiniciar la instancia. Si el valor es true, es necesario reiniciar. Si el valor es false, no es necesario reiniciar.
readonly	Boolean	Indica si el grupo de parámetros es de sólo lectura. Si el valor es true, el parámetro es de sólo lectura. Si el valor false, el parámetro no es de sólo lectura.

Ejemplo de respuesta normal

{
    "id": "0acabf0e922b4477864f7c80172dd2fcpr02",
    "name": "Default-DDS-4.0-Single",
    "description": "Default parameter template for DDS-4.0-Single",
    "datastore_version_name": "4.0",
    "datastore_name": "mongodb",
    "created": "2019-08-12T13:40:05+0000",
    "updated": "2019-08-12T13:40:05+0000",
    "configuration_parameters": [
        {
            "name": "connPoolMaxConnsPerHost",
            "value": "600",
            "restart_required": true,
            "readonly": true,
            "value_range": "200-2000",
            "type": "integer",
            "description": "Maximum size of the connection pools for connections to other mongod instances."
        }
    ]
}