調用QueryDataServiceList擷取資料服務列表-智能商務分析 Quick BI-阿里雲

查詢資料服務API列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:QueryDataServiceList

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	資料服務名稱。	測試sql
UserId	string	否	使用者識別碼。	dasdfdsa-csddf-dsadsa
PageNo	integer	否	頁碼。預設取值 1。	1
PageSize	integer	否	分頁查詢時的每頁行數：預設值：10 最大值：1000	10

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	返回結果。
Data	array<object>	資料服務資訊。
	array<object>
Content	object	資料服務的 Model，JSON 格式。
CubeId	string	cube 標識 id。	56f9f34a-bdba-496a-91a3-a18b1ff73a80
CubeName	string	資料集名稱。	測試資料集
Detail	boolean	明細 or 匯總。	true
Filter	object	請求參數資訊。
Filters	array<object>	組合條件。
	object	分級門戶菜單列表詳情的 JSON 字串。取值範圍： Type：類型。 1.basic：基本 2.combined：複雜 field：對應的 cube 欄位 alias：參數名 desc：欄位的備忘描述 aggregator：彙總函式 operator：操作符 essential：是否必傳 defaultValue：系統預設值。如果介面調用不傳入時，以此值替換。 interval：日期的位移量。對於日期有效，相對預設值或者參數值的相對值。 logicalOperator：邏輯操作符 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	string	多個 SQL 文本關鍵詞的邏輯關係。 or：或。 and：與。	and
Type	string	類型。 basic：基本 combined：複雜	basic
ReturnFields	array<object>	返回資訊。
	array<object>
Aggregator	string	彙總操作符。例如 SUM、AVG 和 MAX。	SUM
Alias	string	欄位參數名。	s_number
Desc	string	返回欄位的備忘。	主題配置已存在。
Field	object	對應的 cube 欄位資訊。
Caption	string	cube 模型中的顯示名稱（可能是中文，也可能是英文）。	日期(year)
Column	string	對應的物理欄位名。	shid_star
DataType	string	資料類型。 number：數字 string：字串 date：時間 datetime：時間 time：時間 geographic：地理 boolean：布爾 url：url	datetime
Fid	string	原始欄位唯一標誌 ID。	1c1f88cb7d
Granularity	string	日期維度、地理維度包含此屬性，支援的粒度。	yearRegion
Name	string	cube 欄位的唯一名稱，主要用於返回結果的唯一定位。	sss
Type	string	類型。 Dimension：維度 Measure：度量	dimension
Orderby	string	排序。 asc：升序 desc：降序 no：不排序	no
CreatorId	string	建立人 id	7cb94cd48701
CreatorName	string	建立者姓名	張仔龍
CubeId	string	cube 標識 id	d14e7448-0eb3-40d3-9375-4afef8de29fd
CubeName	string	資料集名稱。	測試資料集
Desc	string	描述	測試用
GmtCreate	string	建立時間。	2023-05-18 14:00:02.0
GmtModified	string	修改時間。	2023-03-21 18:02:36
ModifierId	string	修改者 userId。	7cb94cd48701
ModifierName	string	修改人名	張仔龍
Name	string	資料服務名稱。	測試報表
OwnerId	string	擁有者 id	862801339
OwnerName	string	所有者名字	李四
Sid	string	資料服務的唯一 ID。	dtsuq3i31f5j8v848b
WorkspaceId	string	工作空間 ID。	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	工作空間名稱。	測試工作空間
PageNum	integer	頁碼。	1
PageSize	integer	頁記錄數	10
TotalNum	integer	總行數。	1
TotalPages	integer	總頁數。	1
Success	boolean	是否請求成功。取值範圍： true：請求成功 false：請求失敗	true

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Invalid.User.Organization	The user is not in your organization.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。