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

Consulta la información de un trabajo de datos 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:QueryWorks

get

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorksId	string	Sí	El ID del reporte.	abcd****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Los detalles del trabajo de datos.
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.	0
Description	string	Las observaciones del trabajo de datos.	Observaciones
Directory	object	El directorio al que pertenece el trabajo de datos.
Id	string	El ID del directorio al que pertenece el trabajo de datos.	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	El nombre del directorio.	DirectorioDePrueba
PathId	string	La ruta jerárquica de los ID de directorio, separados por una barra diagonal (/).	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	La ruta jerárquica de los nombres de directorio, separados por una barra diagonal (/).	DirectorioDePrueba
GmtCreate	string	La marca de tiempo en la que se creó el trabajo de datos, en milisegundos.	1496651577000
GmtModify	string	La marca de tiempo de la última modificación del trabajo de datos, en milisegundos.	1496651577000
ModifyName	string	El nombre de la cuenta de Alibaba Cloud del usuario que modificó por última vez el trabajo de datos.	John
OwnerId	string	El ID de usuario de Quick BI del propietario del trabajo de datos.	9187a612aa474e2a8ac1414d5529****
OwnerName	string	El nombre de la cuenta de Alibaba Cloud del propietario del trabajo de datos.	John
PublicFlag	boolean	Indica si el trabajo de datos es público.	true
PublicInvalidTime	integer	La fecha de vencimiento para el acceso público del reporte. Este valor es una marca de tiempo UNIX en milisegundos.	1721366354000
SecurityLevel	string	La política de seguridad para la autorización colaborativa del trabajo de datos. Valores válidos: 0: Privado. 12: Autorizado para miembros especificados. 1 o 11: Autorizado para todos los miembros del espacio de trabajo. Nota Si utiliza el modelo de permisos heredado, el valor devuelto es 1. Si utiliza el nuevo modelo de permisos, el valor devuelto es 11.	0
Status	integer	El estado del reporte. Valores válidos: 0: No publicado. 1: Publicado. 2: Modificado pero no publicado. 3: Fuera de línea.	0
WorkName	string	El nombre del trabajo de datos.	ReporteDePrueba
WorkType	string	El tipo de trabajo de datos. Deje este parámetro vacío para consultar todos los tipos. Valores válidos: DATAPRODUCT: portal de datos PAGE: panel de control FULLPAGE: panel de control a pantalla completa REPORT: libro de trabajo dashboardOfflineQuery: consulta personalizada	PAGE
WorksId	string	El ID del trabajo de datos.	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorkspaceId	string	El ID del espacio de trabajo al que pertenece el trabajo de datos.	87c6b145-090c-43e1-9426-8f93be23****
WorkspaceName	string	El nombre del espacio de trabajo al que pertenece el trabajo de datos.	EspacioDeTrabajoDePrueba
GlobalParamVoList	array<object>	La matriz de parámetros globales.
	object	El objeto de parámetro global.
DataType	string	El tipo de campo. Valores válidos: enum: enumeración string: texto number: numérico datetime: fecha	string
ParamName	string	El nombre del parámetro.	lastQueryAt
ParamAlias	string	El alias del parámetro.	lastQueryAt
Required	boolean	Indica si el parámetro es obligatorio.	false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Auth3rdFlag": 0,
    "Description": "Remarks",
    "Directory": {
      "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "Name": "TestDirectory",
      "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "PathName": "TestDirectory"
    },
    "GmtCreate": "1496651577000",
    "GmtModify": "1496651577000",
    "ModifyName": "John",
    "OwnerId": "9187a612aa474e2a8ac1414d5529****",
    "OwnerName": "John",
    "PublicFlag": true,
    "PublicInvalidTime": 1721366354000,
    "SecurityLevel": "0",
    "Status": 0,
    "WorkName": "TestReport",
    "WorkType": "PAGE",
    "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
    "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
    "WorkspaceName": "TestWorkspace",
    "GlobalParamVoList": [
      {
        "DataType": "string",
        "ParamName": "lastQueryAt",
        "ParamAlias": "lastQueryAt",
        "Required": false
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Invalid.Works.Empty	This work does not exist. It may have been deleted. Work ID is %s.	El trabajo no existe. Es posible que se haya eliminado. ID de trabajo: %s.
400	Resource.NotBelongTo.CurrentOrganization	The resource does not belong to the current organization.	El recurso no pertenece a la organización actual.

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.