Creación de una versión secreta
Función
Esta API se utiliza para crear una nueva versión de un secreto para cifrar y mantener el nuevo valor del secreto. De forma predeterminada, la última versión secreta en estado SYSCURRENT. La versión anterior está en el estado SYSPREVIOUS. Puede configurar el VersionStage para que sobrescriba la configuración predeterminada.
Restricciones
- La consola CSMS solo utiliza el campo secret_string. Para agregar un secreto binario al campo secret_binary, debe usar un SDK o API.
- Un secreto puede tener hasta 20 versiones.
- Solo puede agregar versiones a los secretos habilitados.
- Las versiones secretas se numeran v1, v2, v3, y así sucesivamente en función de su tiempo de creación.
URI
POST /v1/{project_id}/secrets/{secret_name}/versions
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
secret_name |
Sí |
String |
Nombre de secreto |
Parámetros 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 |
---|---|---|---|
secret_binary |
No |
String |
Valor de un nuevo secreto. Será encriptado y almacenado en la versión inicial del secreto. Tipo: objeto de datos binarios en formato Base64 Restricciones: Debe configurar uno y solo uno de secret_binary y secret_string. El tamaño máximo es de 32 KB. |
secret_string |
No |
String |
Valor de un nuevo secreto. Será encriptado y almacenado en la versión inicial del secreto. Restricciones: Debe configurar uno y solo uno de secret_binary y secret_string. El tamaño máximo es de 32 KB. |
version_stages |
No |
Array of strings |
Estado de una nueva versión secreta. Si no se especifica este parámetro, se utilizará la versión predeterminada SYSCURRENT. Restricción: La matriz puede contener de 1 a 12 elementos. La longitud de la etapa es de 1 a 64 bytes. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
version_metadata |
VersionMetadata object |
Estado de una versión secreta. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de una versión secreta. Un secreto no puede tener ID de versión duplicados. |
create_time |
Long |
Tiempo de creación de versiones secretas. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). |
kms_key_id |
String |
ID del KMS CMK utilizado para cifrar valores secretos. |
secret_name |
String |
Nombre de secreto |
version_stages |
Array of strings |
Estado de una versión secreta. Una etiqueta de estado solo se puede usar para una versión de cada secreto. Por ejemplo, si agrega la etiqueta de estado utilizada por la versión A a la versión B, la etiqueta se moverá de la versión A a la versión B. Si no se especifica el parámetro version_stage, el estado de la última versión será SYSCURRENT de forma predeterminada. |
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
{ "secret_string" : "secret_string" }
Ejemplo de respuesta
Código de estado: 200
La solicitud se ha realizado correctamente.
{ "version_metadata" : { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "create_time" : 1581507580000, "secret_name" : "secret-name-demo", "version_stages" : [ "pending", "used" ] } }
Código de estado
Código de estado |
Descripción |
---|---|
200 |
La solicitud se ha realizado correctamente. |
400 |
Error de solicitud. |
Códigos de error
Consulte Códigos de error.