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/ TaurusDB/ 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 2025-03-21 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.
Obtenga la región y el 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	Explicación: ID de proyecto de un tenant en una región. Para obtener este valor, vea Obtención de un ID de proyecto. Restricciones: Ninguna Rango de valor: El valor puede contener 32 caracteres. Solo se permiten letras y dígitos. Valor predeterminado: Ninguno

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
offset	No	Integer	Explicación: Desplazamiento de índice. La consulta comienza a partir de la siguiente pieza de datos indexada por este parámetro. Restricciones: El valor debe ser un número entero y no puede ser un número negativo. Rango de valor: ≥0 Valor predeterminado: 0
limit	No	Integer	Explicación: Número de registros a consultar. Restricciones: El valor debe ser un número entero y no puede ser un número negativo. Rango de valor: 1–100 Valor predeterminado: 100

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Explicación: Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. Restricciones: Ninguna Rango de valor: Ninguna Valor predeterminado: Ninguna
X-Language	No	String	Explicación: Tipo de idioma de solicitud. Restricciones: Ninguna Rango de valor: en-us zh-cn Valor predeterminado: en-us

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de cuerpo de respuesta
Parámetro	Tipo	Descripción
configurations	Array of ConfigurationSummary objects	Explicación: Información de la plantilla de parámetros.
total_count	Integer	Explicación: Número total de plantillas de parámetros. Rango de valor: ≥0

**Tabla 5** ConfigurationSummary
Parámetro	Tipo	Descripción
id	String	Explicación: ID de plantilla de parámetro. Rango de valor: El valor puede contener 36 caracteres, comenzando con un UUID y terminando con pr07. Solo se permiten letras y dígitos.
name	String	Explicación: Nombre de la plantilla del parámetro. Rango de valor: Ninguno
datastore_version_name	String	Explicación: Versión de base de datos. Rango de valor: 8.0
datastore_name	String	Explicación: Nombre de la base de datos. Rango de valor: GaussDB(for MySQL)
created	String	Explicación: Hora en la que se creó la plantilla de parámetro. El formato es "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, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. Rango de valor: Ninguno
updated	String	Explicación: Hora en la que se actualizó la plantilla de parámetros. El formato es "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, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. Rango de valor: Ninguno
user_defined	Boolean	Explicación: Si la plantilla de parámetro es una plantilla personalizada. Rango de valor: false: La plantilla de parámetro es una plantilla predeterminada. true: La plantilla de parámetro es una plantilla personalizada.
description	String	Explicación: Descripción de la plantilla de parámetros. Rango de valor: Ninguno

Código de estado: 400

**Tabla 6** Parámetros de cuerpo 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 cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Solicitud de ejemplo

Consulta de plantillas de parámetros

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

Ejemplo de respuesta

Código de estado: 200

Operación exitosa.

{
  "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
  } ]
}