Consulte les métadonnées d'une CMK, telles que l'état de la clé, l'utilisation et la configuration de rotation.
Description de l'opération
Vous pouvez consulter les informations sur la CMK 05754286-3ba2-4fa6-8d41-4323aca6**** en utilisant les paramètres fournis dans cette rubrique. Ces informations incluent le créateur, l'heure de création, l'état et l'état de la protection contre la suppression de la CMK.
Pour plus d'informations sur la stratégie d'accès requise par un utilisateur RAM ou un rôle RAM pour appeler cette API, consultez Resource Access Management.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Test
Autorisation RAM
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| KeyId |
string |
Oui |
L'identifiant de la CMK. L'identifiant doit être unique au niveau mondial. Vous pouvez également définir ce paramètre sur un alias lié à la CMK. Pour plus d'informations, consultez Présentation des alias. |
05754286-3ba2-4fa6-8d41-4323aca6**** |
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
|||
| RequestId |
string |
L'identifiant de la requête. |
f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f |
| KeyMetadata |
object |
Les métadonnées de la CMK. |
|
| DeletionProtection |
string |
Indique si la protection contre la suppression est activée. Valeurs valides :
|
Enabled |
| KeyId |
string |
L'identifiant de la CMK. L'identifiant doit être unique au niveau mondial. |
05754286-3ba2-4fa6-8d41-4323aca6**** |
| NextRotationDate |
string |
L'heure à laquelle la prochaine rotation sera effectuée. Remarque
Ce paramètre n'est renvoyé que lorsque la valeur du paramètre AutomaticRotation est Enabled ou Suspended. |
2021-07-06T18:22:03Z |
| KeyState |
string |
L'état de la CMK. Pour plus d'informations, consultez Impact de l'état de la CMK sur les opérations d'API. |
Enabled |
| RotationInterval |
string |
L'intervalle de rotation automatique des clés. Unité : secondes. Par exemple, si la valeur est 604800s, la rotation automatique des clés est effectuée à un intervalle de 7 jours. Remarque
Ce paramètre n'est renvoyé que lorsque la valeur du paramètre AutomaticRotation est Enabled ou Suspended. |
31536000s |
| Arn |
string |
Le nom de ressource Alibaba Cloud (ARN) de la CMK. |
acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6**** |
| Creator |
string |
Le compte Alibaba Cloud utilisé pour créer la CMK. |
154035569884**** |
| LastRotationDate |
string |
L'heure à laquelle la dernière rotation a été effectuée. L'heure est affichée en UTC. Pour une nouvelle CMK, la valeur de ce paramètre correspond à l'heure de génération de la version initiale de la CMK. |
2021-05-20T06:34:21Z |
| DeleteDate |
string |
L'heure à laquelle la suppression de la CMK est planifiée. L'heure est affichée en UTC. Pour plus d'informations, consultez ScheduleKeyDeletion. Remarque
Ce paramètre n'est renvoyé que lorsque la valeur du paramètre KeyState est PendingDeletion. |
2021-05-26T18:22:03Z |
| PrimaryKeyVersion |
string |
L'identifiant de la version actuelle de la clé principale pour la CMK symétrique. |
515e0b0a-624f-45ab-92b5-54f9b551**** |
| Description |
string |
La description de la CMK. |
exemple de description de clé |
| KeySpec |
string |
Le type de la CMK. |
Aliyun_AES_256 |
| Origin |
string |
La source du matériel de clé pour la CMK. |
Aliyun_KMS |
| MaterialExpireTime |
string |
L'heure d'expiration du matériel de clé. L'heure est affichée en UTC. Si la valeur de ce paramètre est vide, le matériel de clé n'expire pas. |
2021-07-06T18:22:03Z |
| DeletionProtectionDescription |
string |
La description de la protection contre la suppression. |
La CMK est utilisée par XXX. La protection contre la suppression est activée |
| AutomaticRotation |
string |
Indique si la rotation automatique des clés est activée. Valeurs valides :
Pour plus d'informations, consultez Rotation automatique des clés. Remarque
Seules les CMK symétriques prennent en charge la rotation automatique des clés. |
Disabled |
| ProtectionLevel |
string |
Le niveau de protection de la CMK. |
HSM |
| KeyUsage |
string |
L'utilisation de la CMK. |
ENCRYPT/DECRYPT |
| CreationDate |
string |
L'heure de création de la CMK. L'heure est affichée en UTC. |
2021-05-20T06:34:21Z |
| DKMSInstanceId |
string |
L'identifiant de l'instance KMS dédiée. |
kst-bjj62d8f5e0sgtx8h**** |
Exemples
JSON format
{
"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****"
}
}Codes d'erreur
|
Code de statut HTTP |
Code d'erreur |
Message d'erreur |
Description |
|---|---|---|---|
| 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. |
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.