Estándares de API y SDK preconfigurados multilenguaje
La OpenAPI de este producto (quickbi-public/2022-01-01) utiliza el estilo de firma RPC. Se han encapsulado SDK para los lenguajes de programación más comunes con el fin de facilitar el desarrollo. Los desarrolladores pueden descargar el SDK para invocar directamente la OpenAPI de este producto sin preocuparse por los detalles técnicos. Si el SDK existente no satisface sus necesidades, utilice el mecanismo de firma para una integración con autofirma. Dado que los detalles de la autofirma son muy complejos, este proceso puede tardar alrededor de 5 días hábiles. Por lo tanto, se recomienda unirse a nuestro grupo de servicio de DingTalk (147535001692) para llevar a cabo la integración de firmas bajo la guía de expertos.
Antes de usar la API, prepare su cuenta de identidad y su clave de acceso (AccessKey) para acceder eficazmente a la API mediante herramientas cliente (como SDK y CLI). Para obtener más información, consulte Obtener un AccessKey.
Escenarios de firma personalizada
Si su escenario empresarial tiene requisitos especiales y necesita integrar la API mediante autofirma, se recomienda consultar primero a nuestro equipo de soporte técnico (grupo de servicio de DingTalk: 147535001692) para obtener orientación profesional y garantizar una integración eficiente.
Preparación de cuenta y seguridad
Las cuentas de Alibaba Cloud tienen permisos administrativos completos sobre todos los recursos. Si un AccessKey se ve comprometido, todos los recursos asociados corren el riesgo de sufrir accesos no autorizados. Para garantizar la seguridad, se recomienda crear un RAM user con permisos de acceso exclusivos a la API y configurar su AccessKey, además de establecer directivas de RAM basadas en el principio de menor privilegio (PoLP). Utilice la cuenta de Alibaba Cloud únicamente en escenarios específicos donde se requieran explícitamente sus permisos.
Gestión de la organización
|
API |
Título |
Descripción |
| Gestión de usuarios de la organización | Gestión de usuarios de la organización | |
| DeleteUser | Eliminar usuario de la organización. | Elimina el usuario de la organización especificado. |
| CheckOrganizationMember | Verificar miembro de la organización. | Verifica si un usuario es miembro de una organización. |
| AddUser | Agregar miembro de la organización. | Agrega miembros a la organización. |
| BatchAddFeishuUsers | Agregar usuarios de Lark en lotes. | Agrega usuarios de Lark en lotes. |
| UpdateUser | Actualizar información de miembro de la organización. | Actualiza la información de un miembro especificado en una organización. |
| QueryUserList | Consulta de la lista de miembros de la organización. | Consulta la lista de miembros de la organización. |
| QueryUserInfoByUserId | Consultar información del usuario por ID de usuario. | Consulta la información del usuario por ID de usuario. |
| QueryUserInfoByAccount | Consultar información del usuario por cuenta. | Consulta la información del usuario mediante el ID de Alibaba Cloud o el nombre de la cuenta de Alibaba Cloud. |
| QueryUserByMobileAccount | Consultar userId por ID de cuenta de terceros vinculada. | Consulta un UserId mediante el ID de cuenta de terceros vinculada. |
| Gestión de grupos de usuarios de la organización | Gestión de grupos de usuarios de la organización | |
| UpdateUserGroup | UpdateUserGroup. | Actualiza la información de un grupo de usuarios especificado en una organización. |
| DeleteUserGroup | DeleteUserGroup. | Elimina un grupo de usuarios en una organización. |
| CreateUserGroup | CreateUserGroup. | Crea un grupo de usuarios. Puede especificar un grupo de usuarios principal. |
| AddUserGroupMember | AddUserGroupMember. | Agrega un miembro de la organización a un grupo de usuarios especificado. |
| AddUserGroupMembers | AddUserGroupMembers. | Agrega usuarios a un grupo de usuarios especificado de una sola vez. |
| DeleteUserGroupMember | DeleteUserGroupMember. | Elimina un miembro especificado de un grupo de usuarios especificado. |
| DeleteUserGroupMembers | DeleteUserGroupMembers. | Elimina en lote los usuarios especificados de los grupos de usuarios. |
| WithdrawAllUserGroups | WithdrawAllUserGroups. | Remueve al usuario de todos los grupos de usuarios. Este proceso es irreversible. Tenga precaución al realizar esta operación. |
| GetUserGroupInfo | Obtener información de grupos de usuarios por palabra clave. | Busca información de grupos de usuarios según la palabra clave del nombre del grupo de usuarios. |
| ListByUserGroupId | ListByUserGroupId. | Consulta la información de grupos de usuarios por ID de grupo de usuarios. |
| ListUserGroupsByUserId | ListUserGroupsByUserId. | Consulta todos los grupos de usuarios a los que pertenece un usuario según el ID del usuario. |
| QueryUserGroupListByParentId | QueryUserGroupListByParentId. | Obtiene información sobre los grupos de usuarios secundarios bajo un grupo de usuarios principal especificado. |
| QueryUserGroupMember | Consulta de la lista de miembros del grupo de usuarios. | Obtiene la lista de miembros de un grupo de usuarios. |
| TransferUsergroup | Migrar un grupo de usuarios. | Migra un grupo de usuarios. |
| Gestión de etiquetas de usuario | Gestión de etiquetas de usuario | |
| AddUserTagMeta | Agregar metadatos de etiquetas de miembros de la organización. | Agrega metadatos de etiquetas de miembros de la organización. |
| DeleteUserTagMeta | DeleteUserTagMeta. | Elimina los metadatos de etiqueta de un miembro de la organización. |
| UpdateUserTagValue | Actualizar valor de etiqueta de miembro de organización. | Actualiza el valor de la etiqueta de un miembro de la organización. |
| QueryUserTagMetaList | QueryUserTagMetaList. | Consulta la lista de metadatos de las etiquetas de miembros en una organización. |
| QueryUserTagValueList | QueryUserTagValueList. | Consulta la lista de valores de etiquetas de usuario específicas. |
| UpdateUserTagMeta | UpdateUserTagMeta. | Actualiza los metadatos de las etiquetas de los miembros de la organización. |
| ListDynamicTag | Obtener la lista de etiquetas dinámicas para la organización actual. | Obtiene la lista de etiquetas dinámicas para la organización actual. |
| ClearDynamicTagCache | Eliminar la caché de una etiqueta dinámica especificada. | Elimina el valor de etiqueta almacenado en caché para una configuración única. |
| Gestión de roles | Gestión de roles | |
| ListWorkspaceUserRolesByUserId | ListWorkspaceUserRolesByUserId. | Consulta todos los roles de espacio de trabajo de un usuario. |
| ListWorkspaceRoleUsers | ListWorkspaceRoleUsers. | Obtiene la lista de usuarios bajo el rol de espacio de trabajo especificado. |
| QueryWorkspaceRoleConfig | QueryWorkspaceRoleConfig. | Obtiene la información de configuración de un rol de espacio de trabajo especificado. |
| QueryOrganizationRoleConfig | QueryOrganizationRoleConfig. | Obtiene la configuración del rol de organización especificado. |
| ListWorkspaceRoles | ListWorkspaceRoles. | Obtiene la lista de roles del espacio de trabajo. |
| ListOrganizationRoles | Get Organization Role List. | Obtiene la lista de roles personalizados a nivel de organización. |
| ListOrganizationRoleUsers | ListOrganizationRoleUsers. | Obtiene la lista de usuarios bajo el rol de organización especificado. |
Gestión de permisos
|
API |
Título |
Descripción |
| Gestión de control de acceso | Gestión de control de acceso | |
| IpWhiteListConfig | Configura la lista blanca de IP para la seguridad de los datos. | Configura la lista blanca de IP para la seguridad de los datos. |
| Gestión de autorizaciones para compartir informes | Gestión de autorizaciones para compartir informes | |
| ListAuthConfigByResource | Consulta de registros de autorización colaborativa de un recurso. | Consulta la lista de registros de autorización colaborativa de un recurso. |
| AddShareReport | Agregar configuración de uso compartido de trabajos de datos. | Agrega una configuración de uso compartido para trabajos de datos. |
| CancelReportShare | CancelReportShare. | Elimina una autorización de uso compartido para un trabajo de datos. |
| QuerySharesToUserList | QuerySharesToUserList. | Consulta la lista de trabajos autorizados a un usuario. |
| QueryShareList | Consulta de los registros de uso compartido de un trabajo. | Consulta la lista de objetos con los que se ha compartido un trabajo y devuelve solo las configuraciones de uso compartido que aún están dentro de su período de validez. |
| AddWorksAuthorization | AddWorksAuthorization. | Agrega una autorización para un trabajo. |
| DeleteAuthorizationByUserId | Eliminar el registro de autorización colaborativa de un usuario especificado. | Elimina el registro de autorización colaborativa de un usuario especificado. |
| Gestión de autorizaciones de menús del portal de datos | Gestión de autorizaciones de menús del portal de datos | |
| AuthorizeMenu | AuthorizeMenu. | La autorización por lotes del menú del portal de BI se omitirá automáticamente. |
| CancelAuthorizationMenu | Cancelación por lotes de la autorización de menús del portal de datos. | Cancela los registros de autorización para usuarios y grupos de usuarios especificados según el ID del menú del portal. |
| ChangeVisibilityModel | ChangeVisibilityModel. | Modifica el modo de visibilidad del menú del portal de BI y si el menú solo es visible mediante autorización. |
| ListPortalMenus | ListPortalMenus. | Obtiene una lista jerárquica de menús bajo un portal de BI específico. |
| ListPortalMenuAuthorization | ListPortalMenuAuthorization. | Obtiene una lista de detalles de autorización para los menús en un portal de BI. |
| ListWhitePortalMenu | ListWhitePortalMenu. | Obtiene la lista blanca de un menú de portal de BI. |
| Gestión de permisos a nivel de fila | Gestión de permisos a nivel de fila | |
| SetDataLevelPermissionRuleConfig | Establecer la información de configuración de permisos de fila y columna para un conjunto de datos individual. | Establece la información de configuración de permisos de fila y columna para un conjunto de datos individual (adición y actualización). |
| AddDataLevelPermissionRuleUsers | AddDataLevelPermissionRuleUsers. | Agrega usuarios y grupos de usuarios especificados a una regla de permisos a nivel de fila. |
| AddDataLevelPermissionWhiteList | AddDataLevelPermissionWhiteList. | Modifica la lista blanca de permisos a nivel de fila y a nivel de columna de un conjunto de datos especificado. |
| DeleteDataLevelRuleConfig | DeleteDataLevelRuleConfig. | Elimina una regla de permisos a nivel de fila. |
| DeleteDataLevelPermissionRuleUsers | DeleteDataLevelPermissionRuleUsers. | Elimina usuarios especificados de una regla de permisos a nivel de fila. |
| UpdateDataLevelPermissionStatus | UpdateDataLevelPermissionStatus. | Actualiza el estado de los permisos a nivel de fila y a nivel de columna para un conjunto de datos. |
| SetDataLevelPermissionExtraConfig | SetDataLevelPermissionExtraConfig. | Establece la configuración adicional para los permisos de fila y columna. |
| SetDataLevelPermissionWhiteList | SetDataLevelPermissionWhiteList. | Establece la lista de permitidos para los permisos a nivel de fila especificados. |
| QueryDatasetSwitchInfo | QueryDatasetSwitchInfo. | Obtiene el estado del interruptor de permisos a nivel de fila para un conjunto de datos especificado. |
| ListCubeDataLevelPermissionConfig | ListCubeDataLevelPermissionConfig. | Obtiene una lista de configuraciones de permisos de fila y columna para un conjunto de datos especificado. |
| ListDataLevelPermissionWhiteList | Get Dataset Row and Column Permission Whitelist | Obtiene la lista blanca de permisos de filas y columnas del conjunto de datos según el tipo de permiso. |
| Aprobación abierta | Aprobación abierta | |
| QueryApprovalInfo | QueryApprovalInfo. | Obtiene la información del flujo de aprobación según el aprobador. |
| ResultCallback | ResultCallback. | Permite personalizar la interfaz de devolución de llamada para los procesos de aprobación con el fin de procesar los procesos de aprobación de Quick BI. |
Gestión de recursos
|
API |
Título |
Descripción |
| Gestión de recursos de informes | Gestión de recursos de informes | |
| UpdateEmbeddedStatus | UpdateEmbeddedStatus. | Cambia el estado de incrustación de un informe; activa o desactiva la incrustación. |
| QueryWorksByOrganization | Consultar todos los trabajos de la organización. | Consulta todos los trabajos de toda la organización, con la opción de especificar el tipo de trabajo. |
| QueryWorksByWorkspace | QueryWorksByWorkspace. | Consulta todos los trabajos en un espacio de trabajo bajo una organización. Puede especificar el tipo de trabajo. |
| QueryReadableResourcesListByUserIdV2 | Consulta la lista de obras que el usuario tiene permiso para ver (nuevo) | Consulta la lista de obras que el usuario tiene permiso para ver (nuevo). |
| QueryReadableResourcesListByUserId | QueryReadableResourcesListByUserId. | Consulta la lista de trabajos que un usuario tiene permiso para ver, incluidas las declaraciones autorizadas para compartir en un espacio. |
| CheckReadable | CheckReadable. | Consulta si un usuario tiene permisos para ver trabajos de datos, como paneles y libros de trabajo. |
| QueryEmbeddedInfo | QueryEmbeddedInfo. | Obtiene la configuración de incrustación en la organización, incluido el número máximo de incrustaciones y la cantidad de incrustaciones. |
| QueryEmbeddedStatus | QueryEmbeddedStatus. | Consulta si la inserción está habilitada para un informe. |
| QueryWorks | Consulta de información de trabajos de datos. | Consulta la información de un trabajo de datos especificado. |
| QueryWorksBloodRelationship | QueryWorksBloodRelationship. | Obtiene el linaje de un trabajo de datos, incluidos los conjuntos de datos referenciados por cada componente y la información de los campos de consulta. Actualmente, los únicos trabajos de datos compatibles son los paneles, los libros de trabajo y la recuperación de datos de autoservicio. |
| QueryComponentPerformance | QueryComponentPerformance. | Consulta los registros de rendimiento de componentes. |
| QueryReportPerformance | QueryReportPerformance. | Consulta los registros de rendimiento de informes. |
| GetWorksEmbedList | Get Embedded Reports. | Consulta la lista de informes integrados. |
| Gestión de recursos de conjuntos de datos | Gestión de recursos de conjuntos de datos | |
| UpdateDataSource | UpdateDataSource. | Modifica una configuración de origen de datos. |
| CreateDataset | CreateDataset. | Crea un conjunto de datos a partir de una tabla física. |
| CheckDatasetExisted | CheckDatasetExisted. | Verifica si existe un conjunto de datos con el CubeId especificado. |
| CreateCubeBySql | Crear un conjunto de datos basado en SQL personalizado. | Crea un conjunto de datos basado en una sentencia SQL personalizada. |
| AddDataSource | AddDataSource. | Agrega un origen de datos. |
| UpdateCubeBySql | Actualizar un conjunto de datos SQL personalizado. | Actualiza un conjunto de datos SQL personalizado. |
| QueryLastAccelerationEngineJob | QueryLastAccelerationEngineJob. | Consulta la tarea de aceleración más reciente por ID de conjunto de datos. |
| ListDataSource | ListDataSource. | Consulta todos los orígenes de datos en el espacio especificado. |
| DataSetBlood | DataSetBlood. | Consulta la información de obras en el conjunto de datos especificado. |
| DataSourceBlood | Consulta la información del conjunto de datos en el origen de datos especificado. | Consulta la información del conjunto de datos en el origen de datos especificado. |
| ModifyApiDatasourceParameters | ModifyApiDatasourceParameters. | Modifica las configuraciones de un origen de datos de API especificado. |
| ListApiDatasource | ListApiDatasource. | Consulta orígenes de datos de API. |
| QueryDatasetInfo | QueryDatasetInfo. | Indica si la tabla es una tabla SQL personalizada. Valores válidos: \\* true: tabla SQL personalizada \\* false: tabla no SQL personalizada |
| QueryDatasetDetailInfo | QueryDatasetDetailInfo. | Obtiene los detalles de un conjunto de datos especificado, incluida su fuente de datos, directorio y modelo de conjunto de datos. |
| QueryDatasetList | Consultar lista de conjuntos de datos. | Consulta los conjuntos de datos en un espacio de trabajo especificado. Los resultados se ordenan en orden descendente por hora de creación. |
| AllotDatasetAccelerationTask | AllotDatasetAccelerationTask. | Activa la aceleración de recopilación del motor Quick para conjuntos de datos. |
| QueryCubePerformance | QueryCubePerformance. | Consulta los registros de rendimiento de un conjunto de datos. |
| QueryCubeOptimization | QueryCubeOptimization. | Consulta sugerencias de optimización de conjuntos de datos. |
| GetDataSourceConnectionInfo | GetDataSourceConnectionInfo. | Obtiene la información del origen de datos. |
| ListAccelerationOfWorkspace | ListAccelerationOfWorkspace. | Obtiene información sobre las tareas de aceleración en un espacio de trabajo. |
| QueryAccelerationLogByCubeId | QueryAccelerationLogByCubeId. | Consulta los registros de ejecución de tareas de aceleración para un conjunto de datos especificado. |
| Gestión de espacios de trabajo | Gestión de espacios de trabajo | |
| CreateWorkspace | CreateWorkspace. | Crea un espacio de trabajo. |
| AddUserToWorkspace | Agregar miembro al espacio de trabajo. | Agrega un miembro a un espacio de trabajo especificado. |
| AddWorkspaceUsers | Agregar miembros al espacio de trabajo en lote. | Agrega miembros al espacio de trabajo en lote. |
| DeleteUserFromWorkspace | Eliminar miembro del espacio de trabajo. | Elimina un miembro del espacio de trabajo especificado. |
| UpdateWorkspaceUsersRole | Actualización en lote de roles de miembros del espacio de trabajo. | Actualiza en lote la información de roles de los miembros del espacio de trabajo; los roles existentes se sobrescribirán. |
| UpdateWorkspaceUserRole | Modificar rol de miembro del espacio de trabajo. | Modifica el rol de un miembro especificado en el espacio de trabajo; los roles existentes se sobrescribirán. |
| QueryWorkspaceUserList | Listar miembros de un espacio de trabajo. | Consulta la lista de miembros de un espacio de trabajo especificado. |
| QueryOrganizationWorkspaceList | Obtener lista de espacios de trabajo en una organización. | Obtiene la lista de espacios de trabajo en la organización actual. |
| QueryUserRoleInfoInWorkspace | Consulta de roles predefinidos de miembros del espacio de trabajo. | Obtiene la información de roles predefinidos del espacio de trabajo para un miembro especificado. |
| Gestión de favoritos | Gestión de favoritos | |
| SaveFavorites | Agregar trabajo a favoritos. | Agrega un trabajo favorito de un usuario. |
| CancelCollection | CancelCollection. | Cancela la recopilación de obras de datos del usuario. |
| Gestión de la página de inicio | Gestión de la página de inicio | |
| ListCollections | ListCollections. | Obtiene la lista de trabajos que un usuario ha marcado como favoritos. |
| ListFavoriteReports | Lista de informes favoritos en el panel principal. | Descripción general. |
| ListRecentViewReports | ListRecentViewReports. | Obtiene una lista de los trabajos más visitados y del historial de navegación que se muestran en el panel principal de un usuario especificado. |
| ListSharedReports | ListSharedReports. | Obtiene la lista de trabajos autorizados que se muestran en la página principal de un usuario especificado. |
| Gestión de suscripciones | Gestión de suscripciones | |
| ManualRunMailTask | ManualRunMailTask. | Ejecuta manualmente una tarea de correo electrónico. |
| GetMailTaskStatus | GetMailTaskStatus. | Consulta el estado de ejecución de las tareas de correo dentro de una organización. |
| GetMailTaskList | GetMailTaskList. | Obtiene una lista de tareas de seguimiento. Nota: Si la AccessKey (AK) del solicitante no tiene permiso para ver las tareas de seguimiento de otros usuarios, esta operación devuelve únicamente las tareas a las que el solicitante está autorizado a acceder. |
Gestión de datos
|
API |
Título |
Descripción |
| Servicio de datos | Servicio de datos | |
| QueryData | QueryData. | Llama a una API de DataService Studio para consultar datos. |
| QueryDataServiceList | QueryDataServiceList. | Consulta la lista de API del servicio de datos. |
| QueryDataService | Invocar API del servicio de datos. | Invoca una API ya creada en el servicio de datos. |
Analítica integrada
|
API |
Título |
Descripción |
| Inserción de informes | Inserción de informes | |
| CreateTicket | Generar un ticket de reporte incrustado. | Genera un ticket necesario para el acceso a reportes incrustados. |
| DeleteTicket | Eliminar ticket insertado. | Elimina un ticket insertado de terceros. |
| DelayTicketExpireTime | DelayTicketExpireTime. | Actualiza la hora de vencimiento del ticket integrado en el informe. |
| UpdateTicketNum | UpdateTicketNum. | Actualiza la cantidad de tickets en el ticket especificado utilizado para el informe integrado de exención. |
| QueryTicketInfo | QueryTicketInfo. | Obtiene los detalles de un ticket especificado para un informe que no está incrustado en el informe. |
Análisis estadístico
|
API |
Título |
Descripción |
| Análisis de recursos | Análisis de recursos | |
| QueryAuditLog | Consulta de información del registro de auditoría. | Consulta la información del registro de auditoría. |
Chat de IA
|
API |
Título |
Descripción |
| Inserción de chat de IA | Inserción de chat de IA | |
| CreateTicket4Copilot | Generate Smart Q Embedding Ticket | Genera un ticket para integrar Copilot. |
| ModifyCopilotEmbedConfig | Modify Intelligent Query Embedding Configuration | Modifica la configuración de incrustación de consulta inteligente. |
| QueryCopilotEmbedConfig | Obtener la lista de configuraciones para activar XiaoQ Embedding. | Obtiene la lista de configuraciones para activar la integración de XiaoQ. |
| QueryDataRange | Get Data Range Catalog List | Obtiene la lista del catálogo de rangos de datos. |
| Gestión de chat de IA | Gestión de chat de IA | |
| ModifyDashboardNl2sqlStatus | ModifyDashboardNl2sqlStatus. | Modifica el estado de Q-Assistant para varios paneles. |
| QueryDashboardNl2sql | QueryDashboardNl2sql. | Consulta la información de recursos de preguntas del panel. |
| SmartqAuthorize | Gestión por lotes de autorizaciones de Preguntas y respuestas inteligentes. | Gestiona las autorizaciones de Preguntas y respuestas inteligentes en lotes. |
| QueryLlmCubeWithThemeListByUserId | Verificar para qué conjuntos de datos y temas de análisis tiene autorización de consulta el usuario | Verifica para qué conjuntos de datos y temas de análisis tiene autorización de consulta el usuario. |
| SmartqAuthTransfer | Sincronizar los permisos de recuento de preguntas de un usuario especificado con otros usuarios. | Sincroniza los permisos de recuento de preguntas de un usuario especificado con otros usuarios. |
| QuerySmartqPermissionByCubeId | Verificar si un usuario tiene permiso para un conjunto de datos específico de preguntas y respuestas inteligentes. | Consulta los permisos de un usuario sobre un conjunto de datos de Preguntas y respuestas inteligentes. |
| QueryDatasetSmartqStatus | Verificar si el conjunto de datos tiene habilitada la consulta inteligente. | Verifica si la función de preguntas y respuestas inteligentes está habilitada para un conjunto de datos. |
| SmartqQueryAbility | Consulta de Preguntas y respuestas inteligentes. | Consulta datos mediante la función de Preguntas y respuestas inteligentes. |