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

Consulta la lista de API del servicio de datos.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Name	string	No	El nombre del servicio de datos.	测试sql
UserId	string	No	El ID de usuario.	dasdfdsa-csddf-dsadsa
PageNo	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de elementos por página en una consulta paginada: Valor predeterminado: 10 Valor máximo: 1000	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	El resultado devuelto.
Data	array<object>	La información del servicio de datos.
	array<object>
Content	object	El modelo del servicio de datos en formato JSON.
CubeId	string	El ID identificador del cubo.	56f9f34a-bdba-496a-91a3-a18b1ff73a80
CubeName	string	El nombre del conjunto de datos.	测试数据集
Detail	boolean	Detalle o resumen.	true
Filter	object	La información de los parámetros de la solicitud.
Filters	array<object>	Las condiciones combinadas.
	object	Cadena JSON de la lista detallada de menús jerárquicos del portal. El rango de valores incluye: Type: tipo. 1.basic: básico 2.combined: complejo field: campo correspondiente del cubo alias: nombre del parámetro desc: descripción del campo aggregator: función de agregación operator: operador essential: si es obligatorio defaultValue: valor predeterminado del sistema. Si no se proporciona en la llamada a la API, este valor se utilizará como reemplazo. interval: desplazamiento de fecha. Es válido para fechas y representa el valor relativo respecto al valor predeterminado o al valor del parámetro. logicalOperator: operador lógico filters: condiciones combinadas (esta es una estructura anidada)	[{ "field": { "fid": "1c1f88cb7d", "granularity": "yearRegion", "dataType": "datetime", "column": "s_date", "caption": "日期(year)", "type": "dimension" }, "defaultValue": ["2024"], "alias": "s_date", "type": "basic", "operator": "equal-to", "essential": true }]
LogicalOperator	string	La relación lógica entre múltiples palabras clave de texto SQL. or: o and: y	and
Type	string	El tipo. basic: básico combined: complejo	basic
ReturnFields	array<object>	La información devuelta.
	array<object>
Aggregator	string	El operador de agregación. Por ejemplo, SUM, AVG y MAX.	SUM
Alias	string	El nombre del parámetro del campo.	s_number
Desc	string	El comentario del campo devuelto.	主题配置已存在
Field	object	La información del campo correspondiente del cubo.
Caption	string	El nombre para mostrar en el modelo de cubo (puede estar en chino o inglés).	日期(year)
Column	string	El nombre del campo físico correspondiente.	shid_star
DataType	string	El tipo de datos. number: numérico string: cadena date: fecha datetime: fecha y hora time: hora geographic: geográfico boolean: booleano url: URL	datetime
Fid	string	El identificador único del campo original.	1c1f88cb7d
Granularity	string	Este atributo se incluye para dimensiones de fecha y geográficas, e indica la granularidad admitida.	yearRegion
Name	string	El nombre único del campo del cubo, utilizado principalmente para la identificación única en el resultado devuelto.	sss
Type	string	El tipo. Dimension: Dimensión Measure: Medida	dimension
Orderby	string	La ordenación. asc: Ascendente desc: Descendente no: Sin ordenación	no
CreatorId	string	El ID del creador.	7cb94cd48701
CreatorName	string	El nombre del creador.	张仔龙
CubeId	string	El ID identificador del cubo.	d14e7448-0eb3-40d3-9375-4afef8de29fd
CubeName	string	El nombre del conjunto de datos.	测试数据集
Desc	string	La descripción.	测试用
GmtCreate	string	La hora de creación.	2023-05-18 14:00:02.0
GmtModified	string	La hora de modificación.	2023-03-21 18:02:36
ModifierId	string	El userId del modificador.	7cb94cd48701
ModifierName	string	El nombre del modificador.	张仔龙
Name	string	El nombre del servicio de datos.	测试报表
OwnerId	string	El ID del propietario.	862801339
OwnerName	string	El nombre del propietario.	李四
Sid	string	El ID único del servicio de datos.	dtsuq3i31f5j8v848b
WorkspaceId	string	El ID del espacio de trabajo.	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	El nombre del espacio de trabajo.	测试工作空间
PageNum	integer	El número de página.	1
PageSize	integer	El número de registros por página.	10
TotalNum	integer	El número total de filas.	1
TotalPages	integer	El número total de páginas.	1
Success	boolean	Indica si la solicitud fue exitosa. Rango de valores: true: La solicitud fue exitosa. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "78C1AA2D-9201-599E-A0BA-6FC462E57A95",
  "Result": {
    "Data": [
      {
        "Content": {
          "CubeId": "56f9f34a-bdba-496a-91a3-a18b1ff73a80",
          "CubeName": "测试数据集",
          "Detail": true,
          "Filter": {
            "Filters": [
              [
                {
                  "field": {
                    "fid": "1c1f88cb7d",
                    "granularity": "yearRegion",
                    "dataType": "datetime",
                    "column": "s_date",
                    "caption": "日期(year)",
                    "type": "dimension"
                  },
                  "defaultValue": [
                    "2024"
                  ],
                  "alias": "s_date",
                  "type": "basic",
                  "operator": "equal-to",
                  "essential": true
                }
              ]
            ],
            "LogicalOperator": "and",
            "Type": "basic"
          },
          "ReturnFields": [
            {
              "Aggregator": "SUM",
              "Alias": "s_number",
              "Desc": "主题配置已存在。",
              "Field": {
                "Caption": "日期(year)",
                "Column": "shid_star",
                "DataType": "datetime",
                "Fid": "1c1f88cb7d",
                "Granularity": "yearRegion",
                "Name": "sss",
                "Type": "dimension"
              },
              "Orderby": "no"
            }
          ]
        },
        "CreatorId": "7cb94cd48701",
        "CreatorName": "张仔龙",
        "CubeId": "d14e7448-0eb3-40d3-9375-4afef8de29fd",
        "CubeName": "测试数据集",
        "Desc": "测试用",
        "GmtCreate": "2023-05-18 14:00:02.0",
        "GmtModified": "2023-03-21 18:02:36",
        "ModifierId": "7cb94cd48701",
        "ModifierName": "张仔龙\n",
        "Name": "测试报表",
        "OwnerId": "862801339",
        "OwnerName": "李四",
        "Sid": "dtsuq3i31f5j8v848b",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Invalid.User.Organization	The user is not in your organization.

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.