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

Consulta todos los trabajos de una organización. Puede especificar el tipo de trabajo.

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

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorksType	string	No	El tipo de trabajo que se va a consultar. Deje este parámetro vacío para consultar todos los tipos. Valores válidos: DATAPRODUCT: portal de datos PAGE: dashboard REPORT: libro de trabajo dashboardOfflineQuery: consulta personalizada	PAGE
Status	integer	No	El estado de los trabajos que se van a consultar. Valores válidos: 0: Sin publicar. 1: Publicado. 2: Modificado pero no publicado. 3: Fuera de línea.	0
ThirdPartAuthFlag	integer	No	El estado de incrustación de terceros. Valores válidos: 0: La incrustación no está habilitada. 1: La incrustación está habilitada.	1
PageNum	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de filas por página. Valor predeterminado: 10.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Success	boolean	Indica si la solicitud se completó correctamente. Valores válidos: true: La solicitud se completó correctamente. false: La solicitud falló.	true
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	La lista de todos los trabajos de la organización que coinciden con las condiciones de la solicitud.
Data	array<object>	Los detalles de la lista de trabajos.
	array<object>
Auth3rdFlag	integer	El estado de incrustación de terceros. Valores válidos: 0: La incrustación no está habilitada. 1: La incrustación está habilitada.	1
Description	string	La descripción del trabajo.	Remarks
Directory	object	El directorio al que pertenece el trabajo.
Id	string	El ID del directorio.	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	El nombre del directorio.	Test directory
PathId	string	La estructura jerárquica de los ID de directorio, separados por barras diagonales (/).	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	La estructura jerárquica de los nombres de directorio, separados por barras diagonales (/).	Test directory
GmtCreate	string	La marca de tiempo en que se creó el trabajo, en milisegundos.	1496651577000
GmtModify	string	La marca de tiempo en que se modificó por última vez el trabajo, en milisegundos.	1572334870000
ModifyName	string	El nombre de la cuenta de Alibaba Cloud del usuario que modificó por última vez el trabajo.	John
OwnerId	string	El ID de usuario de Quick BI del propietario del trabajo.	The name of the workspace to which the work belongs
OwnerName	string	El nombre de la cuenta de Alibaba Cloud del propietario del trabajo.	Jane
PublicFlag	boolean	Indica si el trabajo es público.	true
PublicInvalidTime	integer	La fecha de vencimiento del informe público, en formato de marca de tiempo UNIX. Unidad: milisegundos.	1721366354000
SecurityLevel	string	La política de seguridad para la autorización colaborativa del trabajo. Valores válidos: 0: Privado. 12: Autorizado a miembros especificados. 1 o 11: Autorizado a todos los miembros del espacio de trabajo. Nota Si usa los permisos heredados, el valor devuelto es 1. Si usa los permisos nuevos, el valor devuelto es 11.	1
Status	integer	El estado del informe. Valores válidos: 0: Sin publicar. 1: Publicado. 2: Modificado pero no publicado. 3: Fuera de línea.	1
WorkName	string	El nombre del trabajo.	Test report
WorkType	string	El tipo de trabajo. Valores válidos: DATAPRODUCT: portal de datos PAGE: dashboard REPORT: libro de trabajo dashboardOfflineQuery: consulta personalizada	PAGE
WorksId	string	El ID del trabajo.	897ce25e-**--af84-d13c5610**
WorkspaceId	string	El ID del espacio de trabajo al que pertenece el trabajo.	The Alibaba Cloud account name of the user who last modified the work
WorkspaceName	string	El nombre del espacio de trabajo al que pertenece el trabajo.	Test workspace
PageNum	integer	El número de página.	1
PageSize	integer	El número de filas por página especificado en la solicitud.	10
TotalNum	integer	El número total de filas.	1
TotalPages	integer	El número total de páginas.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Auth3rdFlag": 1,
        "Description": "备注",
        "Directory": {
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "Name": "测试目录",
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "测试目录"
        },
        "GmtCreate": "1496651577000",
        "GmtModify": "1572334870000",
        "ModifyName": "张三",
        "OwnerId": "作品所属工作空间名称",
        "OwnerName": "李四",
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000,
        "SecurityLevel": "1",
        "Status": 1,
        "WorkName": "测试报表",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorkspaceId": "作品修改者的阿里云账户名",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

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.