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/ GaussDB(for MySQL)/ Referencia de la API/ Las API (recomendadas)/ Gestión de plantillas de parámetros/ Consulta de plantillas de parámetros

Actualización más reciente 2023-12-14 GMT+08:00

Ver PDF

Consulta de plantillas de parámetros

Función

Esta API se utiliza para consultar plantillas de parámetros, incluidas las plantillas de parámetros predeterminadas y personalizadas de todas las bases de datos. Antes de invocar a esta API:

Aprender cómo autorizar y autenticarla.
Obtener los región y punto de conexión requeridos.

URI

GET /v3/{project_id}/configurations

**Tabla 1** Parámetros de URI
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto.

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
offset	No	Integer	Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor es 0 de forma predeterminada, lo que indica que la consulta comienza desde el primer dato. El valor no puede ser un número negativo.
limit	No	Integer	Número de registros a consultar. El valor predeterminado es 100. El valor debe ser un número positivo entero. El valor mínimo es de 1 y el valor máximo de 100.

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario.
X-Language	No	String	Idioma.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
configurations	Array of ConfigurationSummary objects	Información de la plantilla de parámetros.
total_count	Integer	Número total de plantillas de parámetros.

**Tabla 5** ConfigurationSummary
Parámetro	Tipo	Descripción
id	String	ID de plantilla de parámetro.
name	String	Nombre de la plantilla del parámetro.
description	String	Descripción de la plantilla de parámetros.
datastore_version_name	String	Versión del motor
datastore_name	String	Nombre del motor.
created	String	Tiempo de creación en el formato "yyyy-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 la zona horaria se muestra como +0800.
updated	String	Tiempo de actualización en el formato "yyyy-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 la zona horaria se muestra como +0800.
user_defined	Boolean	Si la plantilla de parámetro es una plantilla personalizada. false: La plantilla de parámetro es una plantilla predeterminada. true: La plantilla de parámetro es una plantilla personalizada.

Código de estado: 400

**Tabla 6** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Código de estado: 500

**Tabla 7** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Solicitud de ejemplo

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations

Ejemplo de respuesta

Código de estado: 200

Success.

{
  "total_count" : 1,
  "configurations" : [ {
    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
    "name" : "configuration_test",
    "description" : "configuration_test",
    "datastore_version_name" : "8.0",
    "datastore_name" : "GaussDB(for MySQL)",
    "created" : "2019-05-15T11:53:34+0000",
    "updated" : "2019-05-15T11:53:34+0000",
    "user_defined" : true
  }, {
    "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07",
    "name" : "Default-GaussDBforMySQL",
    "description" : "Default parameter template for GaussDBforMySQL",
    "datastore_version_name" : "8.0",
    "datastore_name" : "GaussDB(for MySQL)",
    "created" : "2019-05-27T03:38:51+0000",
    "updated" : "2019-05-27T03:38:51+0000",
    "user_defined" : false
  } ]
}