QueryDataServiceList - list data service APIs - Quick BI

Lists data service APIs with pagination support.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryDataServiceList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	Data service name.	测试sql
UserId	string	No	User ID.	dasdfdsa-csddf-dsadsa
PageNo	integer	No	Page number. Default value: 1.	1
PageSize	integer	No	Items per page. Default value: 10 Maximum value: 1000	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	Query result.
Data	array<object>	Data service list.
	array<object>
Content	object	Data service model in JSON format.
CubeId	string	Cube ID.	56f9f34a-bdba-496a-91a3-a18b1ff73a80
CubeName	string	Dataset name.	测试数据集
Detail	boolean	Detail or Summary	true
Filter	object	Request parameters.
Filters	array<object>	Combined conditions.
	object	Filter condition details. Properties: Type: type. 1.basic: basic 2.combined: complex field: corresponding cube field alias: parameter name desc: field description aggregator: aggregation function operator: operator essential: whether it is required defaultValue: system default value. If not provided in the API call, this value will be used as a replacement. interval: date offset. This is valid for dates, representing the relative value to the default value or the parameter value. logicalOperator: logical operator filters: combined conditions (this is a nested structure)	[{ "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	Logical relationship between multiple SQL text keywords. or: or and: and	and
Type	string	Type. basic: basic combined: complex	basic
ReturnFields	array<object>	Return fields.
	array<object>
Aggregator	string	Aggregation operator, such as SUM, AVG, or MAX.	SUM
Alias	string	Field alias.	s_number
Desc	string	Return field description.	主题配置已存在。
Field	object	Cube field details.
Caption	string	Display name in the cube model (can be in Chinese or English).	日期(year)
Column	string	Physical field name.	shid_star
DataType	string	Data type. number: numeric string: string date: date datetime: datetime time: time geographic: geographic boolean: boolean url: URL	datetime
Fid	string	Unique field identifier.	1c1f88cb7d
Granularity	string	Granularity for date and geographic dimensions.	yearRegion
Name	string	Unique cube field name for identifying fields in the response.	sss
Type	string	Type. Dimension: Dimension Measure: Measure	dimension
Orderby	string	Sort order. asc: Ascending desc: Descending no: No sorting	no
CreatorId	string	Creator ID.	7cb94cd48701
CreatorName	string	Creator name.	张仔龙
CubeId	string	Cube ID.	d14e7448-0eb3-40d3-9375-4afef8de29fd
CubeName	string	Dataset name.	测试数据集
Desc	string	Description. " colspan="1" rowspan="1"> 测试用
GmtCreate	string	Creation time.	2023-05-18 14:00:02.0
GmtModified	string	Modification time.	2023-03-21 18:02:36
ModifierId	string	Modifier user ID.	7cb94cd48701
ModifierName	string	Modifier name.	张仔龙
Name	string	Data service name.	测试报表
OwnerId	string	Owner ID	862801339
OwnerName	string	Owner name.	李四
Sid	string	Unique ID of the data service.	dtsuq3i31f5j8v848b
WorkspaceId	string	Workspace ID.	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	Workspace name.	测试工作空间
PageNum	integer	Page number.	1
PageSize	integer	Records per page.	10
TotalNum	integer	Total rows.	1
TotalPages	integer	Total pages.	1
Success	boolean	Whether the request succeeded. Valid values: true: The request succeeded false: The request failed	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Invalid.User.Organization	The user is not in your organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.