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 instancias/ Cambio de una descripción de instancia de base de datos
Actualización más reciente 2025-03-21 GMT+08:00
Ver PDF
Compartir

Cambio de una descripción de instancia de base de datos

Función

Esta API se utiliza para cambiar una descripción de instancia de BD. Antes de invocar a esta API:

URI

PUT /v3/{project_id}/instances/{instance_id}/alias

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.

instance_id

Sí

String

ID de instancia, que es compatible con el formato UUID.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Token de usuario.

Para obtener este valor, invoque a la API de IAM para obtener un token de usuario.

El valor de X-Subject-Token en el encabezado de respuesta es el valor del token.

X-Language

No

String

Tipo de idioma de solicitud. El valor predeterminado es en-us.

Valores:

  • en-us
  • zh-cn
Tabla 3 Parámetro del cuerpo de la solicitud

Parámetro

Obligatorio

Tipo

Descripción

alias

Sí

String

Descripción de la instancia.

El valor puede contener de 0 a 64 caracteres, incluidos letras, dígitos, puntos (.), guiones bajos (_), y guiones (-).

Parámetros de respuesta

Código de estado: 400

Tabla 4 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 5 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

Cambio de la descripción de una instancia de BD a Test_alias

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/alias
{
  "alias" : "Test_alias"
}

Ejemplo de respuesta

Código de estado: 200

Operación exitosa.

{ }

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.

Tema principal: Gestión de instancias