Tous les produits
Search
Centre de documentation

:DescribeUserEncryptionKeyList

Dernière mise à jour :Aug 08, 2026

Renvoie la liste des clés personnalisées d'une instance ApsaraDB for MongoDB.

Utilisez les clés personnalisées obtenues via l'opération DescribeUserEncryptionKeyList pour activer le chiffrement TDE. Pour plus d'informations, consultez la rubrique ModifyDBInstanceTDE.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

Action

String

Oui

DescribeUserEncryptionKeyList

Action à effectuer. Définissez la valeur sur DescribeUserEncryptionKeyList.

DBInstanceId

String

Oui

dds-bpxxxxxxxx

ID de l'instance.

RegionId

String

Non

cn-hangzhou

ID de région de l'instance. Appelez l'opération DescribeRegions pour récupérer l'ID de région.

TargetRegionId

String

Non

cn-hangzhou-h

ID de zone de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste des zones la plus récente.

Paramètres de réponse

Paramètre

Type

Exemple

Description

KeyIds

List

2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Liste des clés personnalisées.

RequestId

String

7CD51DA4-A499-43CE-B9B5-20CD4FDC648E

ID de la requête.

Exemples

Exemple de requête

http(s)://mongodb.aliyuncs.com/?Action=DescribeUserEncryptionKeyList
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

Exemples de réponses réussies

Format XML

<RequestId>7CD51DA4-A499-43CE-B9B5-20CD4FDC648E</RequestId>
<KeyIds>
    <KeyId>2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
    <KeyId>578b59ad-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
    <KeyId>749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
</KeyIds>

Format JSON

{
	"RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
	"KeyIds": {
		"KeyId": [
			"2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
			"578b59ad-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
			"749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
		]
	}
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.