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

Consulta la lista de informes incrustados.

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:GetWorksEmbedList

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WsId	string	No	El ID del espacio de trabajo.	919818-*-***-wdasd
WorksType	string	No	El tipo de informe. Valores válidos: page: panel de control. screen: pantalla de datos. report: libro de trabajo. ANALYSIS: análisis ad hoc. dashboardOfflineQuery: recuperación de datos de autoservicio. dataForm: formulario de entrada de datos. Valores válidos: dataForm : Formulario de entrada de datos. dashboardOfflineQuery : Recuperación de datos de autoservicio. report : Libro de trabajo. screen : Pantalla de datos. ANALYSIS : Análisis ad hoc. page : Panel de control.	page
Keyword	string	No	El nombre del informe para la coincidencia aproximada.	Conjunto de datos de prueba
PageNo	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10.	100

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	38C0F***0-4159F1-***422BDB65
Result	object	El objeto de matriz de informes.
Data	array<object>	La matriz de informes.
	object	El objeto de informe.
EmbedTime	string	La hora en que se incrustó el informe, en formato YYYY-mm-DD hh:MM:ss.	YYYY-mm-DD hh:MM:ss
WorksId	string	El ID del informe.	897ce25e-**--af84-d13c5610**
WorksName	string	El nombre del informe.	Prueba
WorksType	string	El tipo de informe.	page
WorkspaceId	string	El ID del espacio de trabajo al que pertenece el informe.	87c6b145-**-43e1-9426-8f93be23**
PageNo	integer	El número de página.	1
PageSize	integer	El número de entradas por página.	10
TotalNum	integer	El número total de entradas.	18
TotalPages	integer	El número total de páginas.	2
Success	boolean	Indica si la solicitud se realizó correctamente.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "38C0F*****0-415****9F1-*****422BDB65",
  "Result": {
    "Data": [
      {
        "EmbedTime": "YYYY-mm-DD hh:MM:ss",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorksName": "测试哦",
        "WorksType": "page",
        "WorkspaceId": "87c6b145-****-43e1-9426-8f93be23****"
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "TotalNum": 18,
    "TotalPages": 2
  },
  "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.