ListSharedReports - Quick BI - Centro de documentación de Alibaba Cloud

Obtiene la lista de trabajos autorizados que se muestran en la página principal de un usuario especificado.

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

quickbi-public:ListSharedReports

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
UserId	string	Sí	El UserID del usuario que se va a consultar en Quick BI.	b5d8fd9348cc4327****afb604
Keyword	string	No	La palabra clave del nombre del trabajo.	测试报表
TreeType	string	No	El tipo de trabajo que se va a consultar (déjelo en blanco para consultar todos los tipos). Valores válidos: DATAPRODUCT: portal de BI PAGE: panel de control REPORT: libro de trabajo	PAGE
PageSize	integer	No	El número de filas en la lista de trabajos que se va a consultar: Valor predeterminado: 10. Valor máximo: 9999	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Se devuelven los resultados de la consulta.
Data	array<object>	La lista de trabajos consultados.
	object
Favorite	boolean	Indica si el usuario ha marcado el trabajo como favorito.	true
GmtCreate	string	La marca de tiempo cuando se creó el trabajo.	1640088615000
GmtModified	string	La marca de tiempo cuando se modificó el trabajo.	1644373980000
HasEditAuth	boolean	El usuario de la consulta tiene permisos de edición sobre el trabajo.	true
HasViewAuth	boolean	El usuario de la consulta tiene permiso para ver el trabajo.	true
Name	string	El nombre del trabajo.	测试报表
OwnerName	string	El nombre de la cuenta de Alibaba Cloud del propietario del trabajo.	test账号
OwnerNum	string	El UserID del propietario del trabajo.	1365*****238860
PublishStatus	integer	El estado de publicación del trabajo. Valores válidos: 0: no publicado 1: publicado 2: modificado y guardado, pero no publicado. 3: no publicado	1
TreeId	string	El ID del trabajo.	977c7698-**--**-44b7304d20fc
Type	string	El tipo de trabajo. Valores válidos: DATAPRODUCT: portal de BI PAGE: panel de control REPORT: libro de trabajo	PAGE
WorkspaceId	string	El ID del espacio de trabajo al que pertenece el trabajo.	gfidm145-**--9426-8f93be23**
WorkspaceName	string	El nombre del espacio de trabajo al que pertenece el trabajo.	测试工作空间
PageNum	integer	El número de la página devuelta.	1
PageSize	integer	El número de filas por página establecido al solicitar la interfaz.	10
TotalNum	integer	El número total de filas en la tabla.	1
TotalPages	integer	El número total de páginas devueltas.	1
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Favorite": true,
        "GmtCreate": "1640088615000",
        "GmtModified": "1644373980000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "Name": "测试报表",
        "OwnerName": "test账号",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "WorkspaceId": "gfidm145-****-****-9426-8f93be23****",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Códigos de 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.