DescribeSecret - - Centre de documentation Alibaba Cloud

Consulte les métadonnées d'un secret.

Description de l'opération

Cette opération renvoie les métadonnées d'un secret. Cette opération ne renvoie pas la valeur du secret.

Dans cet exemple, les métadonnées du secret nommé secret001 sont consultées.

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

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SecretName	string	Oui	Le nom du secret.	secret001
FetchTags	string	Non	Indique si les balises de ressource du secret doivent être renvoyées. Valeurs valides : true : les balises de ressource sont renvoyées. false : les balises de ressource ne sont pas renvoyées. Il s'agit de la valeur par défaut.	true

Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres courants.

Éléments de réponse

Élément	Type	Description	Exemple
	object
UpdateTime	string	L'heure de mise à jour du secret.	2022-02-21T15:39:26Z
CreateTime	string	L'heure de création du secret.	2022-02-21T15:39:26Z
NextRotationDate	string	L'heure à laquelle la prochaine rotation sera effectuée. Remarque Ce paramètre est renvoyé lorsque la rotation automatique est activée.	2022-07-06T18:22:03Z
EncryptionKeyId	string	L'identifiant de la clé principale client (CMK) utilisée pour chiffrer la valeur du secret.	00aa68af-2c02-4f68-95fe-3435d330****
RotationInterval	string	L'intervalle de rotation automatique. La valeur est au format integer[unit]. integer indique la durée. unit indique l'unité de temps. La valeur de unit est fixée à s. Par exemple, si la valeur est 604800s, la rotation automatique est effectuée à un intervalle de 7 jours. Remarque Ce paramètre est renvoyé lorsque la rotation automatique est activée.	3153600s
Arn	string	L'Alibaba Cloud Resource Name (ARN) du secret.	acs:kms:cn-hangzhou:154035569884****:secret/secret001
ExtendedConfig	string	La configuration étendue du secret. Remarque Ce paramètre est renvoyé uniquement pour un secret ApsaraDB RDS géré, un secret Resource Access Management (RAM) géré ou un secret Elastic Compute Service (ECS) géré.	{"SecretSubType":"SingleUser", "DBInstanceId":"rm-uf667446pc955****", "CustomData":{} }
LastRotationDate	string	L'heure à laquelle la dernière rotation a été effectuée. Remarque Ce paramètre est renvoyé si le secret a fait l'objet d'une rotation.	2022-07-05T08:22:03Z
RequestId	string	L'identifiant de la requête, utilisé pour localiser et résoudre les problèmes.	93348dfb-3627-4417-8d90-487a76a909c9
Description	string	La description du secret.	userinfo
SecretName	string	Le nom du secret.	secret001
AutomaticRotation	string	Indique si la rotation automatique est activée. Valeurs valides : Enabled : indique que la rotation automatique est activée. Disabled : indique que la rotation automatique est désactivée. Invalid : indique que l'état de la rotation automatique est anormal. Dans ce cas, Secrets Manager ne peut pas faire pivoter le secret automatiquement. Remarque Ce paramètre est renvoyé uniquement pour un secret ApsaraDB RDS géré, un secret RAM géré ou un secret ECS géré.	Enabled
SecretType	string	Le type de secret. Valeurs valides : Generic : indique un secret générique. Rds : indique un secret ApsaraDB RDS géré. RAMCredentials : indique un secret RAM géré. ECS : indique un secret ECS géré.	Rds
PlannedDeleteTime	string	L'heure à laquelle la suppression du secret est planifiée.	2022-03-21T15:45:12Z
DKMSInstanceId	string	L'identifiant de l'instance KMS dédiée.	kst-bjj62d8f5e0sgtx8h****
Tags	object
Tag	array<object>	Les balises de ressource du secret. Ce paramètre n'est pas renvoyé si vous définissez le paramètre FetchTags sur false ou si vous ne spécifiez pas le paramètre FetchTags.
	object
TagValue	string	The tag value.	val1
TagKey	string	The tag key.	key1

Exemples

JSON format

{
  "UpdateTime": "2022-02-21T15:39:26Z",
  "CreateTime": "2022-02-21T15:39:26Z",
  "NextRotationDate": "2022-07-06T18:22:03Z",
  "EncryptionKeyId": "00aa68af-2c02-4f68-95fe-3435d330****",
  "RotationInterval": "3153600s",
  "Arn": "acs:kms:cn-hangzhou:154035569884****:secret/secret001",
  "ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate": "2022-07-05T08:22:03Z",
  "RequestId": "93348dfb-3627-4417-8d90-487a76a909c9",
  "Description": "userinfo",
  "SecretName": "secret001",
  "AutomaticRotation": "Enabled",
  "SecretType": "Rds",
  "PlannedDeleteTime": "2022-03-21T15:45:12Z",
  "DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****",
  "Tags": {
    "Tag": [
      {
        "TagValue": "val1",
        "TagKey": "key1"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalTimestamp	The input parameter Timestamp that is mandatory for processing this request is not supplied.	The input parameter timestamp indicates that the request is outside the processing time range.
400	InvalidParameter	The specified parameter is not valid.	An invalid value is specified for the parameter.
403	Forbidden.NoPermission	You are not authorized to perform the operation.	You are not authorized to perform the operation.
404	Forbidden.ResourceNotFound	Resource not found
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.