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 plantillas de parámetros

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

Obtención de plantillas de parámetros

Función

Esta API se utiliza para obtener plantillas de parámetros, incluidas las plantillas de parámetros predeterminadas de todas las bases de datos y las plantillas de parámetros creadas por el usuario.

Restricciones

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

URI

Formato URI
GET https://{Endpoint}/v3/{project_id}/configurations
Ejemplo
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/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 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
count	Integer	Indica el número total de registros.
configurations	Indica la estructura de datos de la lista. Para más detalles, consulte Tabla 4.	Indica la lista de plantillas de parámetros.

**Tabla 4** descripción de la estructura de datos del campo de configuraciones
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.
description	String	Indica la descripción 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.
created	String	Indica la hora 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.
user_defined	Boolean	Indica si la plantilla de parámetro la crean los usuarios. false: La plantilla de parámetros es una plantilla de parámetros por defecto. true: La plantilla de parámetro es una plantilla personalizada.

Ejemplo de respuesta normal

{
    "count": 15,
    "configurations": [
        {
            "id": "f63649ce5cf04520b933f382e2ecb4cbpr02",
            "name": "Default-DDS-4.0-Config",
            "description": "Default parameter template for DDS-4.0-Config",
            "datastore_version_name": "4.0",
            "datastore_name": "mongodb",
            "created": "2019-08-12T13:40:05+0000",
            "updated": "2019-08-12T13:40:05+0000",
            "user_defined": false
        },
        {
            "id": "0764fdcd949b411ba76c2b762b80c212pr02",
            "name": "Default-DDS-4.0-Replica",
            "description": "Default parameter template for DDS-4.0-Replica",
            "datastore_version_name": "4.0",
            "datastore_name": "mongodb",
            "created": "2019-08-12T13:40:05+0000",
            "updated": "2019-08-12T13:40:05+0000",
            "user_defined": false
        },
        {
            "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",
            "user_defined": false
        },
        {
            "id": "8d906cd03bsd4aff81cd41c4c6a22sc3pr02",
            "name": "Default-MongoDB-3.2-Single",
            "description": "Default parameter template for MongoDB-3.2-Single",
            "datastore_version_name": "3.2",
            "datastore_name": "mongodb",
            "created": "2018-06-15T10:07:47+0000",
            "updated": "2018-06-15T10:07:47+0000",
            "user_defined": false
        },
        {
            "id": "d91dfc76e53e4133adf6f5e43c1a5c37pr02",
            "name": "Default-DDS-3.2-Shard",
            "description": "Default parameter template for DDS-3.2-Shard",
            "datastore_version_name": "3.2",
            "datastore_name": "mongodb",
            "created": "2018-06-15T10:07:47+0000",
            "updated": "2018-06-15T10:07:47+0000",
            "user_defined": false
        },
        {
            "id": "eb5e1b9b0089432e98e77d42fba68d10pr02",
            "name": "Default-DDS-3.2-Config",
            "description": "Default parameter template for DDS-3.2-Config",
            "datastore_version_name": "3.2",
            "datastore_name": "mongodb",
            "created": "2018-06-15T10:07:47+0000",
            "updated": "2018-06-15T10:07:47+0000",
            "user_defined": false
        },
        {
            "id": "0764fdcd949b411ba76c2b726b80c212pr02",
            "name": "Default-DDS-3.4-Replica",
            "description": "Default parameter template for DDS-3.4-Replica",
            "datastore_version_name": "3.4",
            "datastore_name": "mongodb",
            "created": "2019-07-09T09:06:48+0000",
            "updated": "2019-07-09T09:06:48+0000",
            "user_defined": false
        },
        {
            "id": "1f7c3b2e62184fd2aa14e25a93579e25pr02",
            "name": "Default-DDS-4.0-Shard",
            "description": "Default parameter template for DDS-4.0-Shard",
            "datastore_version_name": "4.0",
            "datastore_name": "mongodb",
            "created": "2019-08-12T13:40:05+0000",
            "updated": "2019-08-12T13:40:05+0000",
            "user_defined": false
        },
        {
            "id": "1c5faa0e73f14d499c2d1b049d7e82c6pr02",
            "name": "Default-DDS-3.4-Mongos",
            "description": "Default parameter template for DDS-3.4-Mongos",
            "datastore_version_name": "3.4",
            "datastore_name": "mongodb",
            "created": "2019-07-09T09:06:48+0000",
            "updated": "2019-07-09T09:06:48+0000",
            "user_defined": false
        },
        {
            "id": "1f7c3b2e62184fd2aa14e25a93597e25pr02",
            "name": "Default-DDS-3.4-Shard",
            "description": "Default parameter template for DDS-3.4-Shard",
            "datastore_version_name": "3.4",
            "datastore_name": "mongodb",
            "created": "2019-07-09T09:06:48+0000",
            "updated": "2019-07-09T09:06:48+0000",
            "user_defined": false
        },
        {
            "id": "f63649ce5cf04520b933f328e2ecb4cbpr02",
            "name": "Default-DDS-3.4-Config",
            "description": "Default parameter template for DDS-3.4-Config",
            "datastore_version_name": "3.4",
            "datastore_name": "mongodb",
            "created": "2019-07-09T09:06:48+0000",
            "updated": "2019-07-09T09:06:48+0000",
            "user_defined": false
        },
        {
            "id": "0acabf0e922b4477864f7c80712dd2fcpr02",
            "name": "Default-DDS-3.4-Single",
            "description": "Default parameter template for DDS-3.4-Single",
            "datastore_version_name": "3.4",
            "datastore_name": "mongodb",
            "created": "2019-07-09T09:06:48+0000",
            "updated": "2019-07-09T09:06:48+0000",
            "user_defined": false
        },
        {
            "id": "6a906cd03be84aff81cd41c4c6a229e0pr02",
            "name": "Default-DDS-3.2-Replica",
            "description": "Default parameter template for DDS-3.2-Replica",
            "datastore_version_name": "3.2",
            "datastore_name": "mongodb",
            "created": "2018-07-18T07:51:58+0000",
            "updated": "2018-07-18T07:51:58+0000",
            "user_defined": false
        },
        {
            "id": "10781210cadf4a78b91648093bdcdb51pr02",
            "name": "Default-DDS-3.2-Mongos",
            "description": "Default parameter template for DDS-3.2-Mongos",
            "datastore_version_name": "3.2",
            "datastore_name": "mongodb",
            "created": "2018-06-15T10:07:47+0000",
            "updated": "2018-06-15T10:07:47+0000",
            "user_defined": false
        },
        {
            "id": "1c5faa0e73f14d499c2d1b049d7e28c6pr02",
            "name": "Default-DDS-4.0-Mongos",
            "description": "Default parameter template for DDS-4.0-Mongos",
            "datastore_version_name": "4.0",
            "datastore_name": "mongodb",
            "created": "2019-08-12T13:40:05+0000",
            "updated": "2019-08-12T13:40:05+0000",
            "user_defined": false
        }
    ]
}