Creación de una tarea programada de eliminación de secreto
Función
Esta API se utiliza para crear una tarea programada para eliminar un secreto en 7 a 30 días.
Restricciones
Si un secreto está en estado de Pending deletion, sus metadatos no se pueden actualizar y su valor no se puede ver.
URI
POST /v1/{project_id}/secrets/{secret_name}/scheduled-deleted-tasks/create
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
secret_name |
Sí |
String |
Nombre de secreto |
Parámetro 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). |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
recovery_window_in_days |
Sí |
Integer |
Crear una tarea de eliminación secreta programada y especifique el período de espera antes de la eliminación. Restricciones: El período de espera puede ser de 7 a 30 días. Valor predeterminado: 30 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
secret |
Secret object |
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
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Descripción del error |
Solicitud de ejemplo
{ "recovery_window_in_days" : 15 }
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 } }
Código de estado
Código de estado |
Descripción |
---|---|
200 |
La solicitud se ha realizado correctamente. |
400 |
Respuesta de error |
Códigos de error
Consulte Códigos de error.