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> APIs V2 (Recomendado)> Gestión del ciclo de vida> Modificación de información de instancia
Actualización más reciente 2022-11-07 GMT+08:00
Ver PDF

Modificación de información de instancia

Función

Esta API se utiliza para modificar el nombre y la descripción de una instancia.

URI

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

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto.

instance_id

Sí

String

ID de instancia.

Parámetros de solicitud

Tabla 2 Parámetros del cuerpo de solicitud

Parámetro

Obligatorio

Tipo

Descripción

name

No

String

Nombre de instancia.

Un nombre de instancia comienza con una letra, consta de 4 a 64 caracteres y solo puede contener letras, dígitos, guiones bajos (_) y guiones (-).

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 ".

maintain_begin

No

String

Hora en la que 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 tiempo de mantenimiento deben indicar el segmento de tiempo de una ventana de tiempo de mantenimiento compatible.
  • 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.
  • 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. En este caso, el sistema establece automáticamente la hora de inicio en 02:00:00.

maintain_end

No

String

Hora en la que finaliza 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 tiempo de mantenimiento deben indicar el segmento de tiempo de una ventana de tiempo de mantenimiento compatible.
  • 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.
  • 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. En este caso, el sistema establece automáticamente la hora de finalización en 06:00:00.

security_group_id

No

String

ID del grupo de seguridad.

retention_policy

No

String

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

No

String

Proyecto empresarial.

Parámetros de respuesta

Ninguno

Solicitudes de ejemplo

  • Modificación del nombre y la descripción de una instancia.
    PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}

{
  "name" : "kafka001",
  "description" : "kafka description"
}
  • Modificación del nombre, la descripción y la ventana de tiempo de mantenimiento de una instancia.
    PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}

{
  "name" : "dms002",
  "description" : "instance description",
  "maintain_begin" : "02:00:00",
  "maintain_end" : "06:00:00"
}
  • Cambio de la política de umbral de capacidad.
    PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}

{
  "retention_policy" : "time_base"
}

Respuestas de ejemplo

Ninguno

Códigos de estado

Código de estado

Descripción

204

La información de instancia se modifica correctamente.

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión del ciclo de vida