ListSecrets - - Centre de documentation Alibaba Cloud

Consulte tous les secrets de la région actuelle.

Description de l'opération

Pour appeler cette opération, l'utilisateur RAM ou le rôle RAM doit se voir attribuer la stratégie requise. Pour plus d'informations, consultez Resource Access Management.
Cette opération renvoie uniquement les métadonnées des secrets, et non les valeurs des secrets.

Cet exemple montre comment interroger les secrets créés par l'utilisateur actuel dans la région actuelle. PageNumber est défini sur 1 et PageSize sur 2, renvoyant ainsi les métadonnées de deux secrets.

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
FetchTags	string	Non	Indique si les balises de ressource doivent être renvoyées pour chaque secret. Valeurs valides : `true` : les balises de ressource sont renvoyées. `false` (par défaut) : les balises de ressource ne sont pas renvoyées.	false
PageNumber	integer	Non	Le numéro de page. La valeur doit être supérieure à 0. Valeur par défaut : 1.	1
PageSize	integer	Non	La taille de la page. La valeur doit être comprise entre 1 et 100. Valeur par défaut : 10.	2
Filters	string	Non	Filtre les secrets en fonction de conditions spécifiées. La valeur est une liste comprenant jusqu'à 10 paires clé-valeur. Lorsque vous filtrez par balise, la requête renvoie un maximum de 4 000 ressources. Si plus de 4 000 ressources correspondent au filtre, appelez l'opération ListResourceTags. Key Description : la propriété de filtre. Type : String. Values Description : la valeur de filtre. Type : String. Vous pouvez spécifier jusqu'à 10 éléments. Valeurs valides pour Key : Définissez `Key` sur SecretName pour filtrer par nom de secret. Définissez `Key` sur Description pour filtrer par description de secret. Définissez `Key` sur TagKey pour filtrer par clé de balise. Définissez `Key` sur TagValue pour filtrer par valeur de balise. Définissez `Key` sur DKMSInstanceId pour filtrer par identifiant d'instance KMS. Définissez `Key` sur SecretType pour filtrer par type de secret. `Values` peut être `Generic`, `RDS`, `Redis`, `RAMCredentials`, `ECS` ou `PolarDB`. Définissez `Key` sur Creator pour filtrer par créateur du secret. Si vous spécifiez plusieurs valeurs pour une clé, le filtre applique un OU logique. Par exemple, si vous saisissez `[ {"Key":"SecretName", "Values":["sec1","sec2"]} ]`, cela signifie : `(SecretName=sec1 OR SecretName=sec2)`.	[{"Key":"SecretName", "Values":["Val1","Val2"]}]

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageNumber	integer	Le numéro de page.	1
PageSize	integer	Le nombre d'entrées par page.	2
RequestId	string	L'identifiant unique généré par Alibaba Cloud pour la requête. Utilisez-le pour localiser et résoudre les problèmes.	6a6287a0-ff34-4780-a790-fdfca900557f
TotalCount	integer	Le nombre de secrets.	55
SecretList	object
Secret	array<object>	La liste des secrets.
	array<object>
SecretName	string	The name of the secret.	secret001
UpdateTime	string	The time when the secret was last updated.	2024-07-17T07:59:05Z
SecretType	string	The type of the secret. Valid values: `Generic`: a generic secret. `Rds`: an RDS secret. `Redis`: a Redis or Tair secret. `RAMCredentials`: a RAM secret. `ECS`: an ECS secret. `PolarDB`: a PolarDB secret.	Generic
PlannedDeleteTime	string	The scheduled deletion time.	2024-08-17T07:59:05Z
CreateTime	string	The time when the secret was created.	2024-07-17T07:59:05Z
Tags	object
Tag	array<object>	The resource tags for the secret. This parameter is not returned if the `FetchTags` parameter is set to `false` or is not specified.
	object	A resource tag.
TagValue	string	The tag value.	val1
TagKey	string	The tag key.	key1
OwingService	string	The owner service.	alb

Exemples

JSON format

{
  "PageNumber": 1,
  "PageSize": 2,
  "RequestId": "6a6287a0-ff34-4780-a790-fdfca900557f",
  "TotalCount": 55,
  "SecretList": {
    "Secret": [
      {
        "SecretName": "secret001",
        "UpdateTime": "2024-07-17T07:59:05Z",
        "SecretType": "Generic",
        "PlannedDeleteTime": "2024-08-17T07:59:05Z",
        "CreateTime": "2024-07-17T07:59:05Z",
        "Tags": {
          "Tag": [
            {
              "TagValue": "val1",
              "TagKey": "key1"
            }
          ]
        },
        "OwingService": "alb"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	InvalidParameter	some of the specified parameters "\" is not valid
500	InternalFailure	Internal Failure
403	Forbidden.NoPermission	This operation is forbidden by permission system
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.