Consulta los metadatos de una CMK, como el estado de la clave, el uso y la configuración de rotación.
Descripción de la operación
Puede consultar la información sobre la CMK 05754286-3ba2-4fa6-8d41-4323aca6**** mediante la configuración de parámetros proporcionada en este tema. La información incluye el creador, la hora de creación, el estado y el estado de protección contra eliminación de la CMK.
Para obtener más información sobre la política de acceso requerida por un usuario RAM o un rol RAM para invocar esta API, consulte Resource Access Management.
Pruébelo ahora
Test
Autorización de RAM
Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| KeyId |
string |
Sí |
El ID de la CMK. El ID debe ser único a nivel global. También puede establecer este parámetro en un alias vinculado a la CMK. Para obtener más información, consulte Resumen de alias. |
05754286-3ba2-4fa6-8d41-4323aca6**** |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
|||
| RequestId |
string |
El ID de la solicitud. |
f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f |
| KeyMetadata |
object |
Los metadatos de la CMK. |
|
| DeletionProtection |
string |
Indica si la protección contra eliminación está habilitada. Valores válidos:
|
Enabled |
| KeyId |
string |
El ID de la CMK. El ID debe ser único a nivel global. |
05754286-3ba2-4fa6-8d41-4323aca6**** |
| NextRotationDate |
string |
La hora en la que se realizará la siguiente rotación. Nota
Este parámetro se devuelve solo cuando el valor del parámetro AutomaticRotation es Enabled o Suspended. |
2021-07-06T18:22:03Z |
| KeyState |
string |
El estado de la CMK. Para obtener más información, consulte Impacto del estado de la CMK en las operaciones de la API. |
Enabled |
| RotationInterval |
string |
El intervalo para la rotación automática de claves. Unidad: segundos. Por ejemplo, si el valor es 604800s, la rotación automática de claves se realiza con un intervalo de 7 días. Nota
Este parámetro se devuelve solo cuando el valor del parámetro AutomaticRotation es Enabled o Suspended. |
31536000s |
| Arn |
string |
El nombre de recurso de Alibaba Cloud (ARN) de la CMK. |
acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6**** |
| Creator |
string |
La cuenta de Alibaba Cloud que se utiliza para crear la CMK. |
154035569884**** |
| LastRotationDate |
string |
La hora en la que se realizó la última rotación. La hora se muestra en formato UTC. Para una nueva CMK, el valor de este parámetro es la hora en la que se generó la versión inicial de la CMK. |
2021-05-20T06:34:21Z |
| DeleteDate |
string |
La hora programada para la eliminación de la CMK. La hora se muestra en formato UTC. Para obtener más información, consulte ScheduleKeyDeletion. Nota
Este parámetro se devuelve solo cuando el valor del parámetro KeyState es PendingDeletion. |
2021-05-26T18:22:03Z |
| PrimaryKeyVersion |
string |
El ID de la versión de clave principal actual para la CMK simétrica. |
515e0b0a-624f-45ab-92b5-54f9b551**** |
| Description |
string |
La descripción de la CMK. |
ejemplo de descripción de clave |
| KeySpec |
string |
El tipo de la CMK. |
Aliyun_AES_256 |
| Origin |
string |
El origen del material de clave de la CMK. |
Aliyun_KMS |
| MaterialExpireTime |
string |
La hora en la que caduca el material de clave. La hora se muestra en formato UTC. Si el valor de este parámetro está vacío, el material de clave no caduca. |
2021-07-06T18:22:03Z |
| DeletionProtectionDescription |
string |
La descripción de la protección contra eliminación. |
La CMK está siendo utilizada por XXX. La protección contra eliminación está configurada |
| AutomaticRotation |
string |
Indica si la rotación automática de claves está habilitada. Valores válidos:
Para obtener más información, consulte Rotación automática de claves. Nota
Solo las CMK simétricas admiten la rotación automática de claves. |
Disabled |
| ProtectionLevel |
string |
El nivel de protección de la CMK. |
HSM |
| KeyUsage |
string |
El uso de la CMK. |
ENCRYPT/DECRYPT |
| CreationDate |
string |
La hora en la que se creó la CMK. La hora se muestra en formato UTC. |
2021-05-20T06:34:21Z |
| DKMSInstanceId |
string |
El ID de la instancia dedicada de KMS. |
kst-bjj62d8f5e0sgtx8h**** |
Ejemplos
Respuesta exitosa
JSON Formato
{
"RequestId": "f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f",
"KeyMetadata": {
"DeletionProtection": "Enabled",
"KeyId": "key-hzz630494463ejqjx****",
"NextRotationDate": "2021-07-06T18:22:03Z",
"KeyState": "Enabled",
"RotationInterval": "31536000s",
"Arn": "acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx****",
"Creator": "154035569884****",
"LastRotationDate": "2024-05-20T06:34:21Z",
"DeleteDate": "2024-05-26T18:22:03Z",
"PrimaryKeyVersion": "515e0b0a-624f-45ab-92b5-54f9b551****",
"Description": "key description example",
"KeySpec": "Aliyun_AES_256",
"Origin": "Aliyun_KMS",
"MaterialExpireTime": "2024-07-06T18:22:03Z",
"DeletionProtectionDescription": "The CMK is being used by XXX. Deletion protection is set.",
"AutomaticRotation": "Disabled",
"ProtectionLevel": "HSM",
"KeyUsage": "ENCRYPT/DECRYPT",
"CreationDate": "2024-05-20T06:34:21Z",
"DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****"
}
}Códigos de error
|
Código de estado HTTP |
Código de error |
Mensaje de error |
Descripción |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is not valid. | An invalid value is specified for the parameter. |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | The error message returned because the specified CMK does not exist. |
| 404 | Forbidden.AliasNotFound | The specified Alias is not found. | The error message returned because the specified alias does not exist. |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. |
Consulte Códigos de error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.