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

Consulta la lista de cuentas de acceso a bases de datos bajo 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:DescribeTenantUsers

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
TenantId	string	Sí	El ID del inquilino.	ob2mr3oae0****
SearchKey	string	No	La palabra clave de filtro para coincidencia aproximada al consultar la lista.	pay
PageNumber	integer	No	El número de página de la consulta paginada. Valor mínimo: 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de filas por página para la consulta paginada. Valor máximo: 100. Valor predeterminado: 10.	10
UserName	string	No	El nombre de la cuenta de base de datos. No se pueden usar ciertas palabras clave reservadas como SYS y root.	pay_test

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
TotalCount	integer	El número total de cuentas de base de datos en el inquilino.	1
RequestId	string	El ID de la solicitud.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantUsers	array<object>	La lista de cuentas de base de datos en el inquilino.
	array<object>	Los detalles de una cuenta de base de datos.
UserType	string	El tipo de cuenta de base de datos. Valores válidos: Admin: cuenta de superusuario. Normal: cuenta estándar.	Normal
Description	string	La descripción de la cuenta de base de datos.	use for test
Databases	array<object>	La lista de permisos de base de datos otorgados a la cuenta.
	object	Los detalles de una cuenta de base de datos.
Database	string	El nombre de la base de datos (esquema).	db_pay1
Role	string	El rol otorgado. Para el modo Oracle, los roles son a nivel de esquema. Valores válidos: ReadWrite: permisos de lectura y escritura, que incluyen CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE. ReadOnly: permiso de solo lectura, que incluye SELECT. Para el modo MySQL, los roles son a nivel de base de datos. Valores válidos: ReadWrite: permisos de lectura y escritura, que incluyen ALL PRIVILEGES. ReadOnly: permiso de solo lectura, que incluye SELECT. DDL: permisos DDL, que incluyen CREATE, DROP, ALTER, SHOW VIEW, CREATE VIEW. DML: permisos DML, que incluyen SELECT, INSERT, UPDATE, DELETE, SHOW VIEW. Nota Además, una cuenta de Oracle tiene permisos de lectura y escritura predeterminados sobre su propio esquema, los cuales no se enumeran aquí.	ReadOnly
Table	string	El nombre de la tabla.	tbl_pay1
Privileges	string	Cuando se otorgan permisos personalizados a un usuario para una base de datos, privileges devuelve el contenido de los permisos personalizados separados por comas (,). De lo contrario, privileges no devuelve datos.	select,delete,update
UserStatus	string	El estado de la cuenta de base de datos. Valores válidos: LOCKED: bloqueado. ONLINE: desbloqueado.	ONLINE
UserName	string	El nombre de la cuenta de base de datos.	pay_test
TenantId	string	El ID del inquilino al que pertenece la cuenta.	t4pnum****
InstanceId	string	El ID del clúster al que pertenece la cuenta.	obshc32****
GlobalPermissions	string	La información de permisos globales.	Encrypt,Decrypt

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TenantUsers": [
    {
      "UserType": "Normal",
      "Description": "use for test",
      "Databases": [
        {
          "Database": "db_pay1",
          "Role": "ReadOnly",
          "Table": "tbl_pay1",
          "Privileges": "select,delete,update"
        }
      ],
      "UserStatus": "ONLINE",
      "UserName": "pay_test",
      "TenantId": "t4pnum**** ",
      "InstanceId": "obshc32****",
      "GlobalPermissions": "Encrypt,Decrypt"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
2014	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.