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

Consulta la lista de datasets en un espacio de trabajo especificado, ordenada por hora de creación en orden descendente.

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

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo.	95296e95-ca89-4c7d-8af9-dedf0ad0****
DirectoryId	string	No	El ID del directorio. Si se especifica este parámetro, se devuelven todos los datasets del directorio especificado.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
WithChildren	boolean	No	Especifica si se deben incluir recursivamente los datasets de los subdirectorios. Valores válidos: true: devuelve los datasets de todos los subdirectorios bajo el directorio especificado por directoryId, de forma recursiva. false: devuelve solo los datasets del directorio especificado por directoryId, sin incluir los subdirectorios.	true
Keyword	string	No	La palabra clave utilizada para buscar nombres de datasets.	test
PageNum	integer	No	El número de página de la lista de datasets. Valor mínimo: 1 Valor predeterminado: 1	1
PageSize	integer	No	El número de filas por página para una consulta paginada. Valor predeterminado: 10 Valor máximo: 1000	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
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	El resultado paginado de la lista de datasets. La información detallada de la lista de datasets se almacena en el parámetro de respuesta Data.
Data	array<object>	Los detalles de la lista de datasets.
	array<object>
CreateTime	string	La hora de creación, en formato yyyy-MM-dd HH:mm:ss.	2020-11-02 10:36:05
DataSource	object	La información de la fuente de datos del dataset.
DsId	string	El ID de la fuente de datos.	261b252d-c3c3-498a-a0a7-5d1ec6cd****
DsName	string	El nombre de la fuente de datos.	test
DsType	string	El tipo de fuente de datos.	mysql
DatasetId	string	El ID del dataset.	5820f58c-c734-4d8a-baf1-7979af4f****
DatasetName	string	El nombre del dataset.	company_sales_record_copy12
Description	string	La descripción del dataset.	test
Directory	object	La información del directorio del dataset.
Id	string	El ID del directorio.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
Name	string	El nombre del directorio.	test
PathId	string	El ID de la ruta del directorio.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
PathName	string	El nombre de la ruta del directorio.	test
ModifyTime	string	La hora de modificación, en formato yyyy-MM-dd HH:mm:ss.	2020-11-02 10:36:05
OpenOfflineAcceleration	boolean	Indica si la aceleración de extracción está habilitada. Valores válidos: true: habilitada. false: deshabilitada.	true
OwnerId	string	El ID de usuario de Quick BI del propietario del dataset.	136516262323****
OwnerName	string	El alias del propietario del dataset.	test
RowLevel	boolean	Indica si los permisos de nivel de fila están habilitados. Valores válidos: true: habilitados. false: deshabilitados.	true
WorkspaceId	string	El ID del espacio de trabajo.	95296e95-ca89-4c7d-8af9-dedf0ad06adf
WorkspaceName	string	El nombre del espacio de trabajo.	test
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": [
      {
        "CreateTime": "2020-11-02 10:36:05",
        "DataSource": {
          "DsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****",
          "DsName": "test",
          "DsType": "mysql"
        },
        "DatasetId": "5820f58c-c734-4d8a-baf1-7979af4f****",
        "DatasetName": "company_sales_record_copy12",
        "Description": "test",
        "Directory": {
          "Id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "Name": "test",
          "PathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "PathName": "test"
        },
        "ModifyTime": "2020-11-02 10:36:05",
        "OpenOfflineAcceleration": true,
        "OwnerId": "136516262323****",
        "OwnerName": "test",
        "RowLevel": true,
        "WorkspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad06adf",
        "WorkspaceName": "test"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	El espacio de trabajo no pertenece a la organización.
400	CubeSchema.Not.Exist	The cube schema does not exist.	El modelo de conjunto de datos no existe.

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.