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/ APIs fuera de fecha (no disponibles pronto)/ API de gestión del ciclo de vida/ Modificación de información acerca de una instancia DCS

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

Ver PDF

Modificación de información acerca 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, 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 /v1.0/{project_id}/instances/{instance_id}

Tabla 1 describe los parámetros.

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

Solicitud

Parámetros de solicitud

Tabla 2 describe los parámetros de solicitud.

**Tabla 2** Descripción del parámetro
Parámetro	Tipo	Obligatorio	Descripción
name	String	No	Nombre de instancia de DCS. Un nombre de instancia puede contener letras, dígitos, guiones bajos (_), y guiones (-) y comienza con una letra. Cuando se crea una sola instancia a la vez, el valor de este parámetro debe ser una cadena que consta de 4 a 64 caracteres. Cuando se crea más de una instancia a la vez, el valor de este parámetro debe ser una cadena que consta de 4 a 56 caracteres. Estas instancias se nombran en el formato de "name-n", en el que n comienza desde 000 y se incrementa en 1. Por ejemplo, si crea dos instancias y establece name en dcs_demo, las dos instancias se denominan respectivamente como dcs_demo-000 y dcs_demo-001.
description	String	No	Breve descripción de la instancia DCS. Una breve descripción admite hasta 1024 caracteres. NOTA: "\" se define como un carácter de escape en la descripción de la cola. Si necesita introducir una barra inclinada hacia atrás (\) o comillas dobles (") en la descripción de la cola, escriba \\ o \".
instance_backup_policy	JSON	No	Política de copia de respaldo. Este parámetro está disponible para instancias DCS maestras/en espera y de clúster. Para obtener más información, consulte Tabla 4 y Tabla 5.
maintain_begin	String	No	Hora en la que comienza la ventana de tiempo de mantenimiento. Formato: HH:mm:ss. La hora de inicio y la hora de finalización de la ventana de tiempo de mantenimiento deben indicar el segmento de tiempo de una ventana de tiempo de mantenimiento soportada. Para obtener detalles sobre cómo consultar los segmentos de tiempo de las ventanas de tiempo de mantenimiento compatibles, consulte Consulta de ventana de tiempo de mantenimiento. La hora de inicio debe establecerse en 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, o 18:00:00. Los parámetros maintain_begin y maintain_end deben establecerse en pares. Si el parámetro maintain_begin se deja en blanco, el parámetro maintain_end también estará en blanco.
maintain_end	String	No	Tiempo en el que finaliza la ventana de tiempo de mantenimiento. Formato: HH:mm:ss. La hora de inicio y la hora de finalización de la ventana de tiempo de mantenimiento deben indicar el segmento de tiempo de una ventana de tiempo de mantenimiento soportada. Para obtener detalles sobre cómo consultar los segmentos de tiempo de las ventanas de tiempo de mantenimiento compatibles, consulte Consulta de ventana de tiempo de mantenimiento. La hora de finalización es cuatro horas más tarde que la hora de inicio. Por ejemplo, si la hora de inicio es 22:00:00, la hora de finalización es 02:00:00. Los parámetros maintain_begin y maintain_end deben establecerse en pares. Si el parámetro maintain_end se deja en blanco, el parámetro maintain_start también estará en blanco.
security_group_id	String	No	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.

Solicitud de ejemplo

URL de solicitud:

PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}

Ejemplo 1

{
    "description": "instance description"
}

Ejemplo 2

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