DescribeTenantEncryption - ApsaraDB for OceanBase (Deprecated) - Centro de documentación de Alibaba Cloud

Consulta la información de cifrado de un inquilino.

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

oceanbase:DescribeTenantEncryption

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID del clúster de OceanBase.	ob317v4uif****
TenantId	string	No	El ID del inquilino.	t4louaeei****
TenantName	string	No	El nombre del inquilino. Debe comenzar con una letra o un guion bajo () y contener de 2 a 20 caracteres, que pueden ser letras mayúsculas, letras minúsculas, dígitos y guiones bajos (). No se puede establecer como sys.	forMySQLTenant
PageNumber	integer	No	El número de la página a devolver. Las páginas comienzan desde la página 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de filas a devolver en cada página. Valor máximo: 100. Valor predeterminado: 10	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El resultado devuelto de la solicitud.
RequestId	string	El ID de la solicitud.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TotalCount	integer	El número total de entradas devueltas. Este parámetro surte efecto en una consulta paginada.	8
TenantEncryptions	array<object>	Los escenarios que admiten cifrado.
	object	La información sobre los escenarios que admiten cifrado.
TenantId	string	El ID del inquilino.	t4louaeei****
TenantMode	string	El modo compatible del inquilino. Valores válidos: Oracle MySQL	MySQL
TenantName	string	El nombre del inquilino.	forMySQLTenant
EnableEncryption	boolean	Indica si el cifrado está habilitado. Valores válidos: true false	false
TenantStatus	string	El estado del inquilino.	ONLINE
Status	string	El estado de la habilitación del cifrado del inquilino.	OPEN
EncryptionType	string	El tipo de cifrado.	INTERNAL
EncryptionKeyId	string	El ID de la clave de cifrado creada por Key Management Service (KMS).	xxx

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TotalCount": 8,
  "TenantEncryptions": [
    {
      "TenantId": "t4louaeei****",
      "TenantMode": "MySQL",
      "TenantName": "forMySQLTenant",
      "EnableEncryption": false,
      "TenantStatus": "ONLINE",
      "Status": "OPEN",
      "EncryptionType": "INTERNAL",
      "EncryptionKeyId": "xxx"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError	The request processing has failed due to some unknown error.

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.