GetSecretParameter - - Centre de documentation Alibaba Cloud

Consulte un paramètre chiffré, y compris sa valeur. Avant d'appeler cette opération, assurez-vous de disposer des autorisations nécessaires pour appeler l'opération d'API GetSecretValue du service Key Management Service (KMS).

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.

oos:GetSecretParameter

get

*secretparameter

acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}

oos:TLSVersion

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région.	cn-hangzhou
Name	string	Oui	Le nom du paramètre. Le nom peut comporter jusqu'à 180 caractères et contenir des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). Le nom ne peut pas commencer par ALIYUN, ACS, ALIBABA, ALICLOUD ou OOS.	MySecretParameter
ParameterVersion	integer	Non	Le numéro de version du paramètre. Valeurs valides : 1 à 100.	1
WithDecryption	boolean	Non	Indique si la valeur du paramètre doit être déchiffrée. Le champ Value dans la réponse n'est renvoyé que si ce paramètre est défini sur true. Sinon, le champ Value est vide.	false

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les informations sur le paramètre chiffré.
RequestId	string	L'identifiant de la requête.	7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2
Parameter	object	Les informations sur le paramètre chiffré.
Type	string	Le type du paramètre.	Secret
UpdatedDate	string	L'heure de mise à jour du paramètre.	2020-09-01T09:35:17Z
UpdatedBy	string	L'utilisateur qui a mis à jour le paramètre.	root(130900000)
KeyId	string	L'identifiant de la clé KMS utilisée pour le chiffrement.	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	Les balises.	{"k1": "v1", "k2": "v2"}
Value	string	La valeur du paramètre.	SecretParameter
Description	string	La description du paramètre.	SecretParameter
Constraints	string	Les contraintes du paramètre.	'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmxsn4m4******
CreatedBy	string	L'utilisateur qui a créé le paramètre.	root(130900000)
CreatedDate	string	L'heure de création du paramètre.	2020-09-01T09:28:47Z
ParameterVersion	integer	Le numéro de version du paramètre.	1
Name	string	Le nom du paramètre chiffré.	MySecretParameter
Id	string	L'identifiant du paramètre chiffré.	p-14ed150fdcd048xxxxxx
ShareType	string	Le type de partage du paramètre.	Private
DKMSInstanceId	string	L'identifiant de l'instance KMS.	kst-hzz****

Exemples

JSON format

{
  "RequestId": "7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2",
  "Parameter": {
    "Type": "Secret",
    "UpdatedDate": "2020-09-01T09:35:17Z",
    "UpdatedBy": "root(130900000)",
    "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Value": "SecretParameter",
    "Description": "SecretParameter",
    "Constraints": "'{''AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\".*\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T09:28:47Z",
    "ParameterVersion": 1,
    "Name": "MySecretParameter",
    "Id": "p-14ed150fdcd048xxxxxx",
    "ShareType": "Private",
    "DKMSInstanceId": "kst-hzz****"
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.