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

Descripción de la operación

La respuesta incluye la fuente de datos, el directorio y un modelo de conjunto de datos que contiene dimensiones, medidas, campos físicos, texto SQL personalizado y relaciones.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DatasetId	string	Sí	El ID del conjunto de datos.	5820f58c-c734-4d8a-baf1-7979af4f****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.
RequestId	string	El ID de la solicitud.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	string	Los detalles del conjunto de datos, devueltos en formato JSON: { "cube": { "dimensions": [ { "caption": "Nombre del cliente", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "customer_name", "uid": "N5820f5_customer_name" }, { "caption": "ID del pedido", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "order_id", "uid": "N5820f5_order_id" } ], "measures": [ { "caption": "Monto del pedido", "dataType": "number", "factColumn": "order_amt", "measureType": "standard_measure", "uid": "N5820f5_order_amt" } ], "table": { "customsql": false, "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd**", "tableName": "company_sales_record_copy" } }, "datasetId": "5820f58c-c734-4d8a-baf1-7979af4f", "datasetName": "company_sales_record_copy12", "datasource": { "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd", "dsName": "Base de datos privada del usuario", "dsType": "mysql" }, "directory": { "id": "schemaad8aad00-9c55-4984-a767-b4e0ec60", "name": "Mis conjuntos de datos", "pathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60", "pathName": "Mis conjuntos de datos" }, "ownerId": "13651626232", "ownerName": "Zhang San", "rowLevel": false, "workspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad0**", "workspaceName": "Espacio de trabajo de prueba" }	Devuelve los datos del conjunto de datos en formato JSON; consulte la descripción a la izquierda para obtener más información
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": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": "返回JSON格式的数据集数据，详见左侧说明。",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Cube.Not.Exist	The Cube does not exist.	The Cube does not exist.
400	Not.WorkspaceCube.Error	You can only use the %s dataset of the current workspace.	You can only use the dataset of the current workspace.
400	DatasourceId.IsNull.Error	You must select a data source before selecting the table.	You must select a data source before selecting the table.
400	Datasource.UserPermission.Error	You do not have datasource authorization.	You do not have datasource authorization.
400	CubeDimension.NotExist.Error	The dimension does not exist in the dataset. The dimension ID is %s.	The dimension does not exist in the dataset. The dimension ID:%s.

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.