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> Distributed Cache Service> Referencia de la API> API V2> Gestión del ciclo de vida> Modificación de detalles de una instancia DCS

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

Ver PDF

Modificación de detalles de una instancia DCS

Función

Esta API se utiliza para modificar la información sobre una instancia de DCS, incluido el nombre de la instancia, la descripción, el puerto, la política de copia de respaldo, la hora de inicio y finalización de la ventana de mantenimiento y el grupo de seguridad.

URI

PUT /v2/{project_id}/instances/{instance_id}

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
instance_id	Sí	String	ID de instancia.
project_id	Sí	String	ID del proyecto.

Parámetros de solicitud

**Tabla 2** Parámetros de body de solicitud
Parámetro	Obligatorio	Tipo	Descripción
name	No	String	Nombre de instancia. Un nombre de instancia puede contener letras, dígitos, guiones bajos (_), y guiones (-) y debe comenzar con una letra. Cuando se crea una sola instancia a la vez, el valor de este parámetro puede contener entre 4 y 64 caracteres. Cuando se crean varias instancias a la vez, el valor de este parámetro puede contener entre 4 y 56 caracteres. Las instancias se nombran en el formato custom name-n, donde n comienza en 000 y se incrementa en 1. Por ejemplo, si crea dos instancias y establece el nombre personalizado en dcs_demo, las dos instancias se denominan respectivamente dcs_demo-000 y dcs_demo-001.
description	No	String	Descripción de la instancia. La descripción puede contener un máximo de 1024 caracteres. NOTA: La barra invertida (\) y las comillas () son caracteres especiales para los mensajes JSON. Cuando utilice estos caracteres en un valor de parámetro, agregue el carácter de escape (\) antes de los caracteres, por ejemplo, \\ y \". Mínimo: 0 Máximo: 1024
port	No	Integer	Cambie el puerto para conectarse a la instancia en Redis. El rango de puertos es de 1 a 65535. Después de cambiar el puerto, todas las conexiones a la instancia de Redis se interrumpen y los servicios deben conectarse al nuevo puerto. Solo las instancias de DCS Redis 4.0 y 5.0 admiten el cambio de puerto. Mínimo: 1 Máximo: 65535
rename_commands	No	RenameCommandResp object	Lista de cambio de nombre de comandos.
maintain_begin	No	String	Hora UTC cuando comienza la ventana de tiempo de mantenimiento. El formato es HH:mm:ss. ' La hora de inicio y la hora de finalización de la ventana de mantenimiento deben estar dentro del segmento de tiempo de una ventana de mantenimiento compatible. Para más detalles, consulte Listado de tiempo de mantenimiento de Windows. Por ejemplo, la hora de inicio debe ser 18:00:00, 19:00:00, etc. La hora de inicio y la hora de finalización deben establecerse en pares. Si la hora de inicio se deja en blanco, la hora de finalización también debe dejarse en blanco.
maintain_end	No	String	Hora UTC cuando comienza la ventana de tiempo de mantenimiento. El formato es HH:mm:ss. ' La hora de inicio y la hora de finalización de la ventana de mantenimiento deben estar dentro del segmento de tiempo de una ventana de mantenimiento compatible. Para más detalles, consulte Listado de tiempo de mantenimiento de Windows. La hora de finalización es una hora más tarde que la hora de inicio. Por ejemplo, si la hora de inicio es 18:00:00, la hora de finalización es 19:00:00. La hora de inicio y la hora de finalización deben establecerse en pares. Si la hora de finalización se deja en blanco, la hora de inicio también se deja en blanco.
security_group_id	No	String	ID del grupo de seguridad. El valor se puede obtener de la consola de VPC o de la API. Este parámetro sólo es compatible con instancias de DCS en Redis 3.0.
instance_backup_policy	No	BackupPolicy object	Política de copia de respaldo. Este parámetro se admite cuando el tipo de instancia es maestro/en espera o clúster.

**Tabla 3** RenameCommandResp
Parámetro	Obligatorio	Tipo	Descripción
command	No	String	Comando COMMAND.
flushall	No	String	Comando FLUSHALL.
flushdb	No	String	Comando FLUSHDB.
hgetall	No	String	Comando HGETALL.
keys	No	String	Commando KEYS.

**Tabla 4** BackupPolicy
Parámetro	Obligatorio	Tipo	Descripción
backup_type	Sí	String	Tipo de copia de respaldo. auto: copia de respaldo automática manual: copia de respaldo manual
save_days	No	Integer	Este parámetro es obligatorio cuando backup_type se establece en manual. Período de retención, en días. Los valores varían de 1 a 7.
periodical_backup_plan	No	BackupPlan object	Programa de copia de respaldo. Este parámetro es obligatorio cuando backup_type se establece en manual.

**Tabla 5** BackupPlan
Parámetro	Obligatorio	Tipo	Descripción
timezone_offset	No	String	Zona horaria en la que se realiza la copia de respaldo. Este parámetro ya no se utiliza.
backup_at	Sí	Array of integers	Día en una semana en el que comienza la copia de respaldo. El valor varía de 1 a 7, donde 1 indica lunes y 7 indica domingo.
period_type	Sí	String	Intervalo en el que se realiza la copia de respaldo, que solo admite weekly actualmente.
begin_at	Sí	String	Hora UTC cuando se inicia la copia de respaldo. Por ejemplo, 00:00-01:00 indica que la copia de respaldo comienza a las 08:00 (GMT+8).

Parámetros de respuesta

Ninguno

Solicitudes de ejemplo

PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}

{
  "name" : "dcs002",
  "description" : "instance description",
  "port" : 6379,
  "maintain_begin" : "18:00:00",
  "maintain_end" : "19:00:00",
  "security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162",
  "instance_backup_policy" : {
    "backup_type" : "auto",
    "save_days" : "1,",
    "periodical_backup_plan" : {
      "backup_at" : [ "1", "2", "3", "4", "6", "7" ],
      "period_type" : "weekly",
      "begin_at" : "00:00-01:00"
    }
  }
}