Guía del SDK - Quick BI - Centro de documentación de Alibaba Cloud

Este tema describe las versiones del kit de desarrollo de software (SDK) que proporciona Quick BI y explica cómo obtener las más recientes.

Descripción general del SDK

Introducción

El SDK de Quick BI para análisis visual ofrece un conjunto de operaciones de API encapsuladas. Utiliza un par de AccessKey para la verificación de identidad y proporciona funciones como la firma automática para simplificar la creación y gestión de recursos.

El kit de desarrollo de software (SDK) de Quick BI para análisis visual encapsula operaciones de API. Usa un par de AccessKey para identificar a los solicitantes y ofrece funciones como la firma automática para facilitar la creación y gestión de recursos. Para utilizar las funciones de análisis visual de Quick BI, debe instalar tanto el SDK de Quick BI como la biblioteca central de Alibaba Cloud. Por ejemplo, si usa el SDK de Java, descargue aliyun-java-sdk-core y aliyun-java-sdk-quickbi-public.

Notas

Vaya a la página del SDK de Alibaba Cloud para descargar el SDK y consultar sus instrucciones de uso.
Para consultar la lista de operaciones de API disponibles, consulte API reference.
Obtenga el ID de AccessKey y el secreto de AccessKey de su cuenta de Alibaba Cloud.

Para obtener más información, consulte Create an AccessKey pair.
Para invocar operaciones de API mediante un SDK, debe cumplir las dos condiciones siguientes:
- Debe haber iniciado sesión en Quick BI con su cuenta de Alibaba Cloud al menos una vez.
- Su cuenta de Alibaba Cloud debe tener asignado el rol de administrador de organización en Quick BI. Un administrador también puede otorgar permisos a usuarios no administradores para invocar todas las operaciones de API desde la página Open Platform. Para obtener más información, consulte Overview > Access control.

Lenguajes de programación compatibles

Quick BI admite el desarrollo mediante kits de desarrollo de software (SDK) en lenguajes como Java, Python y C#. Para obtener más información sobre los SDK, visite la Plataforma abierta de Alibaba Cloud.

Guía de versiones

Versión publicada	Fecha de publicación	Descripción del cambio
2.0.0	2022-03-04	Se publicó la API V2 con endpoints específicos por región. Las operaciones publicadas abarcan todas las operaciones de la lista original de API. Nota La lista original de API ya no recibe mantenimiento tras la publicación de la API V2. Todas las nuevas operaciones de API se agregan a la V2.

Enlaces relacionados

El Centro de desarrolladores de Alibaba Cloud proporciona SDK para los lenguajes de programación de uso frecuente. También ofrece información como tutoriales de inicio rápido y listas de proyectos de código abierto. Para obtener más información, consulte el Centro de desarrolladores de Alibaba Cloud.

Métodos de invocación del SDK

Al invocar el SDK, tenga en cuenta lo siguiente:

Cree e inicialice una instancia DefaultAcsClient con el ID de AccessKey y el secreto de AccessKey correspondientes a su cuenta de Alibaba Cloud. De lo contrario, se notificará el siguiente error: code: 404, Specified access key is not found. request id: AA7FE476-F206-5C52-95B3-DF35CD30D468.
El par de AccessKey debe pertenecer a una cuenta de Alibaba Cloud que tenga asignado el rol de administrador de organización en Quick BI y que se haya utilizado para iniciar sesión en Quick BI al menos una vez. Especifique el par de AccessKey según sea necesario.

Para obtener más información sobre cómo invocar el SDK, consulte la documentación del SDK.

Limitación de operaciones de API

Importante

La versión de las siguientes operaciones de API es 2022-01-01.
Los usuarios de Quick BI implementado en la nube pública y Finance Cloud pueden invocar las siguientes operaciones de API.
Solo Quick BI Professional y ediciones superiores admiten llamadas a API.

Categoría	Nombre de API	Descripción	QPS (llamadas/segundo)	Tiempo de espera (segundos)
Gestión de organización y usuarios	AddUser	Agrega un miembro a una organización.	50	10
	UpdateUser	Actualiza la información de un miembro específico en una organización.	50	10
	QueryUserList	Consulta la lista de miembros de una organización.	30	10
	DeleteUser	Elimina un usuario específico de una organización.	50	10
	QueryUserInfoByUserId	Consulta la información de un miembro en una organización mediante su ID de usuario.	30	10
	QueryUserInfoByAccount	Consulta la información de un miembro en una organización mediante el ID o nombre de la cuenta de Alibaba Cloud.	30	10
Gestión de etiquetas de usuario	AddUserTagMeta	Agrega metadatos a las etiquetas de un miembro en una organización.	50	10
	DeleteUserTagMeta	Elimina los metadatos de las etiquetas de un miembro en una organización.	50	10
	QueryUserTagMetaList	Consulta la lista de metadatos de las etiquetas de los miembros de una organización.	30	10
	UpdateUserTagValue	Modifica los valores de etiqueta de un miembro en una organización.	50	10
	QueryUserTagValueList	Consulta la lista de valores de etiqueta de un usuario específico.	30	10
	UpdateUserTagMeta	Actualiza los metadatos de las etiquetas de un miembro en una organización.	50	10
Gestión de organización y grupos de usuarios	AddUserGroupMember	Agrega un miembro de una organización a un grupo de usuarios específico.	50	10
	AddUserGroupMembers	Agrega varios usuarios a un grupo de usuarios específico en lote.	50	10
	DeleteUserGroupMember	Elimina un miembro específico de un grupo de usuarios específico.	50	10
	CreateUserGroup	Crea un grupo de usuarios en una organización específica.	50	10
	DeleteUserGroup	Elimina un grupo de usuarios de una organización específica.	50	10
	UpdateUserGroup	Actualiza la información de un grupo de usuarios específico en una organización.	50	10
	QueryUserGroupMember	Consulta la lista de miembros de un grupo de usuarios.	30	10
	QueryUserGroupListByParentId	Consulta la información de los grupos de usuarios secundarios de un grupo de usuarios principal específico.	30	10
	GetUserGroupInfo	Busca grupos de usuarios por palabra clave del nombre del grupo.	30	10
	ListUserGroupsByUserId	Consulta la lista de grupos de usuarios a los que pertenece un usuario.	30	10
	WithdrawAllUserGroups	Quita a un usuario de todos los grupos de usuarios.	50	10
	DeleteUserGroupMembers	Quita varios usuarios de grupos de usuarios en lote.	50	10
	ListByUserGroupId	Consulta la información de varios grupos de usuarios simultáneamente mediante el ID del grupo.	50	10
Uso compartido y autorización de informes	QueryShareList	Consulta una lista de autorizaciones.	30	10
	AddShareReport	Agrega una directiva de autorización a un informe.	50	10
	QuerySharesToUserList	Consulta la lista de trabajos autorizados para un usuario.	30	10
	CancelReportShare	Elimina la directiva de autorización de un informe.	50	10
Autorización de menús de portal BI	ListPortalMenus	Consulta una lista de menús de portal BI.	30	10
	ListPortalMenuAuthorization	Consulta la lista de autorizaciones de un menú de portal BI.	30	10
	AuthorizeMenu	Agrega autorizaciones a menús de portal BI en lote.	50	10
	CancelAuthorizationMenu	Cancela las autorizaciones de menús de portal BI en lote.	50	10
	ChangeVisibilityModel	Modifica la visibilidad de un menú de portal BI. Configure el menú para que sea visible solo para usuarios autorizados.	50	10
Gestión de permisos a nivel de fila	QueryDatasetSwitchInfo	Consulta el estado del interruptor de permisos a nivel de fila para un conjunto de datos.	30	10
	UpdateDataLevelPermissionStatus	Habilita o deshabilita los permisos a nivel de fila y columna para un conjunto de datos.	50	10
	ListCubeDataLevelPermissionConfig	Consulta las configuraciones de permisos a nivel de fila y columna para un conjunto de datos.	30	10
	SetDataLevelPermissionRuleConfig	Configura una regla para los permisos a nivel de fila y columna en un conjunto de datos.	50	10
	DeleteDataLevelRuleConfig	Elimina una regla para los permisos a nivel de fila y columna en un conjunto de datos.	50	10
	AddDataLevelPermissionRuleUsers	Agrega incrementalmente usuarios con permisos a nivel de fila según una regla.	50	10
	DeleteDataLevelPermissionRuleUsers	Elimina usuarios con permisos a nivel de fila según una regla.	50	10
	SetDataLevelPermissionExtraConfig	Especifica configuraciones adicionales para permisos a nivel de fila o columna.	50	10
	ListDataLevelPermissionWhiteList	Consulta la lista de permitidos para los permisos a nivel de fila y columna en un conjunto de datos.	30	10
	SetDataLevelPermissionWhiteList	Configura una lista de permitidos para permisos a nivel de fila y columna.	50	10
	AddDataLevelPermissionWhiteList	Configura incrementalmente una lista de permitidos para permisos a nivel de fila y columna.	50	10
Gestión de áreas de trabajo	UpdateWorkspaceUsersRole	Modifica los roles de los miembros en un área de trabajo.	50	10
	QueryWorkspaceUserList	Consulta una lista de miembros en un área de trabajo específica.	30	10
	DeleteUserFromWorkspace	Elimina un miembro de un área de trabajo específica.	50	10
	QueryOrganizationWorkspaceList	Consulta una lista de áreas de trabajo en la organización actual.	30	10
	AddUserToWorkspace	Agrega un miembro a un área de trabajo específica.	50	10
	AddWorkspaceUsers	Agrega varios miembros a un área de trabajo específica en lote.	50	10
	QueryUserRoleInfoInWorkspace	Consulta la información de roles de los miembros en un área de trabajo específica.	30	10
	UpdateWorkspaceUserRole	Actualiza la información de roles de los miembros en un área de trabajo en lote.	50	10
Gestión de recursos de informes	QueryWorksByOrganization	Consulta una lista de informes en una organización.	30	10
	QueryWorksByWorkspace	Consulta una lista de informes en un área de trabajo específica de una organización.	30	10
	QueryReadableResourcesListByUserId	Consulta una lista de informes que un usuario tiene permiso para ver.	30	10
	CheckReadable	Comprueba si un usuario tiene permiso para ver un informe.	50	10
	QueryEmbeddedInfo	Consulta la información de embedding sobre los informes en una organización.	30	10
	UpdateEmbeddedStatus	Modifica el estado de embedding de un informe.	50	10
	QueryWorks	Consulta la información de un informe.	30	10
	QueryWorksBloodRelationship	Consulta el linaje de datos de un informe específico.	30	10
Gestión de recursos de conjuntos de datos	QueryDatasetList	Consulta una lista de conjuntos de datos en un área de trabajo específica.	30	10
	QueryDatasetDetailInfo	Consulta los detalles de un conjunto de datos específico.	30	10
	QueryDatasetInfo	Consulta los detalles de un conjunto de datos.	30	10
Gestión de favoritos	ListCollections	Consulta la lista de favoritos.	30	10
	SaveFavorites	Agrega un trabajo a favoritos.	50	10
	CancelCollection	Quita un trabajo de favoritos.	50	10
Gestión de la página principal	ListFavoriteReports	Consulta la lista de trabajos autorizados en la página My Dashboards para un usuario específico.	30	10
	ListSharedReports	Consulta la lista de trabajos favoritos en la página My Dashboards para un usuario específico.	30	10
	ListRecentViewReports	Consulta la lista de trabajos vistos recientemente o con frecuencia en la página My Dashboards para un usuario específico.	30	10
DataService Studio	QueryDataService	Invoca una operación de API creada en DataService Studio.	10	60
Análisis embebido	CreateTicket	Genera un ticket para embedding de terceros.	50	10
	QueryTicketInfo	Consulta los detalles de un ticket utilizado para integrar un informe.	30	10
	DeleteTicket	Elimina un ticket utilizado para integrar un informe.	50	10
	DelayTicketExpireTime	Actualiza la hora de caducidad de un ticket utilizado para integrar un informe.	50	10
	UpdateTicketNum	Actualiza el número de tickets disponibles para integrar un informe.	50	10
Aprobación abierta	ResultCallback	Operación de API de callback para flujos de trabajo de aprobación personalizados. Use esta operación para procesar flujos de aprobación en Quick BI.	30	10

Consultar la versión del SDK

En el archivo pom.xml, asegúrese de que el valor de version corresponda a la versión más reciente disponible en la dirección de descarga del SDK.

Consulte la versión del SDK en https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-quickbi-public.

Cómo evitar que el número de solicitudes concurrentes por segundo supere el umbral de limitación

Descripción del problema: Por motivos de rendimiento y seguridad, las operaciones de API de Quick BI implementado en la nube pública tienen límites predeterminados. Si utiliza subprocesos concurrentes para invocar las operaciones de API y el número real de consultas por segundo (QPS) supera el umbral de limitación, las solicitudes fallarán.

Solución: Use la clase RateLimiter del componente Google Guava para limitar el QPS de las solicitudes de API.

Si usa Maven para gestionar su proyecto Java, agregue la dependencia de Maven al archivo pom.xml.
```
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>${google.guava.version}</version>
</dependency>
```
Nota
En el archivo pom.xml, asegúrese de que el valor de version corresponda a la versión más reciente disponible en la dirección de descarga. Para consultar la versión más reciente, vea Guava: Google Core Libraries For Java.

Cree y utilice un RateLimiter.

Use el método de fábrica create() para crear una instancia RateLimiter. Para obtener más información, consulte https://www.baeldung.com/guava-rate-limiter.

// Create a RateLimiter for throttling with a limit of 30 QPS.
RateLimiter rateLimiter = RateLimiter.create(30);
// Obtain a permit. If the QPS exceeds 30, the request is blocked and must wait.
rateLimiter.acquire();
// An API request can be sent only after a permit is obtained.
doSomeAPIRequest();

Nota

Las consultas por segundo (QPS) representan el número de solicitudes o tareas que se procesan por segundo.

La concurrencia es el número de solicitudes o tareas que el sistema procesa simultáneamente.

QPS = Concurrencia / Tiempo promedio de respuesta.