DescribeSecret - - Centre de documentation Alibaba Cloud

Consulte les détails d'une instance Secret.

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

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

sae:DescribeSecret

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

GET /pop/v1/sam/secret/secret HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
NamespaceId	string	Oui	L'identifiant de l'espace de noms auquel l'instance Secret appartient. Si l'espace de noms est l'espace de noms par défaut, spécifiez uniquement le RegionId, par exemple cn-beijing.	cn-beijing:test
SecretId	integer	Oui	L'identifiant de l'instance Secret à interroger. Vous pouvez appeler l'opération ListSecrets pour obtenir l'identifiant de l'instance.	16

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
RequestId	string	L'identifiant de la requête.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Les informations supplémentaires. Si la requête aboutit, success est renvoyé. Si la requête échoue, un code d'erreur spécifique est renvoyé.	success
TraceId	string	L'identifiant de trace utilisé pour interroger précisément les informations d'invocation.	0a98a02315955564772843261e****
Data	object	Le résultat renvoyé.
NamespaceId	string	L'identifiant de l'espace de noms.	cn-beijing:test
SecretId	integer	L'identifiant de l'instance Secret.	16
SecretName	string	Le nom de l'instance Secret.	registry-auth
SecretType	string	Le type de l'instance Secret.	kubernetes.io/dockerconfigjson
SecretData	object	Les données de paires clé-valeur du Secret.
	string	Les données de paires clé-valeur du Secret.	{".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}
CreateTime	integer	L'heure de création.	1593746835111
UpdateTime	integer	L'heure de mise à jour.	1593746835111
RelateApps	array<object>	Les applications associées.
	object	Les informations détaillées sur l'application.
AppId	string	L'identifiant de l'application.	f16b4000-9058-4c22-a49d-49a28f0b****
AppName	string	Le nom de l'application.	test-app
ErrorCode	string	Le code d'erreur. Si la requête réussit, le champ ErrorCode n'est pas renvoyé. Si la requête échoue, le champ ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.	InvalidParameter.NotEmpty
Code	string	Le code d'état de l'API ou le code d'erreur POP. Valeurs valides :\n- 2xx : Succès.\n- 3xx : Redirection.\n- 4xx : Erreur de requête.\n- 5xx : Erreur de serveur.	200
Success	boolean	Indique si les détails de l'instance Secret ont été consultés avec succès. Valeurs valides :\n- true : La requête a réussi.\n- false : La requête a échoué.	true

Exemples

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "NamespaceId": "cn-beijing:test",
    "SecretId": 16,
    "SecretName": "registry-auth",
    "SecretType": "kubernetes.io/dockerconfigjson",
    "SecretData": {
      "key": "{\".dockerconfigjson\":\"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0=\"}"
    },
    "CreateTime": 1593746835111,
    "UpdateTime": 1593746835111,
    "RelateApps": [
      {
        "AppId": "f16b4000-9058-4c22-a49d-49a28f0b****",
        "AppName": "test-app"
      }
    ]
  },
  "ErrorCode": "Null",
  "Code": "200",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	Paramètre non valide : %s ne peut pas être vide.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	Paramètre non valide {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	Paramètre non valide {%s} : %s.
400	InvalidSecretId.NotFound	The specified SecretId [%s] does not exist in our records.	L'identifiant de secret spécifié [%s] n'existe pas.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.	Le NamespaceId spécifié n'existe pas.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.