データサービスで既に作成された API を呼び出します。
この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに quickbi-public(2022-01-01) - QueryData への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。
操作説明
前提条件
Quick BI のデータサービスを通じてデータサービス API を作成します。詳細については、「データサービス」をご参照ください。
制限事項
データサービス機能は、Professional Edition のお客様のみが利用できます。
データサービス API 呼び出しのタイムアウトは 60 秒で、単一 API の QPS は 10 回/秒です。
データサービス API が参照するデータセットで行レベルの権限が有効になっている場合、API 呼び出しは行レベルの権限ポリシーによってインターセプトされる可能性があります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
quickbi-public:QueryDataService |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ApiId |
string |
必須 |
データサービス内の API ID。詳細については、「データサービス」をご参照ください。 |
f4cc43bc3*** |
| Conditions |
string |
任意 |
データサービスのクエリ条件で、Key-Value ペアとして渡されます。これはマップ型の文字列です。ここで、Key はリクエストパラメーターの名前、Value はリクエストパラメーターの値です。Key と Value はペアで指定する必要があります。 注：
|
{ "area": ["华东", "华北"], "shopping_date": "2019Q1", } |
| ReturnFields |
string |
任意 |
返されるパラメーター名のリストで、リスト型の文字列として指定します。 |
["area", "city", "price", "date"] |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値：
|
true |
| RequestId |
string |
リクエスト ID。 |
78C1AA2D-9201-599E-A0BA-6FC462E57A95 |
| Result |
object |
インターフェイスクエリの結果を返します。 |
|
| Headers |
array<object> |
列ヘッダー。 |
|
|
object |
|||
| Aggregator |
string |
集計オペレーター。SUM、AVG、MAX などのメジャーフィールドにのみ存在します。 |
SUM |
| Column |
string |
フィールド名。物理テーブルのフィールド名に対応します。 |
具体的物理字段名 |
| DataType |
string |
フィールドのデータの型。一般的な型には、数値、文字列、日付、日時、時刻、地理などがあります。 |
string |
| Granularity |
string |
ディメンションフィールドの粒度。 このフィールドは、リクエストされたフィールドが日付または地理ディメンションの場合にのみ返され、次の値が考えられます：
|
yearRegion |
| Label |
string |
フィールドのエイリアスで、values パラメーターのマップデータ行のキーとして機能します。 |
area |
| Type |
string |
フィールドタイプ。ディメンションフィールドとメジャーフィールドを区別するために使用されます。 |
StandardDimension |
| Sql |
string |
クエリリクエストの 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 |
array<object> |
返されるクエリ結果。 |
|
|
object |
返されたデータの行と列。 このパラメーターは List |
[{"area":"华东","city":"三明市"},{"area":"华东","city":"上海市"}] |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | API.No.Permission | You are not authorized to call the data service API operation. | |
| 400 | API.Not.Exist | The data service API operation does not exist. | |
| 400 | Cube.Not.Exist | The Cube does not exist. | |
| 400 | Invalid.Parameter.Conditions | The specified Conditions is invalid. %s is not defined. | |
| 400 | Invalid.Parameter.ReturnFields | The specified returnFields is invalid. %s is not defined. | |
| 400 | Missing.Conditions | The specified Conditions is invalid. You must specify %s. | |
| 400 | Missing.Dimension.Measure | The dimension or measure %s does not exist in Cube. | |
| 400 | Rowlevel.Permission.Forbbiden | The request is denied by row level permission. The dataset is %s, %s %s. | |
| 400 | Datasource.Sql.ExecuteFailed | Failed to execute the SQL statement in the data source. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。