Todos os produtos
Search
Central de documentação

:DescribeUserEncryptionKeyList

Última atualização: Jul 09, 2026

Consulta a lista de chaves personalizadas de uma instância do ApsaraDB for MongoDB.

Use a chave personalizada obtida pela operação DescribeUserEncryptionKeyList para ative o TDE. Para mais informações, consulte ModifyDBInstanceTDE.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

DescribeUserEncryptionKeyList

Operação a ser executada. Defina o valor como DescribeUserEncryptionKeyList.

DBInstanceId

String

Sim

dds-bpxxxxxxxx

ID da instância.

RegionId

String

Não

cn-hangzhou

ID da região da instância. Chame a operação DescribeRegions para consultar esse identificador.

TargetRegionId

String

Não

cn-hangzhou-h

ID da zona da instância. Chame a operação DescribeRegions para obter a lista de zonas mais recente.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

KeyIds

List

2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Lista de chaves personalizadas.

RequestId

String

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

ID da solicitação.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato 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>

Formato JSON

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

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.