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> Creación de una plantilla de parámetros

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

Creación de una plantilla de parámetros

Función

Esta API se utiliza para crear una plantilla de parámetros y configurar el nombre, la descripción, el motor de base de datos y los valores de parámetros en la plantilla de parámetros.

Restricciones

Esta API solo se aplica a DDS edición de comunidad.
El nombre de la plantilla de parámetros personalizada distingue entre mayúsculas y minúsculas y debe ser diferente del nombre de una plantilla de parámetros existente o predeterminada.
Los valores de parámetros de la plantilla de parámetros personalizada deben estar dentro del rango de parámetros predeterminado de la versión de base de datos especificada.

URI

Formato URI
POST https://{Endpoint}/v3/{project_id}/configurations
Ejemplo
https://dds.ap-southeast-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/configurations

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.

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	No	Especifica el tipo de idioma de solicitud, como en-us. El valor es insensible a mayúsculas y minúsculas.
Content-Type	Sí	Especifica el tipo. El valor es application o json.

Solicitudes

Descripción del parámetro

**Tabla 3** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
name	Sí	String	Nombre de plantilla de parámetro Contiene un máximo de 64 caracteres y puede contener solo letras, dígitos, guiones (-) guiones bajos (_), y puntos (.).
description	No	String	Descripción de la plantilla de parámetros. Contiene un máximo de 256 caracteres, excepto los siguientes caracteres especiales: >!<"&'= Este parámetro se deja en blanco de forma predeterminada.
values	No	Object	Objeto de valor de parámetro. Puede personalizar los valores de los parámetros en función de los parámetros de la plantilla de parámetros predeterminada. Para más detalles, consulte Tabla 5.
datastore	Sí	Object	Especifica el objeto de base de datos. Para más detalles, consulte Tabla 4.

**Tabla 4** descripción de la estructura de datos del campo del almacén de datos
Nombre	Obligatorio	Tipo	Descripción
node_type	Sí	String	Tipo de nodo de la plantilla de parámetro. Valor válido: query_router indica el tipo de nodo mongos. member indica el tipo de nodo de shard. config_server indica el tipo de nodo de config. replica indica el tipo de conjunto de réplicas. single indica el tipo de nodo único.
version	Sí	String	Especifica la versión de la base de datos. El valor puede ser 3.2, 3.4, o 4.0.

**Tabla 5** descripción de la estructura de datos del campo de valores
Nombre	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica el nombre del parámetro. Por ejemplo, el valor clave del parámetro cursorTimeoutMillis es cursorTimeoutMillis.
value	Sí	String	Especifica el nombre del parámetro. Por ejemplo, si el valor de cursorTimeoutMillis es 600000, el valor de value es 600000.

Ejemplo de solicitud

{
    "name": "Shard-3.4-tmpl-Lenn",
    "description": "Shard 3.4 of lenn",
    "datastore": {
        "node_type": "member",
        "version": "3.4"
    },
    "values": {
        "cursorTimeoutMillis": "600001"
    }
}

Respuestas

Descripción del parámetro

**Tabla 6** Descripción del parámetro
Nombre	Tipo	Descripción
configuration	Object	Información de la plantilla de parámetros. Para más detalles, consulte Tabla 7.

**Tabla 7** descripción de la estructura de datos del campo de configuración
Nombre	Tipo	Descripción
id	String	ID de plantilla de parámetro
name	String	Nombre de plantilla de parámetro
description	String	Descripción de la plantilla de parámetros.
datastore_version_name	String	Versión de la base de datos
datastore_name	String	Nombre de la base de datos
created	String	Tiempo de creación en el formato "aaaa-MM-ddTHH:mm:ss". 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.

Ejemplo de respuesta normal

{
"configuration": {
"id": "e947612e969b46f9b87c0a33974319bapr02",
"name": "Shard-3.4-tmpl-Lenn",
"description": "Shard 3.4 of lenn",
"datastore_version_name": "3.4",
"datastore_name": "mongodb",
"created": "2021-04-19T03:29:20+0000",
"updated": "2021-04-19T03:29:20+0000"
}
}