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 Message Service for Kafka/ Referencia de la API/ API fuera de fecha/ API V1/ API para gestionar instancias/ Modificación de una instancia

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

Ver PDF

Modificación de una instancia

Esta API está desactualizada y es posible que no se mantenga en el futuro. Utilice la API descrita en Modificación de información de instancia.

Función

Esta API se utiliza para modificar la información de la instancia, incluido el nombre de la instancia, la descripción, la ventana de mantenimiento y el grupo de seguridad.

URI

PUT /v1.0/{project_id}/instances/{instance_id}

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

Solicitud

Parámetros de solicitud

Tabla 2 describe los parámetros.

**Tabla 2** Parámetros de solicitud
Parámetro	Tipo	Obligatorio	Descripción
name	String	No	Indica el nombre de instancia. Un nombre de instancia consta de 4 a 64 caracteres incluyendo letras, dígitos y guiones (-) y debe comenzar con una letra.
description	String	No	Indica la descripción de una instancia. Es una string de caracteres que no contiene más de 1024 caracteres. NOTA: La barra invertida (\) y las comillas (") son caracteres especiales para los paquetes JSON. Cuando utilice estos caracteres en un valor de parámetro, agregue el carácter de escape (\) antes de estos caracteres, por ejemplo, \\ Y \".
maintain_begin	String	No	Indica la hora en la que se inicia una 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 compatible. Para obtener detalles sobre cómo consultar los segmentos de tiempo de las ventanas de tiempo de mantenimiento compatibles, consulte Consulta de ventanas 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 se deja en blanco. En este caso, el sistema establece automáticamente la hora de inicio en 02:00:00.
maintain_end	String	No	Indica la hora en la que finaliza una 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 compatible. Para obtener detalles sobre cómo consultar los segmentos de tiempo de las ventanas de tiempo de mantenimiento compatibles, consulte Consulta de ventanas 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_end también se deja en blanco. En este caso, el sistema establece automáticamente la hora de finalización en 06:00:00.
security_group_id	String	No	Indica el ID del grupo de seguridad.
retention_policy	String	No	Indica la política de umbral de capacidad. Opciones: produce_reject: No se pueden crear nuevos mensajes. time_base: Se eliminan los primeros mensajes.
enterprise_project_id	String	No	Indica el ID del proyecto de empresa.

Solicitud de ejemplo

Ejemplo 1:

PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{  
    "name": "dms002",  
    "description": "instance description"  
}

Ejemplo 2:

PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{ 
     "name": "dms002",   
     "description": "instance description", 
     "maintain_begin":"02:00:00", 
     "maintain_end":"06:00:00" 
}