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/ Obtención de información de parámetros de una instancia de base de datos especificada
Actualización más reciente 2025-03-21 GMT+08:00

Obtención de información de parámetros de una instancia de base de datos especificada

Función

Esta API se utiliza para obtener información de parámetros de una instancia de base de datos especificada. Antes de invocar a esta API:

URI

GET /v3/{project_id}/instances/{instance_id}/configurations

Tabla 1 Parámetros de URI

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

Explicación:

ID de proyecto de un tenant en una región.

Para obtener este valor, consulte Obtención de un ID de proyecto.

Restricciones:

No hay

Rango de valores:

El valor puede contener 32 caracteres. Solo se permiten letras y dígitos.

Valor predeterminado:

No hay

instance_id

String

Explicación:

ID de instancia, que identifica de forma única una instancia.

Restricciones:

No hay

Rango de valores:

El valor puede contener 36 caracteres con in07 como el sufijo. Solo se permiten letras y dígitos.

Valor predeterminado:

No hay

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 valores:

≥0

Valor predeterminado:

0

limit

No

Integer

Explicación:

Número de registros que se van a consultar.

Restricciones:

El valor debe ser un número entero y no puede ser un número negativo.

Rango de valores:

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

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 del cuerpo de respuesta

Parámetro

Tipo

Descripción

configurations

ParameterConfigurationInfo object

Explicación:

Información de plantilla de parámetro de instancia.

total_count

Long

Explicación:

Número total de parámetros de instancia.

Rango de valores:

≥0

parameter_values

Array of ParameterValuesInfo objects

Explicación:

Información de parámetro de instancia.

Tabla 5 ParameterConfigurationInfo

Parámetro

Tipo

Descripción

datastore_version_name

String

Explicación:

Nombre de versión de la base de datos.

Rango de valores:

2.0

datastore_name

String

Explicación:

Nombre del motor de BD en la plantilla de parámetros.

Rango de valores:

taurus

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 valores:

No hay

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 valores:

No hay

Tabla 6 ParameterValuesInfo

Parámetro

Tipo

Descripción

name

String

Explicación:

Nombre del parámetro.

Rango de valores:

No hay

value

String

Explicación:

Valor del parámetro.

Rango de valores:

No hay

restart_required

Boolean

Explicación:

Si se requiere un reinicio.

Rango de valores:

  • false: no.
  • true: sí.

readonly

Boolean

Explicación:

Si el parámetro es de solo lectura.

Rango de valores:

  • false: no.
  • true: sí.

value_range

String

Explicación:

Rango de valores.

Rango de valores:

No hay

type

String

Explicación:

Tipo de parámetro.

Rango de valores:

  • string
  • integer
  • boolean
  • list
  • float

description

String

Explicación:

Descripción del parámetro.

Rango de valores:

No hay

Código de estado: 400

Tabla 7 Parámetros del 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 8 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Ejemplo de la solicitud

Obtención de información de parámetros de una instancia de base de datos especificada

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/configurations

Ejemplo de la respuesta

Código de estado: 200

Operación exitosa.

{
  "configurations" : {
    "datastore_version_name" : 2.0,
    "datastore_name" : "taurus",
    "created" : "2022-10-29T09:38:36+0000",
    "updated" : "2022-10-29T09:38:36+0000"
  },
  "total_count" : 125,
  "parameter_values" : [ {
    "name" : "auto_increment_increment",
    "value" : 1,
    "restart_required" : false,
    "readonly" : false,
    "value_range" : "1-65535",
    "type" : "integer",
...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
  }, {
    "name" : "auto_increment_offset",
    "value" : 1,
    "restart_required" : false,
    "readonly" : false,
    "value_range" : "1-65535",
    "type" : "integer",
...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
  } ]
}

Código de estado

Para más detalles, véase Códigos de estado.

Código de error

Para más detalles, véase Códigos de error.