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/ Data Encryption Workshop/ Referencia de la API/ APIs/ API de gestión de secreto/ Gestión del ciclo de vida/ Actualización de un secreto

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

Ver PDF

Actualización de un secreto

Función

Esta API se utiliza para actualizar los metadatos de un secreto especificado.

Restricciones

Esta API se puede usar para modificar solo los metadatos secretos, no el valor secreto.

URI

PUT /v1/{project_id}/secrets/{secret_name}

**Tabla 1** Parámetros de URI
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto
secret_name	Sí	String	Nombre de secreto

Parámetro de solicitud

**Tabla 2** Parámetro de header de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario. Se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta).

**Tabla 3** Parámetros de body de solicitud
Parámetro	Obligatorio	Tipo	Descripción
kms_key_id	No	String	ID del KMS CMK utilizado para cifrar valores secretos. El CMK de un secreto se puede actualizar. Las versiones secretas después de la actualización utilizan el nuevo CMK para el encriptación. Las versiones secretas antes de la actualización utilizan el antiguo CMK para el descifrado.
description	No	String	Descripción de un secreto Restricciones: el valor contiene 2048 bytes.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
secret	Secret object	Secreto

**Tabla 5** Parámetros de secreto
Parámetro	Tipo	Descripción
id	String	ID de secreto
name	String	Nombre de secreto
state	String	Estado de secreto. Su valor puede ser: ENABLED DISABLED PENDING_DELETE FROZEN
kms_key_id	String	ID del KMS CMK utilizado para cifrar valores secretos
description	String	Descripción de un secreto
create_time	Long	Tiempo de creación de secreto. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970).
update_time	Long	Hora en la que un secreto fue actualizado por última vez. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970).
scheduled_delete_time	Long	Hora en la que se eliminará un secreto según lo programado. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). Si un secreto no está en estado de Pending deletion, el valor de este parámetro es null.

Código de estado: 400

**Tabla 6** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error
error_msg	String	Descripción del error

Solicitud de ejemplo

{
  "name" : "test",
  "description" : "update description"
}

Ejemplo de respuesta

Código de estado: 200

La solicitud se ha realizado correctamente.

{
  "secret" : {
    "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "name" : "test",
    "state" : "ENABLED",
    "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
    "description" : "description",
    "create_time" : 1581507580000,
    "update_time" : 1581507580000,
    "scheduled_delete_time" : 1581507580000
  }
}