DescribeUserEncryptionKeyList - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Descripción de la operación

Puede utilizar las claves personalizadas devueltas por esta operación para habilitar el cifrado transparente de datos (TDE). Para obtener más información, consulte ModifyDBInstanceTDE.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dds:DescribeUserEncryptionKeyList

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia.	dds-bpxxxxxxxx
TargetRegionId	string	No	El ID de la región de destino. Puede llamar a la operación DescribeRegions para consultar las regiones disponibles.	cn-shanghai
RoleARN	string	No	El nombre de recurso de Alibaba Cloud (ARN) del rol de RAM. Formato: `acs:ram::$accountID:role/$roleName`. El valor predeterminado es `acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole`. Nota `$accountID`: El ID de su cuenta de Alibaba Cloud. Para ver el ID, inicie sesión en la consola de administración de Alibaba Cloud, pase el puntero sobre su foto de perfil en la esquina superior derecha y haga clic en Configuración de seguridad. `$roleName`: El nombre del rol de RAM. Para ver el nombre del rol, inicie sesión en la consola de RAM. En el panel de navegación izquierdo, haga clic en Gestión de roles de RAM. Busque el nombre del rol en la lista Nombre de rol de RAM.	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	7CD51DA4-A499-43CE-B9B5-20CD4FDC648E
KeyIds	object
KeyId	array	Una lista de claves de instancia.
	string	La clave de la instancia.	2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.