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 claves/ Gestión del ciclo de vida/ Cambio de la descripción de un CMK

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

Ver PDF

Cambio de la descripción de un CMK

Función

Esta API le permite cambiar la descripción de un CMK.

Restricciones

Una clave maestra predeterminada (cuyo sufijo de alias es /default) no permite cambios de descripción.
Un CMK en estado de eliminación programada no permite cambios de descripción.

URI

POST /v1.0/{project_id}/kms/update-key-description

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

Parámetros de solicitud

**Tabla 2** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario. El token 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
key_id	Sí	String	CMK ID. Debe tener 36 bytes y coincidir con la expresión regular ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Ejemplo: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
key_description	Sí	String	Descripción de clave. Puede contener de 0 a 255 caracteres.
sequence	No	String	Número de secuencia de 36 bytes de un mensaje de solicitud. Ejemplo: 919c82d4-8046-4722-9094-35c3c6524cff

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
key_info	KeyDescriptionInfo object	Descripción de clave.

**Tabla 5** KeyDescriptionInfo
Parámetro	Tipo	Descripción
key_id	String	CMK ID.
key_description	String	Descripción de clave.

Código de estado: 400

**Tabla 6** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error	Object	Mensaje de error.

**Tabla 7** ErrorDetail
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Información de error.

Código de estado: 403

**Tabla 8** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error	Object	Mensaje de error.

**Tabla 9** ErrorDetail
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Información de error.

Código de estado: 404

**Tabla 10** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error	Object	Mensaje de error.

**Tabla 11** ErrorDetail
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Información de error.

Solicitudes de ejemplo

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "key_description" : "test"
}

Ejemplo de respuestas

Código de estado: 200

El procesamiento de la solicitud se ha realizado correctamente.

{
  "key_info" : {
    "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "key_description" : "test"
  }
}

Código de estado: 400

Parámetros de solicitud no válidos.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Código de estado: 403

Error de autenticación.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Código de estado: 404

La página solicitada no existe o no se encuentra.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Códigos de estado

Código de estado	Descripción
200	El procesamiento de la solicitud se ha realizado correctamente.
400	Parámetros de solicitud no válidos.
403	Error de autenticación.
404	La página solicitada no existe o no se encuentra.