Consulta del estado de rotación de un CMK
Función
Esta API le permite consultar el estado de rotación de un CMK.
URI
POST /v1.0/{project_id}/kms/get-key-rotation-status
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | ID del proyecto. |
Parámetros 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 de IAM (valor de X-Subject-Token en el encabezado de respuesta). |
| 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 |
| 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
| Parámetro | Tipo | Descripción |
|---|---|---|
| key_rotation_enabled | Boolean | Key rotation status. El valor predeterminado es false, lo que indica que la rotación de clave está deshabilitada. |
| rotation_interval | String | Intervalo de rotación. El valor es un entero en el rango de 30 a 365. Establezca el intervalo en función de la frecuencia con la que se utilice un CMK. Si se utiliza con frecuencia, establezca un intervalo corto; de lo contrario, establezca uno largo. |
| last_rotation_time | String | Último tiempo de rotación de calve. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). |
| number_of_rotations | Integer | Número de rotaciones de claves. |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error | Object | Mensaje de error. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Información de error. |
Código de estado: 403
| Parámetro | Tipo | Descripción |
|---|---|---|
| error | Object | Mensaje de error. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Información de error. |
Código de estado: 404
| Parámetro | Tipo | Descripción |
|---|---|---|
| error | Object | Mensaje de error. |
| 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"
} Ejemplo de respuestas
Código de estado: 200
El procesamiento de la solicitud se ha realizado correctamente.
{
"key_rotation_enabled" : true,
"rotation_interval" : 30,
"last_rotation_time" : "1501578672000",
"number_of_rotations" : 3
} 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. |
Códigos de error
Consulte Códigos de error.