對數據服務中已創建的API進行調用。
接口說明
前提條件
您通過 Quick BI 的數據服務，創建數據服務的 API，具體請參見數據服務。
使用限制
- 數據服務功能僅針對專業版客戶開放。
- 數據服務 API 調用，接口超時時間為 60s，單個 API 的 QPS 為 10 次/秒。
- 數據服務 API 所引用數據集，如果開啟了行級權限，API 調用的時候可能會被行級權限策略攔截。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ApiId | string | 是 | 數據服務中的 API ID，請參見：數據服務。 | f4cc43bc3*** |
| Conditions | string | 否 | 數據服務的查詢條件，以 Key 和 Value 的形式傳入。map 類型的字符串。其中，Key 為請求參數的參數名，Value 為請求參數的參數值。Key 和 Value 必須成對出現。 說明：
| { "area": ["華東", "華北"], "shopping_date": "2019Q1", } |
| ReturnFields | string | 否 | 返回參數的參數名列表，List 類型字符串。 | ["area", "city", "price", "date"] |
返回參數
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "78C1AA2D-9201-599E-A0BA-6FC462E57A95",
"Result": {
"Headers": [
{
"Aggregator": "SUM",
"Column": "具體的物理字段名",
"DataType": "string",
"Granularity": "yearRegion",
"Label": "area",
"Type": "StandardDimension"
}
],
"Sql": "SELECT COMPANY_T_1_.`area` AS D_AREA_2_, COMPANY_T_1_.`city` AS D_CITY_3_, SUM(COMPANY_T_1_.`profit_amt`) AS D_PROFIT_4_ FROM `quickbi_test`.`company_sales_record_copy` AS COMPANY_T_1_ WHERE COMPANY_T_1_.`area` LIKE '%華東%' GROUP BY COMPANY_T_1_.`area`, COMPANY_T_1_.`city` HAVING SUM(COMPANY_T_1_.`order_amt`) > 1 LIMIT 0, 10",
"Values": [
[
{
"area": "華東",
"city": "三明市"
},
{
"area": "華東",
"city": "上海市"
}
]
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | API.No.Permission | You are not authorized to call the data service API operation. | 您無權調用此數據服務API。 |
| 400 | API.Not.Exist | The data service API operation does not exist. | 數據服務 API 不存在。 |
| 400 | Cube.Not.Exist | The Cube does not exist. | 數據集不存在。 |
| 400 | Invalid.Parameter.Conditions | The specified Conditions is invalid. %s is not defined. | 參數 Conditions 錯誤：%s 未在模型中定義。 |
| 400 | Invalid.Parameter.ReturnFields | The specified returnFields is invalid. %s is not defined. | 參數ReturnFields錯誤：%s 未在模型中定義。 |
| 400 | Missing.Conditions | The specified Conditions is invalid. You must specify %s. | 輸入參數Conditions 錯誤： %s 是必須項。 |
| 400 | Missing.Dimension.Measure | The dimension or measure %s does not exist in Cube. | Cube 模型中缺少維度或度量 %s 。 |
| 400 | Rowlevel.Permission.Forbbiden | The request is denied by row level permission. The dataset is %s, %s %s. | 請求被行級權限限制，數據集為%s，%s %s。 |
| 400 | Datasource.Sql.ExecuteFailed | Failed to execute the SQL statement in the data source. | 數據源執行SQL失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-04-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-10-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |